com.amazonaws.services.dlm

Interface AmazonDLM

All Known Subinterfaces:

AmazonDLMAsync

All Known Implementing Classes:

AbstractAmazonDLM, AbstractAmazonDLMAsync, AmazonDLMAsyncClient, AmazonDLMClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDLM

Interface for accessing Amazon DLM.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonDLM instead.

Amazon Data Lifecycle Manager

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateLifecyclePolicyResult	createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest) Creates a policy to manage the lifecycle of the specified AWS resources.
DeleteLifecyclePolicyResult	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) 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 getLifecyclePoliciesRequest) Gets summary information about all or the specified data lifecycle policies.
GetLifecyclePolicyResult	getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) Gets detailed information about the specified lifecycle policy.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 tagResourceRequest) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
UpdateLifecyclePolicyResult	updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest) Updates the specified lifecycle policy.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createLifecyclePolicy

CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)

Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle policies.

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

DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)

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

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

GetLifecyclePoliciesResult getLifecyclePolicies(GetLifecyclePoliciesRequest getLifecyclePoliciesRequest)

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

To get complete information about a policy, use GetLifecyclePolicy.

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

GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)

Gets detailed information about the specified lifecycle policy.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

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

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tags to the specified resource.

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the specified resource.

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

UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)

Updates the specified lifecycle policy.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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