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

UpdateAccountCustomizations

Updates one or more account customization settings. You can update account color, visible services, and visible Regions in a single request. Only the settings that you include in the request body are modified. Omitted settings remain unchanged. To reset a setting to its default behavior, set the value to null for visible Regions and visible services, or none for account color. This operation is idempotent.

Note

The visibleServices and visibleRegions settings control only the appearance of services and Regions in the AWS Management Console. They do not restrict access through the AWS CLI, SDKs, or other APIs.

Request Syntax


PATCH /v1/account-customizations HTTP/1.1
Content-type: application/json

{
   "accountColor": "string",
   "visibleRegions": [ "string" ],
   "visibleServices": [ "string" ]
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

accountColor

The account color preference to set. Set to none to reset to the default (no color).

Type: String

Required: No

visibleRegions

The list of AWS Region codes to make visible in the AWS Management Console. Set to null to reset to the default, which makes all Regions visible. For a list of valid Region codes, see AWS Regions.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Pattern: [a-z]{2}(-[a-z]{1,10}){1,2}-[1-9]

Required: No

visibleServices

The list of AWS service identifiers to make visible in the AWS Management Console. Set to null to reset to the default, which makes all services visible. For valid service identifiers, call ListServices.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-z0-9]+(-[a-z0-9]+)*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "accountColor": "string",
   "visibleRegions": [ "string" ],
   "visibleServices": [ "string" ]
}

Response Elements

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

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

accountColor

The current account color preference after the update.

Type: String

visibleRegions

The current list of visible Region codes after the update.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 100 items.

Pattern: [a-z]{2}(-[a-z]{1,10}){1,2}-[1-9]

visibleServices

The current list of visible service identifiers after the update.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 500 items.

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-z0-9]+(-[a-z0-9]+)*

Errors

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

AccessDeniedException

You don't have sufficient access to perform this operation. Verify that your IAM policy includes the required uxc: permissions for the operation that you are calling. For more information on IAM permissions, see AWS managed policies for AWS Management Console.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error. Try your request again later.

HTTP Status Code: 500

ThrottlingException

The request was denied because of request throttling. Reduce the frequency of your requests.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

fieldList: The list of fields that are invalid.

HTTP Status Code: 400

Examples

Update all account customization settings

The following example sets the account color, visible services, and visible Regions in a single request. The response returns the current state of all settings after the update.

Sample Request


PATCH /v1/account-customizations HTTP/1.1
Host: uxc.us-east-1.amazonaws.com
Content-type: application/json

{
   "accountColor": "teal",
   "visibleServices": ["s3", "ec2", "lambda"],
   "visibleRegions": ["us-east-1", "us-west-2"]
}

Sample Response


HTTP/1.1 200 OK
Content-type: application/json

{
   "accountColor": "teal",
   "visibleServices": ["s3", "ec2", "lambda"],
   "visibleRegions": ["us-east-1", "us-west-2"]
}

Reset a setting to its default behavior

The following example resets the account color to its default (no color) by setting the value to none. The visible services and visible Regions settings are omitted from the request, so they remain unchanged.

Sample Request


PATCH /v1/account-customizations HTTP/1.1
Host: uxc.us-east-1.amazonaws.com
Content-type: application/json

{
   "accountColor": "none"
}

Sample Response


HTTP/1.1 200 OK
Content-type: application/json

{
   "accountColor": "none",
   "visibleServices": ["s3", "ec2", "lambda"],
   "visibleRegions": ["us-east-1", "us-west-2"]
}