software.amazon.awssdk.services.dlm

Interface DlmClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface DlmClient
extends SdkClient

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 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	SERVICE_NAME

Method Summary

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 AWS resources.
default CreateLifecyclePolicyResponse	createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest) Creates a policy to manage the lifecycle of the specified AWS 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.
static ServiceMetadata	serviceMetadata()
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.core.SdkClient

serviceName

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

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

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.

createLifecyclePolicy

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

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.

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 AWS 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()

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.

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.

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.

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.

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()
                                                   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

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

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

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

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

updateLifecyclePolicy

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

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.

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.

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.

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

serviceMetadata

static ServiceMetadata serviceMetadata()