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

DescribeAccountCustomization

Describes the customizations associated with the provided AWS account and Amazon Amazon QuickSight namespace in an AWS Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.

To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.

AWS account - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to Amazon QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported AWS Region.
AWS Region - In each AWS Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any AWS Region, unless they are constrained to a namespace.

To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
- Use command line options.
- Use named profiles.
- Run aws configure to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region.
Applied customizations - Within an AWS Region, a set of Amazon QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the CreateAccountCustomization command in each AWS Region where you want to apply the same customizations.

Request Syntax


GET /accounts/AwsAccountId/customizations?namespace=Namespace&resolved=Resolved HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the AWS account that you want to describe Amazon QuickSight customizations for.

Length Constraints: Fixed length of 12.

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

Required: Yes

Namespace

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.

Length Constraints: Maximum length of 64.

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

Resolved

The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "AccountCustomization": { 
      "DefaultEmailCustomizationTemplate": "string",
      "DefaultTheme": "string"
   },
   "Arn": "string",
   "AwsAccountId": "string",
   "Namespace": "string",
   "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.

AccountCustomization

The Amazon QuickSight customizations that exist in the current AWS Region.

Type: AccountCustomization object

Arn

The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.

Type: String

AwsAccountId

The ID for the AWS account that you're describing.

Type: String

Length Constraints: Fixed length of 12.

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

Namespace

The Amazon QuickSight namespace that you're describing.

Type: String

Length Constraints: Maximum length of 64.

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

RequestId

The AWS 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 QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.

HTTP Status Code: 401

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

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

HTTP Status Code: 400

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

Access is throttled.

HTTP Status Code: 429