com.amazonaws.services.costandusagereport

Class AWSCostAndUsageReportClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.costandusagereport.AWSCostAndUsageReportClient

All Implemented Interfaces:

AWSCostAndUsageReport

Direct Known Subclasses:

AWSCostAndUsageReportAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSCostAndUsageReportClient
extends AmazonWebServiceClient
implements AWSCostAndUsageReport

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.

The AWS Cost and Usage Report API enables you to programmatically create, query, and delete AWS Cost and Usage report definitions.

AWS Cost and Usage reports track the monthly AWS costs and usage associated with your AWS account. The report contains line items for each unique combination of AWS product, usage type, and operation that your AWS account uses. You can configure the AWS Cost and Usage report to show only the data that you want, using the AWS Cost and Usage API.

Service Endpoint

The AWS Cost and Usage Report API provides the following endpoint:

• cur.us-east-1.amazonaws.com

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.costandusagereport.AWSCostAndUsageReport

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSCostAndUsageReportClient() Deprecated. use AWSCostAndUsageReportClientBuilder.defaultClient()
AWSCostAndUsageReportClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSCostAndUsageReportClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
AWSCostAndUsageReportClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
AWSCostAndUsageReportClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSCostAndUsageReportClientBuilder	builder()
DeleteReportDefinitionResult	deleteReportDefinition(DeleteReportDefinitionRequest request) Deletes the specified report.
DescribeReportDefinitionsResult	describeReportDefinitions(DescribeReportDefinitionsRequest request) Lists the AWS Cost and Usage reports available to this account.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ModifyReportDefinitionResult	modifyReportDefinition(ModifyReportDefinitionRequest request) Allows you to programatically update your report preferences.
PutReportDefinitionResult	putReportDefinition(PutReportDefinitionRequest request) Creates a new report using the description that you provide.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.costandusagereport.AWSCostAndUsageReport

setEndpoint, setRegion, shutdown

Constructor Detail

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient()

Deprecated. use AWSCostAndUsageReportClientBuilder.defaultClient()

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:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS Cost and Usage Report Service (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AWSCostAndUsageReportClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();

Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient(AWSCredentials awsCredentials,
                                               ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Cost and Usage Report Service (ex: proxy settings, retry counts, etc.).

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Cost and Usage Report Service (ex: proxy settings, retry counts, etc.).

AWSCostAndUsageReportClient

@Deprecated
public AWSCostAndUsageReportClient(AWSCredentialsProvider awsCredentialsProvider,
                                               ClientConfiguration clientConfiguration,
                                               RequestMetricCollector requestMetricCollector)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)

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.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AWS Cost and Usage Report Service (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

builder

public static AWSCostAndUsageReportClientBuilder builder()

deleteReportDefinition

public DeleteReportDefinitionResult deleteReportDefinition(DeleteReportDefinitionRequest request)

Deletes the specified report.

Specified by:

deleteReportDefinition in interface AWSCostAndUsageReport

Parameters:

deleteReportDefinitionRequest - Deletes the specified report.

Returns:

Result of the DeleteReportDefinition operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

describeReportDefinitions

public DescribeReportDefinitionsResult describeReportDefinitions(DescribeReportDefinitionsRequest request)

Lists the AWS Cost and Usage reports available to this account.

Specified by:

describeReportDefinitions in interface AWSCostAndUsageReport

Parameters:

describeReportDefinitionsRequest - Requests a list of AWS Cost and Usage reports owned by the account.

Returns:

Result of the DescribeReportDefinitions operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

See Also:

AWS API Documentation

modifyReportDefinition

public ModifyReportDefinitionResult modifyReportDefinition(ModifyReportDefinitionRequest request)

Allows you to programatically update your report preferences.

Specified by:

modifyReportDefinition in interface AWSCostAndUsageReport

Parameters:

modifyReportDefinitionRequest -

Returns:

Result of the ModifyReportDefinition operation returned by the service.

Throws:

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

putReportDefinition

public PutReportDefinitionResult putReportDefinition(PutReportDefinitionRequest request)

Creates a new report using the description that you provide.

Specified by:

putReportDefinition in interface AWSCostAndUsageReport

Parameters:

putReportDefinitionRequest - Creates a Cost and Usage Report.

Returns:

Result of the PutReportDefinition operation returned by the service.

Throws:

DuplicateReportNameException - A report with the specified name already exists in the account. Specify a different report name.

ReportLimitReachedException - This account already has five reports defined. To define a new report, you must delete an existing report.

InternalErrorException - An error on the server occurred during the processing of your request. Try again later.

ValidationException - The input fails to satisfy the constraints specified by an AWS service.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

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

Specified by:

getCachedResponseMetadata in interface AWSCostAndUsageReport

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.