Interface UxcClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface UxcClient
extends AwsClient

Service client for accessing AWS User Experience Customization. This can be created using the static builder() method.

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.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static UxcClientBuilder	builder()	Create a builder that can be used to configure and create a UxcClient.
static UxcClient	create()	Create a UxcClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetAccountCustomizationsResponse	getAccountCustomizations(Consumer<GetAccountCustomizationsRequest.Builder> getAccountCustomizationsRequest)	Returns the current account customization settings, including account color, visible services, and visible Regions.
default GetAccountCustomizationsResponse	getAccountCustomizations(GetAccountCustomizationsRequest getAccountCustomizationsRequest)	Returns the current account customization settings, including account color, visible services, and visible Regions.
default ListServicesResponse	listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)	Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations.
default ListServicesResponse	listServices(ListServicesRequest listServicesRequest)	Returns a paginated list of Amazon Web Services service identifiers that you can use as values for the visibleServices setting in UpdateAccountCustomizations.
default ListServicesIterable	listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)	This is a variant of listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation.
default ListServicesIterable	listServicesPaginator(ListServicesRequest listServicesRequest)	This is a variant of listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation.
default UxcServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default UpdateAccountCustomizationsResponse	updateAccountCustomizations(Consumer<UpdateAccountCustomizationsRequest.Builder> updateAccountCustomizationsRequest)	Updates one or more account customization settings.
default UpdateAccountCustomizationsResponse	updateAccountCustomizations(UpdateAccountCustomizationsRequest updateAccountCustomizationsRequest)	Updates one or more account customization settings.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

getAccountCustomizations

default GetAccountCustomizationsResponse getAccountCustomizations(GetAccountCustomizationsRequest getAccountCustomizationsRequest)
                                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

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.

Parameters:

getAccountCustomizationsRequest -

Returns:

Result of the GetAccountCustomizations operation returned by the service.

See Also:

• AWS API Documentation

getAccountCustomizations

default GetAccountCustomizationsResponse getAccountCustomizations(Consumer<GetAccountCustomizationsRequest.Builder> getAccountCustomizationsRequest)
                                                           throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

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.

This is a convenience which creates an instance of the GetAccountCustomizationsRequest.Builder avoiding the need to create one manually via GetAccountCustomizationsRequest.builder()

Parameters:

getAccountCustomizationsRequest - A Consumer that will call methods on GetAccountCustomizationsRequest.Builder to create a request.

Returns:

Result of the GetAccountCustomizations operation returned by the service.

See Also:

• AWS API Documentation

listServices

default ListServicesResponse listServices(ListServicesRequest listServicesRequest)
                                   throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

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.

Parameters:

listServicesRequest -

Returns:

Result of the ListServices operation returned by the service.

See Also:

• AWS API Documentation

listServices

default ListServicesResponse listServices(Consumer<ListServicesRequest.Builder> listServicesRequest)
                                   throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

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.

This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to create one manually via ListServicesRequest.builder()

Parameters:

listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.

Returns:

Result of the ListServices operation returned by the service.

See Also:

• AWS API Documentation

listServicesPaginator

default ListServicesIterable listServicesPaginator(ListServicesRequest listServicesRequest)
                                            throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

This is a variant of listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.uxc.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.uxc.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
     for (software.amazon.awssdk.services.uxc.model.ListServicesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.uxc.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation.

Parameters:

listServicesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listServicesPaginator

default ListServicesIterable listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)
                                            throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

This is a variant of listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.uxc.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.uxc.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
     for (software.amazon.awssdk.services.uxc.model.ListServicesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.uxc.paginators.ListServicesIterable responses = client.listServicesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation.

This is a convenience which creates an instance of the ListServicesRequest.Builder avoiding the need to create one manually via ListServicesRequest.builder()

Parameters:

listServicesRequest - A Consumer that will call methods on ListServicesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

updateAccountCustomizations

default UpdateAccountCustomizationsResponse updateAccountCustomizations(UpdateAccountCustomizationsRequest updateAccountCustomizationsRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

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:

updateAccountCustomizationsRequest -

Returns:

Result of the UpdateAccountCustomizations operation returned by the service.

See Also:

• AWS API Documentation

updateAccountCustomizations

default UpdateAccountCustomizationsResponse updateAccountCustomizations(Consumer<UpdateAccountCustomizationsRequest.Builder> updateAccountCustomizationsRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
UxcException

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.

This is a convenience which creates an instance of the UpdateAccountCustomizationsRequest.Builder avoiding the need to create one manually via UpdateAccountCustomizationsRequest.builder()

Parameters:

updateAccountCustomizationsRequest - A Consumer that will call methods on UpdateAccountCustomizationsRequest.Builder to create a request.

Returns:

Result of the UpdateAccountCustomizations operation returned by the service.

See Also:

• AWS API Documentation

create

static UxcClient create()

Create a UxcClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static UxcClientBuilder builder()

Create a builder that can be used to configure and create a UxcClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default UxcServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration