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 staticbuilder()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 StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static DlmClientBuilderbuilder()Create a builder that can be used to configure and create aDlmClient.static DlmClientcreate()Create aDlmClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateLifecyclePolicyResponsecreateLifecyclePolicy(Consumer<CreateLifecyclePolicyRequest.Builder> createLifecyclePolicyRequest)Creates a policy to manage the lifecycle of the specified Amazon Web Services resources.default CreateLifecyclePolicyResponsecreateLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest)Creates a policy to manage the lifecycle of the specified Amazon Web Services resources.default DeleteLifecyclePolicyResponsedeleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)Deletes the specified lifecycle policy and halts the automated operations that the policy specified.default DeleteLifecyclePolicyResponsedeleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)Deletes the specified lifecycle policy and halts the automated operations that the policy specified.default GetLifecyclePoliciesResponsegetLifecyclePolicies()Gets summary information about all or the specified data lifecycle policies.default GetLifecyclePoliciesResponsegetLifecyclePolicies(Consumer<GetLifecyclePoliciesRequest.Builder> getLifecyclePoliciesRequest)Gets summary information about all or the specified data lifecycle policies.default GetLifecyclePoliciesResponsegetLifecyclePolicies(GetLifecyclePoliciesRequest getLifecyclePoliciesRequest)Gets summary information about all or the specified data lifecycle policies.default GetLifecyclePolicyResponsegetLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)Gets detailed information about the specified lifecycle policy.default GetLifecyclePolicyResponsegetLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)Gets detailed information about the specified lifecycle policy.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)Lists the tags for the specified resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)Lists the tags for the specified resource.default DlmServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Adds the specified tags to the specified resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Adds the specified tags to the specified resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Removes the specified tags from the specified resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Removes the specified tags from the specified resource.default UpdateLifecyclePolicyResponseupdateLifecyclePolicy(Consumer<UpdateLifecyclePolicyRequest.Builder> updateLifecyclePolicyRequest)Updates the specified lifecycle policy.default UpdateLifecyclePolicyResponseupdateLifecyclePolicy(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 Detail
-
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 theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createLifecyclePolicy
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.
- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
createLifecyclePolicy
default 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.Builderavoiding the need to create one manually viaCreateLifecyclePolicyRequest.builder()- Parameters:
createLifecyclePolicyRequest- AConsumerthat will call methods onCreateLifecyclePolicyRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaDeleteLifecyclePolicyRequest.builder()- Parameters:
deleteLifecyclePolicyRequest- AConsumerthat will call methods onDeleteLifecyclePolicyRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetLifecyclePoliciesRequest.builder()- Parameters:
getLifecyclePoliciesRequest- AConsumerthat will call methods onGetLifecyclePoliciesRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaGetLifecyclePolicyRequest.builder()- Parameters:
getLifecyclePolicyRequest- AConsumerthat will call methods onGetLifecyclePolicyRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- 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.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.AwsServiceException- 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.
- 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.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.AwsServiceException- 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.Builderavoiding the need to create one manually viaUpdateLifecyclePolicyRequest.builder()- Parameters:
updateLifecyclePolicyRequest- AConsumerthat will call methods onUpdateLifecyclePolicyRequest.Builderto create a request.- 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.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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static DlmClient create()
Create aDlmClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static DlmClientBuilder builder()
Create a builder that can be used to configure and create aDlmClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default DlmServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-