com.amazonaws.services.dlm

Class AmazonDLMAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.dlm.AmazonDLMClient

com.amazonaws.services.dlm.AmazonDLMAsyncClient

All Implemented Interfaces:

AmazonDLM, AmazonDLMAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonDLMAsyncClient
extends AmazonDLMClient
implements AmazonDLMAsync

Client for accessing Amazon DLM 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.

Amazon Data Lifecycle Manager

With Amazon Data Lifecycle Manager, you can manage the lifecycle of your Amazon Web Services resources. You create lifecycle policies, which are used to automate operations on the specified resources.

Amazon Data Lifecycle Manager supports Amazon EBS volumes and snapshots. For information about using Amazon Data Lifecycle Manager with Amazon EBS, see Amazon Data Lifecycle Manager in the Amazon EC2 User Guide.

Field Summary

Fields inherited from class com.amazonaws.services.dlm.AmazonDLMClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.dlm.AmazonDLM

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonDLMAsyncClientBuilder	asyncBuilder()
Future<CreateLifecyclePolicyResult>	createLifecyclePolicyAsync(CreateLifecyclePolicyRequest request) Creates an Amazon Data Lifecycle Manager lifecycle policy.
Future<CreateLifecyclePolicyResult>	createLifecyclePolicyAsync(CreateLifecyclePolicyRequest request, AsyncHandler<CreateLifecyclePolicyRequest,CreateLifecyclePolicyResult> asyncHandler) Creates an Amazon Data Lifecycle Manager lifecycle policy.
Future<DeleteLifecyclePolicyResult>	deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request) Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
Future<DeleteLifecyclePolicyResult>	deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request, AsyncHandler<DeleteLifecyclePolicyRequest,DeleteLifecyclePolicyResult> asyncHandler) Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetLifecyclePoliciesResult>	getLifecyclePoliciesAsync(GetLifecyclePoliciesRequest request) Gets summary information about all or the specified data lifecycle policies.
Future<GetLifecyclePoliciesResult>	getLifecyclePoliciesAsync(GetLifecyclePoliciesRequest request, AsyncHandler<GetLifecyclePoliciesRequest,GetLifecyclePoliciesResult> asyncHandler) Gets summary information about all or the specified data lifecycle policies.
Future<GetLifecyclePolicyResult>	getLifecyclePolicyAsync(GetLifecyclePolicyRequest request) Gets detailed information about the specified lifecycle policy.
Future<GetLifecyclePolicyResult>	getLifecyclePolicyAsync(GetLifecyclePolicyRequest request, AsyncHandler<GetLifecyclePolicyRequest,GetLifecyclePolicyResult> asyncHandler) Gets detailed information about the specified lifecycle policy.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request) Lists the tags for the specified resource.
Future<ListTagsForResourceResult>	listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) Lists the tags for the specified resource.
void	shutdown() Shuts down the client, releasing all managed resources.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request) Adds the specified tags to the specified resource.
Future<TagResourceResult>	tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler) Adds the specified tags to the specified resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request) Removes the specified tags from the specified resource.
Future<UntagResourceResult>	untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler) Removes the specified tags from the specified resource.
Future<UpdateLifecyclePolicyResult>	updateLifecyclePolicyAsync(UpdateLifecyclePolicyRequest request) Updates the specified lifecycle policy.
Future<UpdateLifecyclePolicyResult>	updateLifecyclePolicyAsync(UpdateLifecyclePolicyRequest request, AsyncHandler<UpdateLifecyclePolicyRequest,UpdateLifecyclePolicyResult> asyncHandler) Updates the specified lifecycle policy.

Methods inherited from class com.amazonaws.services.dlm.AmazonDLMClient

builder, createLifecyclePolicy, deleteLifecyclePolicy, getCachedResponseMetadata, getLifecyclePolicies, getLifecyclePolicy, listTagsForResource, tagResource, untagResource, updateLifecyclePolicy

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.dlm.AmazonDLM

createLifecyclePolicy, deleteLifecyclePolicy, getCachedResponseMetadata, getLifecyclePolicies, getLifecyclePolicy, listTagsForResource, tagResource, untagResource, updateLifecyclePolicy

Method Detail

asyncBuilder

public static AmazonDLMAsyncClientBuilder 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.

createLifecyclePolicyAsync

public Future<CreateLifecyclePolicyResult> createLifecyclePolicyAsync(CreateLifecyclePolicyRequest request)

Description copied from interface: AmazonDLMAsync

Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:

• Custom EBS snapshot policy

• Custom EBS-backed AMI policy

• Cross-account copy event policy

• Default policy for EBS snapshots

• Default policy for EBS-backed AMIs

For more information, see Default policies vs custom policies.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

Specified by:

createLifecyclePolicyAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

createLifecyclePolicyAsync

