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

UpdateAccountCustomization

Updates Amazon QuickSight customizations for the current AWS Region. Currently, the only customization that you can use is a theme.

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

Request Syntax


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

{
   "AccountCustomization": { 
      "DefaultEmailCustomizationTemplate": "string",
      "DefaultTheme": "string"
   }
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

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

Length Constraints: Fixed length of 12.

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

Required: Yes

Namespace

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

Length Constraints: Maximum length of 64.

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

Request Body

The request accepts the following data in JSON format.

AccountCustomization

The Amazon QuickSight customizations you're updating in the current AWS Region.

Type: AccountCustomization object

Required: Yes

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 you're updating in the current AWS Region.

Type: AccountCustomization object

Arn

The Amazon Resource Name (ARN) for the updated customization for this AWS account.

Type: String

AwsAccountId

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

Type: String

Length Constraints: Fixed length of 12.

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

Namespace

The namespace associated with the customization that you're updating.

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

ConflictException

Updating or deleting a resource can cause an inconsistent state.

HTTP Status Code: 409

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