com.amazonaws.services.controlcatalog

Class AWSControlCatalogAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.controlcatalog.AWSControlCatalogClient

com.amazonaws.services.controlcatalog.AWSControlCatalogAsyncClient

All Implemented Interfaces:

AWSControlCatalog, AWSControlCatalogAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSControlCatalogAsyncClient
extends AWSControlCatalogClient
implements AWSControlCatalogAsync

Client for accessing AWS Control Catalog asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.controlcatalog.AWSControlCatalog

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSControlCatalogAsyncClientBuilder	asyncBuilder()
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ListCommonControlsResult>	listCommonControlsAsync(ListCommonControlsRequest request) Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
Future<ListCommonControlsResult>	listCommonControlsAsync(ListCommonControlsRequest request, AsyncHandler<ListCommonControlsRequest,ListCommonControlsResult> asyncHandler) Returns a paginated list of common controls from the Amazon Web Services Control Catalog.
Future<ListDomainsResult>	listDomainsAsync(ListDomainsRequest request) Returns a paginated list of domains from the Amazon Web Services Control Catalog.
Future<ListDomainsResult>	listDomainsAsync(ListDomainsRequest request, AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler) Returns a paginated list of domains from the Amazon Web Services Control Catalog.
Future<ListObjectivesResult>	listObjectivesAsync(ListObjectivesRequest request) Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
Future<ListObjectivesResult>	listObjectivesAsync(ListObjectivesRequest request, AsyncHandler<ListObjectivesRequest,ListObjectivesResult> asyncHandler) Returns a paginated list of objectives from the Amazon Web Services Control Catalog.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.controlcatalog.AWSControlCatalogClient

builder, getCachedResponseMetadata, listCommonControls, listDomains, listObjectives

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.controlcatalog.AWSControlCatalog

getCachedResponseMetadata, listCommonControls, listDomains, listObjectives

Method Detail

asyncBuilder

public static AWSControlCatalogAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

listCommonControlsAsync

public Future<ListCommonControlsResult> listCommonControlsAsync(ListCommonControlsRequest request)

Description copied from interface: AWSControlCatalogAsync

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.

Specified by:

listCommonControlsAsync in interface AWSControlCatalogAsync

Returns:

A Java Future containing the result of the ListCommonControls operation returned by the service.

See Also:

AWS API Documentation

listCommonControlsAsync

public Future<ListCommonControlsResult> listCommonControlsAsync(ListCommonControlsRequest request,
                                                                AsyncHandler<ListCommonControlsRequest,ListCommonControlsResult> asyncHandler)

Description copied from interface: AWSControlCatalogAsync

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.

Specified by:

listCommonControlsAsync in interface AWSControlCatalogAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListCommonControls operation returned by the service.

See Also:

AWS API Documentation

listDomainsAsync

public Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request)

Description copied from interface: AWSControlCatalogAsync

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

Specified by:

listDomainsAsync in interface AWSControlCatalogAsync

Returns:

A Java Future containing the result of the ListDomains operation returned by the service.

See Also:

AWS API Documentation

listDomainsAsync

public Future<ListDomainsResult> listDomainsAsync(ListDomainsRequest request,
                                                  AsyncHandler<ListDomainsRequest,ListDomainsResult> asyncHandler)

Description copied from interface: AWSControlCatalogAsync

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

Specified by:

listDomainsAsync in interface AWSControlCatalogAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListDomains operation returned by the service.

See Also:

AWS API Documentation

listObjectivesAsync

public Future<ListObjectivesResult> listObjectivesAsync(ListObjectivesRequest request)

Description copied from interface: AWSControlCatalogAsync

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.

Specified by:

listObjectivesAsync in interface AWSControlCatalogAsync

Returns:

A Java Future containing the result of the ListObjectives operation returned by the service.

See Also:

AWS API Documentation

listObjectivesAsync

public Future<ListObjectivesResult> listObjectivesAsync(ListObjectivesRequest request,
                                                        AsyncHandler<ListObjectivesRequest,ListObjectivesResult> asyncHandler)

Description copied from interface: AWSControlCatalogAsync

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.

Specified by:

listObjectivesAsync in interface AWSControlCatalogAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ListObjectives operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSControlCatalog

Overrides:

shutdown in class AWSControlCatalogClient