@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface DlmClient extends SdkClient
builder() method.
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 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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and 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 a policy to manage the lifecycle of the specified Amazon Web Services resources.
|
default CreateLifecyclePolicyResponse |
createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)
Creates a policy to manage the lifecycle of the specified Amazon Web Services resources.
|
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.
|
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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static DlmClient create()
DlmClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static DlmClientBuilder builder()
DlmClient.default CreateLifecyclePolicyResponse createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest) throws InvalidRequestException, LimitExceededException, InternalServerException, AwsServiceException, SdkClientException, DlmException
Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can create up to 100 lifecycle policies.
createLifecyclePolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateLifecyclePolicyResponse createLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest) throws InvalidRequestException, LimitExceededException, InternalServerException, AwsServiceException, SdkClientException, DlmException
Creates a policy to manage the lifecycle of the specified Amazon Web Services resources. You can create up to 100 lifecycle policies.
This is a convenience which creates an instance of the CreateLifecyclePolicyRequest.Builder avoiding the
need to create one manually via CreateLifecyclePolicyRequest.builder()
createLifecyclePolicyRequest - A Consumer that will call methods on CreateLifecyclePolicyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteLifecyclePolicyRequest - ResourceNotFoundException - A requested resource was not found.InternalServerException - The service failed in an unexpected way.LimitExceededException - The request failed because a limit was exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder avoiding the
need to create one manually via DeleteLifecyclePolicyRequest.builder()
deleteLifecyclePolicyRequest - A Consumer that will call methods on DeleteLifecyclePolicyRequest.Builder to create a
request.ResourceNotFoundException - A requested resource was not found.InternalServerException - The service failed in an unexpected way.LimitExceededException - The request failed because a limit was exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetLifecyclePolicies(GetLifecyclePoliciesRequest),
AWS API
Documentationdefault 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.
getLifecyclePoliciesRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getLifecyclePoliciesRequest - A Consumer that will call methods on GetLifecyclePoliciesRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ResourceNotFoundException, InternalServerException, LimitExceededException, AwsServiceException, SdkClientException, DlmException
Gets detailed information about the specified lifecycle policy.
getLifecyclePolicyRequest - ResourceNotFoundException - A requested resource was not found.InternalServerException - The service failed in an unexpected way.LimitExceededException - The request failed because a limit was exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
getLifecyclePolicyRequest - A Consumer that will call methods on GetLifecyclePolicyRequest.Builder to create a
request.ResourceNotFoundException - A requested resource was not found.InternalServerException - The service failed in an unexpected way.LimitExceededException - The request failed because a limit was exceeded.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, DlmException
Lists the tags for the specified resource.
listTagsForResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, DlmException
Adds the specified tags to the specified resource.
tagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, DlmException
Removes the specified tags from the specified resource.
untagResourceRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLifecyclePolicyResponse updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServerException, LimitExceededException, AwsServiceException, SdkClientException, DlmException
Updates the specified lifecycle policy.
updateLifecyclePolicyRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateLifecyclePolicyResponse updateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest) throws ResourceNotFoundException, InvalidRequestException, InternalServerException, LimitExceededException, AwsServiceException, SdkClientException, DlmException
Updates the specified lifecycle policy.
This is a convenience which creates an instance of the UpdateLifecyclePolicyRequest.Builder avoiding the
need to create one manually via UpdateLifecyclePolicyRequest.builder()
updateLifecyclePolicyRequest - A Consumer that will call methods on UpdateLifecyclePolicyRequest.Builder to create a
request.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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.DlmException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2022. All rights reserved.