Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateAccountSettings

Updates the Amazon Quick Sight settings in your Amazon account.

Request Syntax


PUT /accounts/AwsAccountId/settings HTTP/1.1
Content-type: application/json

{
   "DefaultNamespace": "string",
   "NotificationEmail": "string",
   "TerminationProtectionEnabled": boolean
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the Amazon account that contains the Quick Sight settings that you want to list.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

DefaultNamespace

The default namespace for this Amazon account. Currently, the default is default. IAM users that register for the first time with Amazon Quick Sight provide an email address that becomes associated with the default namespace.

Type: String

Length Constraints: Maximum length of 64.

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

NotificationEmail

The email address that you want Quick Sight to send notifications to regarding your Amazon account or Quick Sight subscription.

Type: String

Required: No

TerminationProtectionEnabled

A boolean value that determines whether or not an Quick Sight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

Type: Boolean

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string"
}

Response Elements

If the action is successful, the service sends back the following HTTP response.

Status: The HTTP status of the request.

The following data is returned in JSON format by the service.

RequestId

The Amazon request ID for this operation.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

RequestId: The Amazon request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 429