Interface ControlCatalogAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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 Amazon Web Services 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 Amazon Web Services Control Catalog.
Use the following links to get started with the Amazon Web Services 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 Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aControlCatalogAsyncClient
.static ControlCatalogAsyncClient
create()
Create aControlCatalogAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.listCommonControls
(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest) Returns a paginated list of common controls from the Amazon Web Services Control Catalog.listCommonControls
(ListCommonControlsRequest listCommonControlsRequest) Returns a paginated list of common controls from the Amazon Web Services Control Catalog.default ListCommonControlsPublisher
listCommonControlsPaginator
(Consumer<ListCommonControlsRequest.Builder> listCommonControlsRequest) This is a variant oflistCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest)
operation.default ListCommonControlsPublisher
listCommonControlsPaginator
(ListCommonControlsRequest listCommonControlsRequest) This is a variant oflistCommonControls(software.amazon.awssdk.services.controlcatalog.model.ListCommonControlsRequest)
operation.default CompletableFuture
<ListDomainsResponse> listDomains
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) Returns a paginated list of domains from the Amazon Web Services Control Catalog.default CompletableFuture
<ListDomainsResponse> listDomains
(ListDomainsRequest listDomainsRequest) Returns a paginated list of domains from the Amazon Web Services Control Catalog.default ListDomainsPublisher
listDomainsPaginator
(Consumer<ListDomainsRequest.Builder> listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest)
operation.default ListDomainsPublisher
listDomainsPaginator
(ListDomainsRequest listDomainsRequest) This is a variant oflistDomains(software.amazon.awssdk.services.controlcatalog.model.ListDomainsRequest)
operation.default CompletableFuture
<ListObjectivesResponse> listObjectives
(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest) Returns a paginated list of objectives from the Amazon Web Services Control Catalog.default CompletableFuture
<ListObjectivesResponse> listObjectives
(ListObjectivesRequest listObjectivesRequest) Returns a paginated list of objectives from the Amazon Web Services Control Catalog.default ListObjectivesPublisher
listObjectivesPaginator
(Consumer<ListObjectivesRequest.Builder> listObjectivesRequest) This is a variant oflistObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest)
operation.default ListObjectivesPublisher
listObjectivesPaginator
(ListObjectivesRequest listObjectivesRequest) This is a variant oflistObjectives(software.amazon.awssdk.services.controlcatalog.model.ListObjectivesRequest)
operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
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 invokeThrowable.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 viaListCommonControlsRequest.builder()
- Parameters:
listCommonControlsRequest
- AConsumer
that will call methods onListCommonControlsRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsPublisher publisher = client.listCommonControlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.controlcatalog.paginators.ListCommonControlsPublisher publisher = client.listCommonControlsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListCommonControlsRequest.builder()
- Parameters:
listCommonControlsRequest
- AConsumer
that will call methods onListCommonControlsRequest.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 invokeThrowable.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
Returns a paginated list of domains from the Amazon Web Services 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 invokeThrowable.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 Amazon Web Services Control Catalog.
This is a convenience which creates an instance of the
ListDomainsRequest.Builder
avoiding the need to create one manually viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.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 invokeThrowable.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
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 newSubscription
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 methodsoftware.amazon.awssdk.services.controlcatalog.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.controlcatalog.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListDomainsRequest.builder()
- Parameters:
listDomainsRequest
- AConsumer
that will call methods onListDomainsRequest.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 invokeThrowable.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 Amazon Web Services 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 invokeThrowable.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 Amazon Web Services 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 viaListObjectivesRequest.builder()
- Parameters:
listObjectivesRequest
- AConsumer
that will call methods onListObjectivesRequest.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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesPublisher publisher = client.listObjectivesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 invokeThrowable.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 newSubscription
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 methodsoftware.amazon.awssdk.services.controlcatalog.paginators.ListObjectivesPublisher publisher = client.listObjectivesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListObjectivesRequest.builder()
- Parameters:
listObjectivesRequest
- AConsumer
that will call methods onListObjectivesRequest.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 invokeThrowable.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
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aControlCatalogAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aControlCatalogAsyncClient
.
-