Interface UxcAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface UxcAsyncClient extends AwsClient
Service client for accessing AWS User Experience Customization asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • getAccountCustomizations

      default CompletableFuture<GetAccountCustomizationsResponse> getAccountCustomizations(GetAccountCustomizationsRequest getAccountCustomizationsRequest)

      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:
      A Java Future containing the result of the GetAccountCustomizations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAccountCustomizations

      default CompletableFuture<GetAccountCustomizationsResponse> getAccountCustomizations(Consumer<GetAccountCustomizationsRequest.Builder> getAccountCustomizationsRequest)

      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:
      A Java Future containing the result of the GetAccountCustomizations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServices

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServices

      default CompletableFuture<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. 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:
      A Java Future containing the result of the ListServices operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator(ListServicesRequest listServicesRequest)

      This is a variant of listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.uxc.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.uxc.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.uxc.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.uxc.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listServicesPaginator

      default ListServicesPublisher listServicesPaginator(Consumer<ListServicesRequest.Builder> listServicesRequest)

      This is a variant of listServices(software.amazon.awssdk.services.uxc.model.ListServicesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.uxc.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.uxc.paginators.ListServicesPublisher publisher = client.listServicesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.uxc.model.ListServicesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.uxc.model.ListServicesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountCustomizations

      default CompletableFuture<UpdateAccountCustomizationsResponse> updateAccountCustomizations(UpdateAccountCustomizationsRequest updateAccountCustomizationsRequest)

      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:
      A Java Future containing the result of the UpdateAccountCustomizations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAccountCustomizations

      default CompletableFuture<UpdateAccountCustomizationsResponse> updateAccountCustomizations(Consumer<UpdateAccountCustomizationsRequest.Builder> updateAccountCustomizationsRequest)

      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:
      A Java Future containing the result of the UpdateAccountCustomizations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • UxcException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • 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

    • create

      static UxcAsyncClient create()
      Create a UxcAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static UxcAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a UxcAsyncClient.