SDK for PHP V3

AWS User Experience Customization 2024-07-01

Client: Aws\Uxc\UxcClient
Service ID: uxc
Version: 2024-07-01

This page describes the parameters and results for the operations of the AWS User Experience Customization (2024-07-01), and shows how to use the Aws\Uxc\UxcClient object to call the described operations. This documentation is specific to the 2024-07-01 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

GetAccountCustomizations ( array $params = [] )
Returns the current account customization settings, including account color, visible services, and visible Regions.
ListServices ( array $params = [] )
Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations.
UpdateAccountCustomizations ( array $params = [] )
Updates one or more account customization settings.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListServices

Operations

GetAccountCustomizations 

$result = $client->getAccountCustomizations([/* ... */]);
$promise = $client->getAccountCustomizationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getAccountCustomizations([
]);

Parameter Details

Members

Result Syntax

[
    'accountColor' => 'none|pink|purple|darkBlue|lightBlue|teal|green|yellow|orange|red',
    'visibleRegions' => ['<string>', ...],
    'visibleServices' => ['<string>', ...],
]

Result Details

Members
accountColor
Type: string

The account color preference. A value of none indicates that you have not set a color.

visibleRegions
Type: Array of strings

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.

visibleServices
Type: Array of strings

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.

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 Amazon Web Services managed policies for Amazon Web Services Management Console.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ThrottlingException:

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

InternalServerException:

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

Examples

Example 1: Get account customizations

Retrieves all account customization settings

$result = $client->getAccountCustomizations([
]);

Result syntax:

[
    'accountColor' => 'green',
    'visibleRegions' => [
        'us-east-1',
        'us-west-2',
    ],
    'visibleServices' => [
        's3',
        'ec2',
    ],
]

ListServices 

$result = $client->listServices([/* ... */]);
$promise = $client->listServicesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listServices([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results to return per page.

nextToken
Type: string

The token for retrieving the next page of results. Use the nextToken value from a previous response.

Result Syntax

[
    'nextToken' => '<string>',
    'services' => ['<string>', ...],
]

Result Details

Members
nextToken
Type: string

The token for retrieving the next page of results. This value is null when no more results are available.

services
Type: Array of strings

The list of available Amazon Web Services service identifiers.

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 Amazon Web Services managed policies for Amazon Web Services Management Console.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ThrottlingException:

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

InternalServerException:

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

Examples

Example 1: List available services

Retrieves a paginated list of available AWS services

$result = $client->listServices([
]);

Result syntax:

[
    'nextToken' => 'eyJhbGciOiJIUzI1NiJ91W342Gdcs259019',
    'services' => [
        's3',
        'ec2',
        'lambda',
    ],
]

UpdateAccountCustomizations 

$result = $client->updateAccountCustomizations([/* ... */]);
$promise = $client->updateAccountCustomizationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->updateAccountCustomizations([
    'accountColor' => 'none|pink|purple|darkBlue|lightBlue|teal|green|yellow|orange|red',
    'visibleRegions' => ['<string>', ...],
    'visibleServices' => ['<string>', ...],
]);

Parameter Details

Members
accountColor
Type: string

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

visibleRegions
Type: Array of strings

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

visibleServices
Type: Array of strings

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

Result Syntax

[
    'accountColor' => 'none|pink|purple|darkBlue|lightBlue|teal|green|yellow|orange|red',
    'visibleRegions' => ['<string>', ...],
    'visibleServices' => ['<string>', ...],
]

Result Details

Members
accountColor
Type: string

The current account color preference after the update.

visibleRegions
Type: Array of strings

The current list of visible Region codes after the update.

visibleServices
Type: Array of strings

The current list of visible service identifiers after the update.

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 Amazon Web Services managed policies for Amazon Web Services Management Console.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

ThrottlingException:

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

InternalServerException:

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

Examples

Example 1: Update account customizations

Updates account customization settings with new values

$result = $client->updateAccountCustomizations([
    'accountColor' => 'green',
    'visibleServices' => [
        's3',
        'ec2',
        'lambda',
    ],
]);

Result syntax:

[
    'accountColor' => 'green',
    'visibleRegions' => [
        'us-east-1',
        'us-west-2',
    ],
    'visibleServices' => [
        's3',
        'ec2',
        'lambda',
    ],
]

Shapes

InternalServerException

Description

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

Members
message
Required: Yes
Type: string

ThrottlingException

Description

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

Members
message
Required: Yes
Type: string

ValidationException

Description

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Members
fieldList
Type: Array of ValidationExceptionField structures

The list of fields that are invalid.

message
Required: Yes
Type: string

ValidationExceptionField

Description

Describes a validation exception for a specific field.

Members
message
Required: Yes
Type: string

A message describing the validation exception.

path
Required: Yes
Type: string

The field name with the validation exception.