Package software.amazon.awssdk.services.dlm

Interface DlmClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface DlmClient
extends AwsClient

Service client for accessing Amazon DLM. This can be created using the static builder() method. 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

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static DlmClientBuilder	builder()	Create a builder that can be used to configure and create a DlmClient.
static DlmClient	create()	Create a DlmClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateLifecyclePolicyResponse	createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)	Creates an Amazon Data Lifecycle Manager lifecycle policy.
default CreateLifecyclePolicyResponse	createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)	Creates an Amazon Data Lifecycle Manager lifecycle policy.
default DeleteLifecyclePolicyResponse	deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)	Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
default DeleteLifecyclePolicyResponse	deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)	Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
default GetLifecyclePoliciesResponse	getLifecyclePolicies()	Gets summary information about all or the specified data lifecycle policies.
default GetLifecyclePoliciesResponse	getLifecyclePolicies(Consumer<GetLifecyclePoliciesRequest.Builder> getLifecyclePoliciesRequest)	Gets summary information about all or the specified data lifecycle policies.
default GetLifecyclePoliciesResponse	getLifecyclePolicies(GetLifecyclePoliciesRequest getLifecyclePoliciesRequest)	Gets summary information about all or the specified data lifecycle policies.
default GetLifecyclePolicyResponse	getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)	Gets detailed information about the specified lifecycle policy.
default GetLifecyclePolicyResponse	getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)	Gets detailed information about the specified lifecycle policy.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Lists the tags for the specified resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Lists the tags for the specified resource.
default DlmServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds the specified tags to the specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds the specified tags to the specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes the specified tags from the specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes the specified tags from the specified resource.
default UpdateLifecyclePolicyResponse	updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)	Updates the specified lifecycle policy.
default UpdateLifecyclePolicyResponse	updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)	Updates the specified lifecycle policy.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createLifecyclePolicy

default CreateLifecyclePolicyResponse createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)
                                                     throws InvalidRequestException,
LimitExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
DlmException

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.

Parameters:

createLifecyclePolicyRequest -

Returns:

Result of the CreateLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

createLifecyclePolicy

default CreateLifecyclePolicyResponse createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)
                                                     throws InvalidRequestException,
LimitExceededException,
InternalServerException,
AwsServiceException,
SdkClientException,
DlmException

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.

This is a convenience which creates an instance of the CreateLifecyclePolicyRequest.Builder avoiding the need to create one manually via CreateLifecyclePolicyRequest.builder()

Parameters:

createLifecyclePolicyRequest - A Consumer that will call methods on CreateLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the CreateLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteLifecyclePolicy

default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
                                                     throws ResourceNotFoundException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

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.

Parameters:

deleteLifecyclePolicyRequest -

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteLifecyclePolicy

default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
                                                     throws ResourceNotFoundException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

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.

This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the need to create one manually via DeleteLifecyclePolicyRequest.builder()

Parameters:

deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the DeleteLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

getLifecyclePolicies

default GetLifecyclePoliciesResponse getLifecyclePolicies(GetLifecyclePoliciesRequest getLifecyclePoliciesRequest)
                                                   throws ResourceNotFoundException,
InvalidRequestException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

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.

See Also:

• AWS API Documentation

getLifecyclePolicies

default GetLifecyclePoliciesResponse getLifecyclePolicies(Consumer<GetLifecyclePoliciesRequest.Builder> getLifecyclePoliciesRequest)
                                                   throws ResourceNotFoundException,
InvalidRequestException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

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

To get complete information about a policy, use GetLifecyclePolicy.

This is a convenience which creates an instance of the GetLifecyclePoliciesRequest.Builder avoiding the need to create one manually via GetLifecyclePoliciesRequest.builder()

Parameters:

getLifecyclePoliciesRequest - A Consumer that will call methods on GetLifecyclePoliciesRequest.Builder to create a request.

Returns:

Result of the GetLifecyclePolicies operation returned by the service.

See Also:

• AWS API Documentation

getLifecyclePolicies

default GetLifecyclePoliciesResponse getLifecyclePolicies()
                                                   throws ResourceNotFoundException,
InvalidRequestException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

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

To get complete information about a policy, use GetLifecyclePolicy.

Returns:

Result of the GetLifecyclePolicies operation returned by the service.

See Also:

• getLifecyclePolicies(GetLifecyclePoliciesRequest)
• AWS API Documentation

getLifecyclePolicy

default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
                                               throws ResourceNotFoundException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

Gets detailed information about the specified lifecycle policy.

Parameters:

getLifecyclePolicyRequest -

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

getLifecyclePolicy

default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
                                               throws ResourceNotFoundException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

Gets detailed information about the specified lifecycle policy.

This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder avoiding the need to create one manually via GetLifecyclePolicyRequest.builder()

Parameters:

getLifecyclePolicyRequest - A Consumer that will call methods on GetLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the GetLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws InternalServerException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DlmException

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws InternalServerException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DlmException

Lists the tags for the specified resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws InternalServerException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DlmException

Adds the specified tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws InternalServerException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DlmException

Adds the specified tags to the specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws InternalServerException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DlmException

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws InternalServerException,
InvalidRequestException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
DlmException

Removes the specified tags from the specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateLifecyclePolicy

default UpdateLifecyclePolicyResponse updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest)
                                                     throws ResourceNotFoundException,
InvalidRequestException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

Updates the specified lifecycle policy.

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

Parameters:

updateLifecyclePolicyRequest -

Returns:

Result of the UpdateLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

updateLifecyclePolicy

default UpdateLifecyclePolicyResponse updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)
                                                     throws ResourceNotFoundException,
InvalidRequestException,
InternalServerException,
LimitExceededException,
AwsServiceException,
SdkClientException,
DlmException

Updates the specified lifecycle policy.

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

This is a convenience which creates an instance of the UpdateLifecyclePolicyRequest.Builder avoiding the need to create one manually via UpdateLifecyclePolicyRequest.builder()

Parameters:

updateLifecyclePolicyRequest - A Consumer that will call methods on UpdateLifecyclePolicyRequest.Builder to create a request.

Returns:

Result of the UpdateLifecyclePolicy operation returned by the service.

See Also:

• AWS API Documentation

create

static DlmClient create()

Create a DlmClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static DlmClientBuilder builder()

Create a builder that can be used to configure and create a DlmClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default DlmServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration