aws-elixir v1.0.11

View Source AWS.Uxc (aws-elixir v1.0.11)

This is the Amazon Web Services User Experience Customization (UXC) API Reference.

Amazon Web Services User Experience Customization (UXC) is a utility that provides programmatic access to enable account administrators to customize the visual appearance of the Amazon Web Services Management Console and manage these settings at the account level.

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.

For more information about UXC features and console procedures, see Getting started with Amazon Web Services User Experience Customization. For information about required permissions, see Identity and access management for Amazon Web Services Management Console.

Link to this section Summary

Functions

get_account_customizations(client, options \\ [])

Returns the current account customization settings, including account color, visible services, and visible Regions.

list_services(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations.

metadata()
update_account_customizations(client, input, options \\ [])

Updates one or more account customization settings.

Link to this section Functions

Link to this function

get_account_customizations(client, options \\ [])

View Source

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.

Link to this function

list_services(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations.

The available services vary by Amazon Web Services partition. Use pagination to retrieve all results.

The visibleServices setting controls only the appearance of services in the Amazon Web Services Management Console. It does not restrict access through the CLI, SDKs, or other APIs.

Link to this function

metadata()

View Source
Link to this function

update_account_customizations(client, input, options \\ [])

View Source

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.