com.amazonaws.services.dlm

Class AmazonDLMClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.dlm.AmazonDLMClient

All Implemented Interfaces:

AmazonDLM

Direct Known Subclasses:

AmazonDLMAsyncClient

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

Client for accessing Amazon DLM. All service calls made using this client are blocking, and will not return until the service call 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.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

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

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonDLMClientBuilder	builder()
CreateLifecyclePolicyResult	createLifecyclePolicy(CreateLifecyclePolicyRequest request) Creates an Amazon Data Lifecycle Manager lifecycle policy.
DeleteLifecyclePolicyResult	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request) Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetLifecyclePoliciesResult	getLifecyclePolicies(GetLifecyclePoliciesRequest request) Gets summary information about all or the specified data lifecycle policies.
GetLifecyclePolicyResult	getLifecyclePolicy(GetLifecyclePolicyRequest request) Gets detailed information about the specified lifecycle policy.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags for the specified resource.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes the specified tags from the specified resource.
UpdateLifecyclePolicyResult	updateLifecyclePolicy(UpdateLifecyclePolicyRequest request) Updates the specified lifecycle policy.

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

Method Detail

builder

public static AmazonDLMClientBuilder builder()

createLifecyclePolicy

public CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest request)

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:

createLifecyclePolicy in interface AmazonDLM

Parameters:

createLifecyclePolicyRequest -

Returns:

Result of the CreateLifecyclePolicy operation returned by the service.

Throws:

InvalidRequestException - Bad request. The request is missing required parameters or has invalid parameters.

LimitExceededException - The request failed because a limit was exceeded.

InternalServerException - The service failed in an unexpected way.

See Also:

AWS API Documentation

deleteLifecyclePolicy

public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request)

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:

deleteLifecyclePolicy in interface AmazonDLM

Parameters:

deleteLifecyclePolicyRequest -

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

Throws:

ResourceNotFoundException - A requested resource was not found.

InternalServerException - The service failed in an unexpected way.

LimitExceededException - The request failed because a limit was exceeded.

See Also:

AWS API Documentation

getLifecyclePolicies

public GetLifecyclePoliciesResult getLifecyclePolicies(GetLifecyclePoliciesRequest request)

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

To get complete information about a policy, use GetLifecyclePolicy.

Specified by:

getLifecyclePolicies in interface AmazonDLM

Parameters:

getLifecyclePoliciesRequest -

Returns:

Result of the GetLifecyclePolicies operation returned by the service.

Throws:

ResourceNotFoundException - A requested resource was not found.

InvalidRequestException - Bad request. The request is missing required parameters or has invalid parameters.

InternalServerException - The service failed in an unexpected way.

LimitExceededException - The request failed because a limit was exceeded.

See Also:

AWS API Documentation

getLifecyclePolicy

public GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest request)

Gets detailed information about the specified lifecycle policy.

Specified by:

getLifecyclePolicy in interface AmazonDLM

Parameters:

getLifecyclePolicyRequest -

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

Throws:

ResourceNotFoundException - A requested resource was not found.

InternalServerException - The service failed in an unexpected way.

LimitExceededException - The request failed because a limit was exceeded.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags for the specified resource.

Specified by:

listTagsForResource in interface AmazonDLM

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

InternalServerException - The service failed in an unexpected way.

InvalidRequestException - Bad request. The request is missing required parameters or has invalid parameters.

ResourceNotFoundException - A requested resource was not found.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds the specified tags to the specified resource.

Specified by:

tagResource in interface AmazonDLM

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

InternalServerException - The service failed in an unexpected way.

InvalidRequestException - Bad request. The request is missing required parameters or has invalid parameters.

ResourceNotFoundException - A requested resource was not found.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes the specified tags from the specified resource.

Specified by:

untagResource in interface AmazonDLM

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

InternalServerException - The service failed in an unexpected way.

InvalidRequestException - Bad request. The request is missing required parameters or has invalid parameters.

ResourceNotFoundException - A requested resource was not found.

See Also:

AWS API Documentation

updateLifecyclePolicy

public UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest request)

Updates the specified lifecycle policy.

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

Specified by:

updateLifecyclePolicy in interface AmazonDLM

Parameters:

updateLifecyclePolicyRequest -

Returns:

Result of the UpdateLifecyclePolicy operation returned by the service.

Throws:

ResourceNotFoundException - A requested resource was not found.

InvalidRequestException - Bad request. The request is missing required parameters or has invalid parameters.

InternalServerException - The service failed in an unexpected way.

LimitExceededException - The request failed because a limit was exceeded.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonDLM

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonDLM

Overrides:

shutdown in class AmazonWebServiceClient