account_customizations

Creates, updates, deletes, gets or lists an account_customizations resource.

Overview

Name	account_customizations
Type	Resource
Id	aws.uxc.account_customizations

Fields

The following fields are returned by SELECT queries:

get_account_customizations

Name	Datatype	Description
account_color	string	The account color preference. A value of none indicates that you have not set a color. (none, pink, purple, darkBlue, lightBlue, teal, green, yellow, orange, red)
visible_regions	array	The list of Amazon Web Services Region codes that are visible to the account in the Amazon Web Services Management Console. A value of null indicates that you have not configured this feature and all Regions are visible. For a list of valid Region codes, see Amazon Web Services Regions.
visible_services	array	The list of Amazon Web Services service identifiers that are visible to the account in the Amazon Web Services Management Console. A value of null indicates that you have not configured this feature and all services are visible. For valid service identifiers, call ListServices.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_account_customizations	select	region		Returns the current account customization settings, including account color, visible services, and visible Regions. Settings that you have not configured return their default values: visible Regions and visible services return null, and account color returns none. The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.
update_account_customizations	update	region		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. The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_account_customizations

Returns the current account customization settings, including account color, visible services, and visible Regions. Settings that you have not configured return their default values: visible Regions and visible services return null, and account color returns none. The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.

SELECT
account_color,
visible_regions,
visible_services
FROM aws.uxc.account_customizations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_account_customizations

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. The visibleServices and visibleRegions settings control only the appearance of services and Regions in the Amazon Web Services Management Console. They do not restrict access through the CLI, SDKs, or other APIs.

UPDATE aws.uxc.account_customizations
SET 
accountColor = '{{ accountColor }}',
visibleServices = '{{ visibleServices }}',
visibleRegions = '{{ visibleRegions }}'
WHERE 
region = '{{ region }}' --required
RETURNING
account_color,
visible_regions,
visible_services;