/* * 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.savingsplans; 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.savingsplans.AWSSavingsPlansClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.savingsplans.model.*; import com.amazonaws.services.savingsplans.model.transform.*; /** * Client for accessing AWSSavingsPlans. All service calls made using this client are blocking, and will not return * until the service call completes. *
*
* Savings Plans are a pricing model that offer significant savings on AWS usage (for example, on Amazon EC2 instances). * You commit to a consistent amount of usage, in USD per hour, for a term of 1 or 3 years, and receive a lower price * for that usage. For more information, see the AWS Savings Plans User Guide. *
*/ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSSavingsPlansClient extends AmazonWebServiceClient implements AWSSavingsPlans { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSSavingsPlans.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "savingsplans"; /** 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.0") .withSupportsCbor(false) .withSupportsIon(false) .withContentTypeOverride("application/json") .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller( com.amazonaws.services.savingsplans.model.transform.ValidationExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller( com.amazonaws.services.savingsplans.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ServiceQuotaExceededException").withExceptionUnmarshaller( com.amazonaws.services.savingsplans.model.transform.ServiceQuotaExceededExceptionUnmarshaller.getInstance())) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller( com.amazonaws.services.savingsplans.model.transform.InternalServerExceptionUnmarshaller.getInstance())) .withBaseServiceExceptionClass(com.amazonaws.services.savingsplans.model.AWSSavingsPlansException.class)); public static AWSSavingsPlansClientBuilder builder() { return AWSSavingsPlansClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWSSavingsPlans 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. */ AWSSavingsPlansClient(AwsSyncClientParams clientParams) { this(clientParams, false); } /** * Constructs a new client to invoke service methods on AWSSavingsPlans 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. */ AWSSavingsPlansClient(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("savingsplans.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/savingsplans/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/savingsplans/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** *
* Creates a Savings Plan. *
* * @param createSavingsPlanRequest * @return Result of the CreateSavingsPlan operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ValidationException * One of the input parameters is not valid. * @throws InternalServerException * An unexpected error occurred. * @throws ServiceQuotaExceededException * A service quota has been exceeded. * @sample AWSSavingsPlans.CreateSavingsPlan * @see AWS * API Documentation */ @Override public CreateSavingsPlanResult createSavingsPlan(CreateSavingsPlanRequest request) { request = beforeClientExecution(request); return executeCreateSavingsPlan(request); } @SdkInternalApi final CreateSavingsPlanResult executeCreateSavingsPlan(CreateSavingsPlanRequest createSavingsPlanRequest) { ExecutionContext executionContext = createExecutionContext(createSavingsPlanRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Deletes the queued purchase for the specified Savings Plan. *
* * @param deleteQueuedSavingsPlanRequest * @return Result of the DeleteQueuedSavingsPlan operation returned by the service. * @throws ValidationException * One of the input parameters is not valid. * @throws ResourceNotFoundException * The specified resource was not found. * @throws InternalServerException * An unexpected error occurred. * @throws ServiceQuotaExceededException * A service quota has been exceeded. * @sample AWSSavingsPlans.DeleteQueuedSavingsPlan * @see AWS API Documentation */ @Override public DeleteQueuedSavingsPlanResult deleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest request) { request = beforeClientExecution(request); return executeDeleteQueuedSavingsPlan(request); } @SdkInternalApi final DeleteQueuedSavingsPlanResult executeDeleteQueuedSavingsPlan(DeleteQueuedSavingsPlanRequest deleteQueuedSavingsPlanRequest) { ExecutionContext executionContext = createExecutionContext(deleteQueuedSavingsPlanRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes the specified Savings Plans rates. *
* * @param describeSavingsPlanRatesRequest * @return Result of the DescribeSavingsPlanRates operation returned by the service. * @throws ResourceNotFoundException * The specified resource was not found. * @throws ValidationException * One of the input parameters is not valid. * @sample AWSSavingsPlans.DescribeSavingsPlanRates * @see AWS API Documentation */ @Override public DescribeSavingsPlanRatesResult describeSavingsPlanRates(DescribeSavingsPlanRatesRequest request) { request = beforeClientExecution(request); return executeDescribeSavingsPlanRates(request); } @SdkInternalApi final DescribeSavingsPlanRatesResult executeDescribeSavingsPlanRates(DescribeSavingsPlanRatesRequest describeSavingsPlanRatesRequest) { ExecutionContext executionContext = createExecutionContext(describeSavingsPlanRatesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes the specified Savings Plans. *
* * @param describeSavingsPlansRequest * @return Result of the DescribeSavingsPlans operation returned by the service. * @throws InternalServerException * An unexpected error occurred. * @throws ValidationException * One of the input parameters is not valid. * @sample AWSSavingsPlans.DescribeSavingsPlans * @see AWS API Documentation */ @Override public DescribeSavingsPlansResult describeSavingsPlans(DescribeSavingsPlansRequest request) { request = beforeClientExecution(request); return executeDescribeSavingsPlans(request); } @SdkInternalApi final DescribeSavingsPlansResult executeDescribeSavingsPlans(DescribeSavingsPlansRequest describeSavingsPlansRequest) { ExecutionContext executionContext = createExecutionContext(describeSavingsPlansRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes the specified Savings Plans offering rates. *
* * @param describeSavingsPlansOfferingRatesRequest * @return Result of the DescribeSavingsPlansOfferingRates operation returned by the service. * @throws ValidationException * One of the input parameters is not valid. * @throws InternalServerException * An unexpected error occurred. * @sample AWSSavingsPlans.DescribeSavingsPlansOfferingRates * @see AWS API Documentation */ @Override public DescribeSavingsPlansOfferingRatesResult describeSavingsPlansOfferingRates(DescribeSavingsPlansOfferingRatesRequest request) { request = beforeClientExecution(request); return executeDescribeSavingsPlansOfferingRates(request); } @SdkInternalApi final DescribeSavingsPlansOfferingRatesResult executeDescribeSavingsPlansOfferingRates( DescribeSavingsPlansOfferingRatesRequest describeSavingsPlansOfferingRatesRequest) { ExecutionContext executionContext = createExecutionContext(describeSavingsPlansOfferingRatesRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request* Describes the specified Savings Plans offerings. *
* * @param describeSavingsPlansOfferingsRequest * @return Result of the DescribeSavingsPlansOfferings operation returned by the service. * @throws ValidationException * One of the input parameters is not valid. * @throws InternalServerException * An unexpected error occurred. * @sample AWSSavingsPlans.DescribeSavingsPlansOfferings * @see AWS API Documentation */ @Override public DescribeSavingsPlansOfferingsResult describeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest request) { request = beforeClientExecution(request); return executeDescribeSavingsPlansOfferings(request); } @SdkInternalApi final DescribeSavingsPlansOfferingsResult executeDescribeSavingsPlansOfferings(DescribeSavingsPlansOfferingsRequest describeSavingsPlansOfferingsRequest) { ExecutionContext executionContext = createExecutionContext(describeSavingsPlansOfferingsRequest); 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 ResourceNotFoundException * The specified resource was not found. * @throws ValidationException * One of the input parameters is not valid. * @throws InternalServerException * An unexpected error occurred. * @sample AWSSavingsPlans.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 ResourceNotFoundException * The specified resource was not found. * @throws ServiceQuotaExceededException * A service quota has been exceeded. * @throws ValidationException * One of the input parameters is not valid. * @throws InternalServerException * An unexpected error occurred. * @sample AWSSavingsPlans.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 ResourceNotFoundException * The specified resource was not found. * @throws ValidationException * One of the input parameters is not valid. * @throws InternalServerException * An unexpected error occurred. * @sample AWSSavingsPlans.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
* 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