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

CreateAccountCustomization

Creates Amazon Quick Sight customizations. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon Quick Sight by removing Amazon Quick Sight sample assets and videos for all new users, see Customizing Quick Sight in the Amazon Quick Sight User Guide.

You can create customizations for your Amazon account or, if you specify a namespace, for a Quick Sight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon account. To find out which customizations apply, use the DescribeAccountCustomization API operation.

Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.

Request Syntax


POST /accounts/AwsAccountId/customizations?namespace=Namespace HTTP/1.1
Content-type: application/json

{
   "AccountCustomization": { 
      "DefaultEmailCustomizationTemplate": "string",
      "DefaultTheme": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID for the Amazon account that you want to customize Quick Sight for.

Length Constraints: Fixed length of 12.

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

Required: Yes

Namespace

The Quick Sight namespace that you want to add customizations to.

Length Constraints: Maximum length of 64.

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

Request Body

The request accepts the following data in JSON format.

AccountCustomization

The Quick Sight customizations you're adding. You can add these to an Amazon account and a QuickSight namespace.

For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.

Type: AccountCustomization object

Required: Yes

Tags

A list of the tags that you want to attach to this resource.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

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 Quick Sight customizations you're adding.

Type: AccountCustomization object

Arn

The Amazon Resource Name (ARN) for the customization that you created for this Amazon account.

Type: String

AwsAccountId

The ID for the Amazon account that you want to customize Quick Sight for.

Type: String

Length Constraints: Fixed length of 12.

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

Namespace

The namespace associated with the customization you're creating.

Type: String

Length Constraints: Maximum length of 64.

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

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The Amazon request ID for this request.

HTTP Status Code: 409

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

ResourceExistsException

The resource specified already exists.

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

HTTP Status Code: 409

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