Interface ControlCatalogAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ControlCatalogAsyncClient extends AwsClient
Service client for accessing AWS Control Catalog 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.

Welcome to the Control Catalog API reference. This guide is for developers who need detailed information about how to programmatically identify and filter the common controls and related metadata that are available to Amazon Web Services customers. This API reference provides descriptions, syntax, and usage examples for each of the actions and data types that are supported by Control Catalog.

Use the following links to get started with the Control Catalog API:

  • Actions: An alphabetical list of all Control Catalog API operations.

  • Data types: An alphabetical list of all Control Catalog data types.

  • Common parameters: Parameters that all operations can use.

  • Common errors: Client and server errors that all operations can return.

  • Field Details

  • Method Details

    • getControl

      default CompletableFuture<GetControlResponse> getControl(GetControlRequest getControlRequest)

      Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

      In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.

      Parameters:
      getControlRequest -
      Returns:
      A Java Future containing the result of the GetControl 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.
      • ResourceNotFoundException The requested resource does not exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getControl

      default CompletableFuture<GetControlResponse> getControl(Consumer<GetControlRequest.Builder> getControlRequest)

      Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported. Input a value for the ControlArn parameter, in ARN form. GetControl accepts controltower or controlcatalog control ARNs as input. Returns a controlcatalog ARN format.

      In the API response, controls that have the value GLOBAL in the Scope field do not show the DeployableRegions field, because it does not apply. Controls that have the value REGIONAL in the Scope field return a value for the DeployableRegions field, as shown in the example.


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

      Parameters:
      getControlRequest - A Consumer that will call methods on GetControlRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetControl 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.
      • ResourceNotFoundException The requested resource does not exist.
      • AccessDeniedException You do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommonControls

      default CompletableFuture<ListCommonControlsResponse> listCommonControls(ListCommonControlsRequest listCommonControlsRequest)

      Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

      You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.

      Parameters:
      listCommonControlsRequest -
      Returns:
      A Java Future containing the result of the ListCommonControls 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommonControls

      default CompletableFuture<ListCommonControlsResponse> listCommonControls(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest)

      Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

      You can apply an optional filter to see common controls that have a specific objective. If you don’t provide a filter, the operation returns all common controls.


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

      Parameters:
      listCommonControlsRequest - A Consumer that will call methods on ListCommonControlsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListCommonControls 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommonControlsPaginator

      default ListCommonControlsPublisher listCommonControlsPaginator(ListCommonControlsRequest listCommonControlsRequest)

      This is a variant of listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) 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.controlcatalog.paginators.ListCommonControlsPublisher publisher = client.listCommonControlsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsPublisher publisher = client.listCommonControlsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsResponse 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 listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) operation.

      Parameters:
      listCommonControlsRequest -
      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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listCommonControlsPaginator

      default ListCommonControlsPublisher listCommonControlsPaginator(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest)

      This is a variant of listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) 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.controlcatalog.paginators.ListCommonControlsPublisher publisher = client.listCommonControlsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsPublisher publisher = client.listCommonControlsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsResponse 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 listCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest) operation.


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

      Parameters:
      listCommonControlsRequest - A Consumer that will call methods on ListCommonControlsRequest.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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControlMappings

      default CompletableFuture<ListControlMappingsResponse> listControlMappings(ListControlMappingsRequest listControlMappingsRequest)

      Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.

      Parameters:
      listControlMappingsRequest -
      Returns:
      A Java Future containing the result of the ListControlMappings 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControlMappings

      default CompletableFuture<ListControlMappingsResponse> listControlMappings(Consumer<ListControlMappingsRequest.Builder> listControlMappingsRequest)

      Returns a paginated list of control mappings from the Control Catalog. Control mappings show relationships between controls and other entities, such as common controls or compliance frameworks.


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

      Parameters:
      listControlMappingsRequest - A Consumer that will call methods on ListControlMappingsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListControlMappings 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControlMappingsPaginator

      default ListControlMappingsPublisher listControlMappingsPaginator(ListControlMappingsRequest listControlMappingsRequest)

      This is a variant of listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) 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.controlcatalog.paginators.ListControlMappingsPublisher publisher = client.listControlMappingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlMappingsPublisher publisher = client.listControlMappingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsResponse 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 listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) operation.

      Parameters:
      listControlMappingsRequest -
      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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControlMappingsPaginator

      default ListControlMappingsPublisher listControlMappingsPaginator(Consumer<ListControlMappingsRequest.Builder> listControlMappingsRequest)

      This is a variant of listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) 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.controlcatalog.paginators.ListControlMappingsPublisher publisher = client.listControlMappingsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlMappingsPublisher publisher = client.listControlMappingsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsResponse 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 listControlMappings(software.amazon.awssdk.services.controlcatalog.model.ListControlMappingsRequest) operation.


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

      Parameters:
      listControlMappingsRequest - A Consumer that will call methods on ListControlMappingsRequest.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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControls

      default CompletableFuture<ListControlsResponse> listControls(ListControlsRequest listControlsRequest)

      Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.

      Parameters:
      listControlsRequest -
      Returns:
      A Java Future containing the result of the ListControls 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControls

      default CompletableFuture<ListControlsResponse> listControls(Consumer<ListControlsRequest.Builder> listControlsRequest)

      Returns a paginated list of all available controls in the Control Catalog library. Allows you to discover available controls. The list of controls is given as structures of type controlSummary. The ARN is returned in the global controlcatalog format, as shown in the examples.


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

      Parameters:
      listControlsRequest - A Consumer that will call methods on ListControlsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListControls 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControlsPaginator

      default ListControlsPublisher listControlsPaginator(ListControlsRequest listControlsRequest)

      This is a variant of listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) 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.controlcatalog.paginators.ListControlsPublisher publisher = client.listControlsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlsPublisher publisher = client.listControlsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListControlsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListControlsResponse 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 listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) operation.

      Parameters:
      listControlsRequest -
      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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listControlsPaginator

      default ListControlsPublisher listControlsPaginator(Consumer<ListControlsRequest.Builder> listControlsRequest)

      This is a variant of listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) 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.controlcatalog.paginators.ListControlsPublisher publisher = client.listControlsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListControlsPublisher publisher = client.listControlsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListControlsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListControlsResponse 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 listControls(software.amazon.awssdk.services.controlcatalog.model.ListControlsRequest) operation.


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

      Parameters:
      listControlsRequest - A Consumer that will call methods on ListControlsRequest.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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(ListDomainsRequest listDomainsRequest)

      Returns a paginated list of domains from the Control Catalog.

      Parameters:
      listDomainsRequest -
      Returns:
      A Java Future containing the result of the ListDomains 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomains

      default CompletableFuture<ListDomainsResponse> listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      Returns a paginated list of domains from the Control Catalog.


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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDomains 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest)

      This is a variant of listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) 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.controlcatalog.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListDomainsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListDomainsResponse 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 listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) operation.

      Parameters:
      listDomainsRequest -
      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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDomainsPaginator

      default ListDomainsPublisher listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)

      This is a variant of listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) 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.controlcatalog.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListDomainsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListDomainsResponse 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 listDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest) operation.


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

      Parameters:
      listDomainsRequest - A Consumer that will call methods on ListDomainsRequest.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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectives

      default CompletableFuture<ListObjectivesResponse> listObjectives(ListObjectivesRequest listObjectivesRequest)

      Returns a paginated list of objectives from the Control Catalog.

      You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.

      Parameters:
      listObjectivesRequest -
      Returns:
      A Java Future containing the result of the ListObjectives 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectives

      default CompletableFuture<ListObjectivesResponse> listObjectives(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest)

      Returns a paginated list of objectives from the Control Catalog.

      You can apply an optional filter to see the objectives that belong to a specific domain. If you don’t provide a filter, the operation returns all objectives.


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

      Parameters:
      listObjectivesRequest - A Consumer that will call methods on ListObjectivesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListObjectives 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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectivesPaginator

      default ListObjectivesPublisher listObjectivesPaginator(ListObjectivesRequest listObjectivesRequest)

      This is a variant of listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) 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.controlcatalog.paginators.ListObjectivesPublisher publisher = client.listObjectivesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesPublisher publisher = client.listObjectivesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListObjectivesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesResponse 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 listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) operation.

      Parameters:
      listObjectivesRequest -
      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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listObjectivesPaginator

      default ListObjectivesPublisher listObjectivesPaginator(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest)

      This is a variant of listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) 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.controlcatalog.paginators.ListObjectivesPublisher publisher = client.listObjectivesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesPublisher publisher = client.listObjectivesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.controlcatalog.model.ListObjectivesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesResponse 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 listObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest) operation.


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

      Parameters:
      listObjectivesRequest - A Consumer that will call methods on ListObjectivesRequest.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 do not have sufficient access to perform this action.
      • InternalServerException An internal service error occurred during the processing of your request. Try again later.
      • ValidationException The request has invalid or missing parameters.
      • ThrottlingException The request was denied due to request throttling.
      • 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.
      • ControlCatalogException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default ControlCatalogServiceClientConfiguration 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 ControlCatalogAsyncClient create()
      Create a ControlCatalogAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ControlCatalogAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ControlCatalogAsyncClient.