/* * Copyright 2018-2023 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 org.w3c.dom.*; import java.net.*; import java.util.*; import javax.annotation.Generated; import org.apache.commons.logging.*; import com.amazonaws.*; import com.amazonaws.annotation.SdkInternalApi; import com.amazonaws.auth.*; import com.amazonaws.handlers.*; import com.amazonaws.http.*; import com.amazonaws.internal.*; import com.amazonaws.internal.auth.*; import com.amazonaws.metrics.*; import com.amazonaws.regions.*; import com.amazonaws.transform.*; import com.amazonaws.util.*; import com.amazonaws.protocol.json.*; import com.amazonaws.util.AWSRequestMetrics.Field; import com.amazonaws.annotation.ThreadSafe; import com.amazonaws.client.AwsSyncClientParams; import com.amazonaws.client.builder.AdvancedConfig; import com.amazonaws.services.dlm.AmazonDLMClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.dlm.model.*; import com.amazonaws.services.dlm.model.transform.*; /** * Client for accessing Amazon DLM. All service calls made using this client are blocking, and will not return until the * service call completes. *
*
* 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. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AmazonDLMClient extends AmazonWebServiceClient implements AmazonDLM { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AmazonDLM.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "dlm"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final AdvancedConfig advancedConfig; private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InvalidRequestException").withExceptionUnmarshaller( com.amazonaws.services.dlm.model.transform.InvalidRequestExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.dlm.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.dlm.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("LimitExceededException").withExceptionUnmarshaller( com.amazonaws.services.dlm.model.transform.LimitExceededExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.dlm.model.AmazonDLMException.class)); public static AmazonDLMClientBuilder builder() { return AmazonDLMClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on Amazon DLM using the specified parameters. * ** All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonDLMClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on Amazon DLM using the specified parameters. * *
* All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientParams * Object providing client parameters. */ AmazonDLMClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); this.advancedConfig = clientParams.getAdvancedConfig(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("dlm.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/dlm/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/dlm/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Creates a policy to manage the lifecycle of the specified Amazon Web Services 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 */ @Override public CreateLifecyclePolicyResult createLifecyclePolicy(CreateLifecyclePolicyRequest request) { request = beforeClientExecution(request); return executeCreateLifecyclePolicy(request); } @SdkInternalApi final CreateLifecyclePolicyResult executeCreateLifecyclePolicy(CreateLifecyclePolicyRequest createLifecyclePolicyRequest) { ExecutionContext executionContext = createExecutionContext(createLifecyclePolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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. *
* * @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 */ @Override public DeleteLifecyclePolicyResult deleteLifecyclePolicy(DeleteLifecyclePolicyRequest request) { request = beforeClientExecution(request); return executeDeleteLifecyclePolicy(request); } @SdkInternalApi final DeleteLifecyclePolicyResult executeDeleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) { ExecutionContext executionContext = createExecutionContext(deleteLifecyclePolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public GetLifecyclePoliciesResult getLifecyclePolicies(GetLifecyclePoliciesRequest request) { request = beforeClientExecution(request); return executeGetLifecyclePolicies(request); } @SdkInternalApi final GetLifecyclePoliciesResult executeGetLifecyclePolicies(GetLifecyclePoliciesRequest getLifecyclePoliciesRequest) { ExecutionContext executionContext = createExecutionContext(getLifecyclePoliciesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public GetLifecyclePolicyResult getLifecyclePolicy(GetLifecyclePolicyRequest request) { request = beforeClientExecution(request); return executeGetLifecyclePolicy(request); } @SdkInternalApi final GetLifecyclePolicyResult executeGetLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) { ExecutionContext executionContext = createExecutionContext(getLifecyclePolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request) { request = beforeClientExecution(request); return executeListTagsForResource(request); } @SdkInternalApi final ListTagsForResourceResult executeListTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) { ExecutionContext executionContext = createExecutionContext(listTagsForResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public TagResourceResult tagResource(TagResourceRequest request) { request = beforeClientExecution(request); return executeTagResource(request); } @SdkInternalApi final TagResourceResult executeTagResource(TagResourceRequest tagResourceRequest) { ExecutionContext executionContext = createExecutionContext(tagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* 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 */ @Override public UntagResourceResult untagResource(UntagResourceRequest request) { request = beforeClientExecution(request); return executeUntagResource(request); } @SdkInternalApi final UntagResourceResult executeUntagResource(UntagResourceRequest untagResourceRequest) { ExecutionContext executionContext = createExecutionContext(untagResourceRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Updates the specified lifecycle policy. *
** For more information about updating a policy, see Modify lifecycle * policies. *
* * @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 */ @Override public UpdateLifecyclePolicyResult updateLifecyclePolicy(UpdateLifecyclePolicyRequest request) { request = beforeClientExecution(request); return executeUpdateLifecyclePolicy(request); } @SdkInternalApi final UpdateLifecyclePolicyResult executeUpdateLifecyclePolicy(UpdateLifecyclePolicyRequest updateLifecyclePolicyRequest) { ExecutionContext executionContext = createExecutionContext(updateLifecyclePolicyRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request
* 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 the request.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private