com.amazonaws.services.dlm.AmazonDLM Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dlm Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.dlm;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.dlm.model.*;
/**
* Interface for accessing Amazon DLM.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.dlm.AbstractAmazonDLM} instead.
*
*
* Amazon Data Lifecycle Manager
*
* With Amazon Data Lifecycle Manager, you can manage the lifecycle of your AWS resources. You create lifecycle
* policies, which are used to automate operations on the specified resources.
*
*
* Amazon DLM supports Amazon EBS volumes and snapshots. For information about using Amazon DLM with Amazon EBS, see Automating the Amazon EBS Snapshot
* Lifecycle in the Amazon EC2 User Guide.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDLM {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "dlm";
/**
*
* Creates a policy to manage the lifecycle of the specified AWS resources. You can create up to 100 lifecycle
* policies.
*
*
* @param createLifecyclePolicyRequest
* @return Result of the CreateLifecyclePolicy operation returned by the service.
* @throws InvalidRequestException
* Bad request. The request is missing required parameters or has invalid parameters.
* @throws LimitExceededException
* The request failed because a limit was exceeded.
* @throws InternalServerException
* The service failed in an unexpected way.
* @sample AmazonDLM.CreateLifecyclePolicy
* @see AWS API
* Documentation
*/
CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest);
/**
*
* Deletes the specified lifecycle policy and halts the automated operations that the policy specified.
*
*
* @param deleteLifecyclePolicyRequest
* @return Result of the DeleteLifecyclePolicy operation returned by the service.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws LimitExceededException
* The request failed because a limit was exceeded.
* @sample AmazonDLM.DeleteLifecyclePolicy
* @see AWS API
* Documentation
*/
DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest);
/**
*
* Gets summary information about all or the specified data lifecycle policies.
*
*
* To get complete information about a policy, use GetLifecyclePolicy.
*
*
* @param getLifecyclePoliciesRequest
* @return Result of the GetLifecyclePolicies operation returned by the service.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @throws InvalidRequestException
* Bad request. The request is missing required parameters or has invalid parameters.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws LimitExceededException
* The request failed because a limit was exceeded.
* @sample AmazonDLM.GetLifecyclePolicies
* @see AWS API
* Documentation
*/
GetLifecyclePoliciesResult getLifecyclePolicies(GetLifecyclePoliciesRequest getLifecyclePoliciesRequest);
/**
*
* Gets detailed information about the specified lifecycle policy.
*
*
* @param getLifecyclePolicyRequest
* @return Result of the GetLifecyclePolicy operation returned by the service.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws LimitExceededException
* The request failed because a limit was exceeded.
* @sample AmazonDLM.GetLifecyclePolicy
* @see AWS API
* Documentation
*/
GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest);
/**
*
* Lists the tags for the specified resource.
*
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws InvalidRequestException
* Bad request. The request is missing required parameters or has invalid parameters.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @sample AmazonDLM.ListTagsForResource
* @see AWS API
* Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
*
* Adds the specified tags to the specified resource.
*
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws InvalidRequestException
* Bad request. The request is missing required parameters or has invalid parameters.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @sample AmazonDLM.TagResource
* @see AWS API
* Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
*
* Removes the specified tags from the specified resource.
*
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws InvalidRequestException
* Bad request. The request is missing required parameters or has invalid parameters.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @sample AmazonDLM.UntagResource
* @see AWS API
* Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
*
* Updates the specified lifecycle policy.
*
*
* @param updateLifecyclePolicyRequest
* @return Result of the UpdateLifecyclePolicy operation returned by the service.
* @throws ResourceNotFoundException
* A requested resource was not found.
* @throws InvalidRequestException
* Bad request. The request is missing required parameters or has invalid parameters.
* @throws InternalServerException
* The service failed in an unexpected way.
* @throws LimitExceededException
* The request failed because a limit was exceeded.
* @sample AmazonDLM.UpdateLifecyclePolicy
* @see AWS API
* Documentation
*/
UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}