/* * Copyright 2012-2017 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.costandusagereport; 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.services.costandusagereport.AWSCostAndUsageReportClientBuilder; import com.amazonaws.AmazonServiceException; import com.amazonaws.services.costandusagereport.model.*; import com.amazonaws.services.costandusagereport.model.transform.*; /** * Client for accessing AWS Cost and Usage Report Service. All service calls made using this client are blocking, and * will not return until the service call completes. * <p> * All public APIs for AWS Cost and Usage Report service */ @ThreadSafe @Generated("com.amazonaws:aws-java-sdk-code-generator") public class AWSCostAndUsageReportClient extends AmazonWebServiceClient implements AWSCostAndUsageReport { /** Provider for AWS credentials. */ private final AWSCredentialsProvider awsCredentialsProvider; private static final Log log = LogFactory.getLog(AWSCostAndUsageReport.class); /** Default signing name for the service. */ private static final String DEFAULT_SIGNING_NAME = "cur"; /** Client configuration factory providing ClientConfigurations tailored to this client */ protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory(); private final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory( new JsonClientMetadata() .withProtocolVersion("1.1") .withSupportsCbor(false) .withSupportsIon(false) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ValidationException").withModeledClass( com.amazonaws.services.costandusagereport.model.ValidationException.class)) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("ReportLimitReachedException").withModeledClass( com.amazonaws.services.costandusagereport.model.ReportLimitReachedException.class)) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("InternalErrorException").withModeledClass( com.amazonaws.services.costandusagereport.model.InternalErrorException.class)) .addErrorMetadata( new JsonErrorShapeMetadata().withErrorCode("DuplicateReportNameException").withModeledClass( com.amazonaws.services.costandusagereport.model.DuplicateReportNameException.class)) .withBaseServiceExceptionClass(com.amazonaws.services.costandusagereport.model.AWSCostAndUsageReportException.class)); /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service. A credentials provider * chain will be used that searches for credentials in this order: * <ul> * <li>Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY</li> * <li>Java System Properties - aws.accessKeyId and aws.secretKey</li> * <li>Instance profile credentials delivered through the Amazon EC2 metadata service</li> * </ul> * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSCostAndUsageReportClientBuilder#defaultClient()} */ @Deprecated public AWSCostAndUsageReportClient() { this(DefaultAWSCredentialsProviderChain.getInstance(), configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service. A credentials provider * chain will be used that searches for credentials in this order: * <ul> * <li>Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY</li> * <li>Java System Properties - aws.accessKeyId and aws.secretKey</li> * <li>Instance profile credentials delivered through the Amazon EC2 metadata service</li> * </ul> * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Cost and Usage Report Service * (ex: proxy settings, retry counts, etc.). * * @see DefaultAWSCredentialsProviderChain * @deprecated use {@link AWSCostAndUsageReportClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSCostAndUsageReportClient(ClientConfiguration clientConfiguration) { this(DefaultAWSCredentialsProviderChain.getInstance(), clientConfiguration); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS * account credentials. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @deprecated use {@link AWSCostAndUsageReportClientBuilder#withCredentials(AWSCredentialsProvider)} for example: * {@code AWSCostAndUsageReportClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();} */ @Deprecated public AWSCostAndUsageReportClient(AWSCredentials awsCredentials) { this(awsCredentials, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS * account credentials and client configuration options. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentials * The AWS credentials (access key ID and secret key) to use when authenticating with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Cost and Usage Report Service * (ex: proxy settings, retry counts, etc.). * @deprecated use {@link AWSCostAndUsageReportClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSCostAndUsageReportClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSCostAndUsageReportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) { super(clientConfiguration); this.awsCredentialsProvider = new StaticCredentialsProvider(awsCredentials); init(); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS * account credentials provider. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @deprecated use {@link AWSCostAndUsageReportClientBuilder#withCredentials(AWSCredentialsProvider)} */ @Deprecated public AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider) { this(awsCredentialsProvider, configFactory.getConfig()); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS * account credentials provider and client configuration options. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Cost and Usage Report Service * (ex: proxy settings, retry counts, etc.). * @deprecated use {@link AWSCostAndUsageReportClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSCostAndUsageReportClientBuilder#withClientConfiguration(ClientConfiguration)} */ @Deprecated public AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) { this(awsCredentialsProvider, clientConfiguration, null); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS * account credentials provider, client configuration options, and request metric collector. * * <p> * All service calls made using this new client object are blocking, and will not return until the service call * completes. * * @param awsCredentialsProvider * The AWS credentials provider which will provide credentials to authenticate requests with AWS services. * @param clientConfiguration * The client configuration options controlling how this client connects to AWS Cost and Usage Report Service * (ex: proxy settings, retry counts, etc.). * @param requestMetricCollector * optional request metric collector * @deprecated use {@link AWSCostAndUsageReportClientBuilder#withCredentials(AWSCredentialsProvider)} and * {@link AWSCostAndUsageReportClientBuilder#withClientConfiguration(ClientConfiguration)} and * {@link AWSCostAndUsageReportClientBuilder#withMetricsCollector(RequestMetricCollector)} */ @Deprecated public AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) { super(clientConfiguration, requestMetricCollector); this.awsCredentialsProvider = awsCredentialsProvider; init(); } public static AWSCostAndUsageReportClientBuilder builder() { return AWSCostAndUsageReportClientBuilder.standard(); } /** * Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified * parameters. * * <p> * 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. */ AWSCostAndUsageReportClient(AwsSyncClientParams clientParams) { super(clientParams); this.awsCredentialsProvider = clientParams.getCredentialsProvider(); init(); } private void init() { setServiceNameIntern(DEFAULT_SIGNING_NAME); setEndpointPrefix(ENDPOINT_PREFIX); // calling this.setEndPoint(...) will also modify the signer accordingly setEndpoint("cur.us-east-1.amazonaws.com"); HandlerChainFactory chainFactory = new HandlerChainFactory(); requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/costandusagereport/request.handlers")); requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/costandusagereport/request.handler2s")); requestHandler2s.addAll(chainFactory.getGlobalHandlers()); } /** * Delete a specified report definition * * @param deleteReportDefinitionRequest * Request of DeleteReportDefinition * @return Result of the DeleteReportDefinition operation returned by the service. * @throws InternalErrorException * This exception is thrown on a known dependency failure. * @throws ValidationException * This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid * report name, or Delete a report preference with an empty report name. * @sample AWSCostAndUsageReport.DeleteReportDefinition * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/cur-2017-01-06/DeleteReportDefinition" target="_top">AWS API * Documentation</a> */ @Override public DeleteReportDefinitionResult deleteReportDefinition(DeleteReportDefinitionRequest request) { request = beforeClientExecution(request); return executeDeleteReportDefinition(request); } @SdkInternalApi final DeleteReportDefinitionResult executeDeleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest) { ExecutionContext executionContext = createExecutionContext(deleteReportDefinitionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DeleteReportDefinitionRequest> request = null; Response<DeleteReportDefinitionResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DeleteReportDefinitionRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(deleteReportDefinitionRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DeleteReportDefinitionResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteReportDefinitionResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * Describe a list of report definitions owned by the account * * @param describeReportDefinitionsRequest * Request of DescribeReportDefinitions * @return Result of the DescribeReportDefinitions operation returned by the service. * @throws InternalErrorException * This exception is thrown on a known dependency failure. * @sample AWSCostAndUsageReport.DescribeReportDefinitions * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/cur-2017-01-06/DescribeReportDefinitions" target="_top">AWS * API Documentation</a> */ @Override public DescribeReportDefinitionsResult describeReportDefinitions(DescribeReportDefinitionsRequest request) { request = beforeClientExecution(request); return executeDescribeReportDefinitions(request); } @SdkInternalApi final DescribeReportDefinitionsResult executeDescribeReportDefinitions(DescribeReportDefinitionsRequest describeReportDefinitionsRequest) { ExecutionContext executionContext = createExecutionContext(describeReportDefinitionsRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<DescribeReportDefinitionsRequest> request = null; Response<DescribeReportDefinitionsResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new DescribeReportDefinitionsRequestProtocolMarshaller(protocolFactory).marshall(super .beforeMarshalling(describeReportDefinitionsRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<DescribeReportDefinitionsResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DescribeReportDefinitionsResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * Create a new report definition * * @param putReportDefinitionRequest * Request of PutReportDefinition * @return Result of the PutReportDefinition operation returned by the service. * @throws DuplicateReportNameException * This exception is thrown when putting a report preference with a name that already exists. * @throws ReportLimitReachedException * This exception is thrown when the number of report preference reaches max limit. The max number is 5. * @throws InternalErrorException * This exception is thrown on a known dependency failure. * @throws ValidationException * This exception is thrown when providing an invalid input. eg. Put a report preference with an invalid * report name, or Delete a report preference with an empty report name. * @sample AWSCostAndUsageReport.PutReportDefinition * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/cur-2017-01-06/PutReportDefinition" target="_top">AWS API * Documentation</a> */ @Override public PutReportDefinitionResult putReportDefinition(PutReportDefinitionRequest request) { request = beforeClientExecution(request); return executePutReportDefinition(request); } @SdkInternalApi final PutReportDefinitionResult executePutReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest) { ExecutionContext executionContext = createExecutionContext(putReportDefinitionRequest); AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics(); awsRequestMetrics.startEvent(Field.ClientExecuteTime); Request<PutReportDefinitionRequest> request = null; Response<PutReportDefinitionResult> response = null; try { awsRequestMetrics.startEvent(Field.RequestMarshallTime); try { request = new PutReportDefinitionRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(putReportDefinitionRequest)); // Binds the request metrics to the current request. request.setAWSRequestMetrics(awsRequestMetrics); } finally { awsRequestMetrics.endEvent(Field.RequestMarshallTime); } HttpResponseHandler<AmazonWebServiceResponse<PutReportDefinitionResult>> responseHandler = protocolFactory.createResponseHandler( new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new PutReportDefinitionResultJsonUnmarshaller()); response = invoke(request, responseHandler, executionContext); return response.getAwsResponse(); } finally { endClientExecution(awsRequestMetrics, request, response); } } /** * 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. * <p> * 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 <X, Y extends AmazonWebServiceRequest> Response<X> invoke(Request<Y> request, HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler, ExecutionContext executionContext) { executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider)); return doInvoke(request, responseHandler, executionContext); } /** * Invoke with no authentication. Credentials are not required and any credentials set on the client or request will * be ignored for this operation. **/ private <X, Y extends AmazonWebServiceRequest> Response<X> anonymousInvoke(Request<Y> request, HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler, ExecutionContext executionContext) { return doInvoke(request, responseHandler, executionContext); } /** * Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the * ExecutionContext beforehand. **/ private <X, Y extends AmazonWebServiceRequest> Response<X> doInvoke(Request<Y> request, HttpResponseHandler<AmazonWebServiceResponse<X>> responseHandler, ExecutionContext executionContext) { request.setEndpoint(endpoint); request.setTimeOffset(timeOffset); HttpResponseHandler<AmazonServiceException> errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata()); return client.execute(request, responseHandler, errorResponseHandler, executionContext); } }