public Future<CreateLifecyclePolicyResult> createLifecyclePolicyAsync(CreateLifecyclePolicyRequest request,
                                                                      AsyncHandler<CreateLifecyclePolicyRequest,CreateLifecyclePolicyResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Creates an Amazon Data Lifecycle Manager lifecycle policy. Amazon Data Lifecycle Manager supports the following policy types:

• Custom EBS snapshot policy

• Custom EBS-backed AMI policy

• Cross-account copy event policy

• Default policy for EBS snapshots

• Default policy for EBS-backed AMIs

For more information, see Default policies vs custom policies.

If you create a default policy, you can specify the request parameters either in the request body, or in the PolicyDetails request structure, but not both.

Specified by:

createLifecyclePolicyAsync in interface AmazonDLMAsync

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 CreateLifecyclePolicy operation returned by the service.

See Also:

AWS API Documentation

deleteLifecyclePolicyAsync

public Future<DeleteLifecyclePolicyResult> deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request)

Description copied from interface: AmazonDLMAsync

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

For more information about deleting a policy, see Delete lifecycle policies.

Specified by:

deleteLifecyclePolicyAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

deleteLifecyclePolicyAsync

public Future<DeleteLifecyclePolicyResult> deleteLifecyclePolicyAsync(DeleteLifecyclePolicyRequest request,
                                                                      AsyncHandler<DeleteLifecyclePolicyRequest,DeleteLifecyclePolicyResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Deletes the specified lifecycle policy and halts the automated operations that the policy specified.

For more information about deleting a policy, see Delete lifecycle policies.

Specified by:

deleteLifecyclePolicyAsync in interface AmazonDLMAsync

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 DeleteLifecyclePolicy operation returned by the service.

See Also:

AWS API Documentation

getLifecyclePoliciesAsync

public Future<GetLifecyclePoliciesResult> getLifecyclePoliciesAsync(GetLifecyclePoliciesRequest request)

Description copied from interface: AmazonDLMAsync

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Specified by:

getLifecyclePoliciesAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

getLifecyclePoliciesAsync

public Future<GetLifecyclePoliciesResult> getLifecyclePoliciesAsync(GetLifecyclePoliciesRequest request,
                                                                    AsyncHandler<GetLifecyclePoliciesRequest,GetLifecyclePoliciesResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Gets summary information about all or the specified data lifecycle policies.

To get complete information about a policy, use GetLifecyclePolicy.

Specified by:

getLifecyclePoliciesAsync in interface AmazonDLMAsync

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 GetLifecyclePolicies operation returned by the service.

See Also:

AWS API Documentation

getLifecyclePolicyAsync

public Future<GetLifecyclePolicyResult> getLifecyclePolicyAsync(GetLifecyclePolicyRequest request)

Description copied from interface: AmazonDLMAsync

Gets detailed information about the specified lifecycle policy.

Specified by:

getLifecyclePolicyAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

getLifecyclePolicyAsync

public Future<GetLifecyclePolicyResult> getLifecyclePolicyAsync(GetLifecyclePolicyRequest request,
                                                                AsyncHandler<GetLifecyclePolicyRequest,GetLifecyclePolicyResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Gets detailed information about the specified lifecycle policy.

Specified by:

getLifecyclePolicyAsync in interface AmazonDLMAsync

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 GetLifecyclePolicy operation returned by the service.

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)

Description copied from interface: AmazonDLMAsync

Lists the tags for the specified resource.

Specified by:

listTagsForResourceAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

listTagsForResourceAsync

public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request,
                                                                  AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Lists the tags for the specified resource.

Specified by:

listTagsForResourceAsync in interface AmazonDLMAsync

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 ListTagsForResource operation returned by the service.

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)

Description copied from interface: AmazonDLMAsync

Adds the specified tags to the specified resource.

Specified by:

tagResourceAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

tagResourceAsync

public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request,
                                                  AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Adds the specified tags to the specified resource.

Specified by:

tagResourceAsync in interface AmazonDLMAsync

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 TagResource operation returned by the service.

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)

Description copied from interface: AmazonDLMAsync

Removes the specified tags from the specified resource.

Specified by:

untagResourceAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

untagResourceAsync

public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request,
                                                      AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Removes the specified tags from the specified resource.

Specified by:

untagResourceAsync in interface AmazonDLMAsync

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 UntagResource operation returned by the service.

See Also:

AWS API Documentation

updateLifecyclePolicyAsync

public Future<UpdateLifecyclePolicyResult> updateLifecyclePolicyAsync(UpdateLifecyclePolicyRequest request)

Description copied from interface: AmazonDLMAsync

Updates the specified lifecycle policy.

For more information about updating a policy, see Modify lifecycle policies.

Specified by:

updateLifecyclePolicyAsync in interface AmazonDLMAsync

Returns:

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

See Also:

AWS API Documentation

updateLifecyclePolicyAsync

public Future<UpdateLifecyclePolicyResult> updateLifecyclePolicyAsync(UpdateLifecyclePolicyRequest request,
                                                                      AsyncHandler<UpdateLifecyclePolicyRequest,UpdateLifecyclePolicyResult> asyncHandler)

Description copied from interface: AmazonDLMAsync

Updates the specified lifecycle policy.

For more information about updating a policy, see Modify lifecycle policies.

Specified by:

updateLifecyclePolicyAsync in interface AmazonDLMAsync

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 UpdateLifecyclePolicy 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 AmazonDLM

Overrides:

shutdown in class AmazonDLMClient