com.amazonaws.services.costandusagereport

Class AWSCostAndUsageReportAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.costandusagereport.AWSCostAndUsageReportClient

com.amazonaws.services.costandusagereport.AWSCostAndUsageReportAsyncClient

All Implemented Interfaces:

AWSCostAndUsageReport, AWSCostAndUsageReportAsync

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

Client for accessing AWS Cost and Usage Report Service asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation 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
AWSCostAndUsageReportAsyncClient() Deprecated. use AWSCostAndUsageReportAsyncClientBuilder.defaultClient()
AWSCostAndUsageReportAsyncClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSCostAndUsageReportAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSCostAndUsageReportAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSCostAndUsageReportAsyncClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSCostAndUsageReportAsyncClientBuilder	asyncBuilder()
Future<DeleteReportDefinitionResult>	deleteReportDefinitionAsync(DeleteReportDefinitionRequest request) Deletes the specified report.
Future<DeleteReportDefinitionResult>	deleteReportDefinitionAsync(DeleteReportDefinitionRequest request, AsyncHandler<DeleteReportDefinitionRequest,DeleteReportDefinitionResult> asyncHandler) Deletes the specified report.
Future<DescribeReportDefinitionsResult>	describeReportDefinitionsAsync(DescribeReportDefinitionsRequest request) Lists the AWS Cost and Usage reports available to this account.
Future<DescribeReportDefinitionsResult>	describeReportDefinitionsAsync(DescribeReportDefinitionsRequest request, AsyncHandler<DescribeReportDefinitionsRequest,DescribeReportDefinitionsResult> asyncHandler) Lists the AWS Cost and Usage reports available to this account.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<ModifyReportDefinitionResult>	modifyReportDefinitionAsync(ModifyReportDefinitionRequest request) Allows you to programatically update your report preferences.
Future<ModifyReportDefinitionResult>	modifyReportDefinitionAsync(ModifyReportDefinitionRequest request, AsyncHandler<ModifyReportDefinitionRequest,ModifyReportDefinitionResult> asyncHandler) Allows you to programatically update your report preferences.
Future<PutReportDefinitionResult>	putReportDefinitionAsync(PutReportDefinitionRequest request) Creates a new report using the description that you provide.
Future<PutReportDefinitionResult>	putReportDefinitionAsync(PutReportDefinitionRequest request, AsyncHandler<PutReportDefinitionRequest,PutReportDefinitionResult> asyncHandler) Creates a new report using the description that you provide.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.costandusagereport.AWSCostAndUsageReportClient

builder, deleteReportDefinition, describeReportDefinitions, getCachedResponseMetadata, modifyReportDefinition, putReportDefinition

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, 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

deleteReportDefinition, describeReportDefinitions, getCachedResponseMetadata, modifyReportDefinition, putReportDefinition, setEndpoint, setRegion

Constructor Detail

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient()

Deprecated. use AWSCostAndUsageReportAsyncClientBuilder.defaultClient()

Constructs a new asynchronous 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous 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
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

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, Executors.newFixedThreadPool(int)

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

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

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

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

See Also:

Executors.newFixedThreadPool(int)

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentials awsCredentials,
                                                    ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

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

executorService - The executor service by which all asynchronous requests will be executed.

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentials awsCredentials,
                                                    ClientConfiguration clientConfiguration,
                                                    ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

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

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

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

See Also:

Executors.newFixedThreadPool(int)

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ClientConfiguration clientConfiguration)

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

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

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS Cost and Usage Report Service using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

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

executorService - The executor service by which all asynchronous requests will be executed.

AWSCostAndUsageReportAsyncClient

@Deprecated
public AWSCostAndUsageReportAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                                    ClientConfiguration clientConfiguration,
                                                    ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

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

Parameters:

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

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

asyncBuilder

public static AWSCostAndUsageReportAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

deleteReportDefinitionAsync

public Future<DeleteReportDefinitionResult> deleteReportDefinitionAsync(DeleteReportDefinitionRequest request)

Description copied from interface: AWSCostAndUsageReportAsync

Deletes the specified report.

Specified by:

deleteReportDefinitionAsync in interface AWSCostAndUsageReportAsync

Parameters:

request - Deletes the specified report.

Returns:

A Java Future containing the result of the DeleteReportDefinition operation returned by the service.

See Also:

AWS API Documentation

deleteReportDefinitionAsync

public Future<DeleteReportDefinitionResult> deleteReportDefinitionAsync(DeleteReportDefinitionRequest request,
                                                                        AsyncHandler<DeleteReportDefinitionRequest,DeleteReportDefinitionResult> asyncHandler)

Description copied from interface: AWSCostAndUsageReportAsync

Deletes the specified report.

Specified by:

deleteReportDefinitionAsync in interface AWSCostAndUsageReportAsync

Parameters:

request - Deletes the specified report.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DeleteReportDefinition operation returned by the service.

See Also:

AWS API Documentation

describeReportDefinitionsAsync

public Future<DescribeReportDefinitionsResult> describeReportDefinitionsAsync(DescribeReportDefinitionsRequest request)

Description copied from interface: AWSCostAndUsageReportAsync

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

Specified by:

describeReportDefinitionsAsync in interface AWSCostAndUsageReportAsync

Parameters:

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

Returns:

A Java Future containing the result of the DescribeReportDefinitions operation returned by the service.

See Also:

AWS API Documentation

describeReportDefinitionsAsync

public Future<DescribeReportDefinitionsResult> describeReportDefinitionsAsync(DescribeReportDefinitionsRequest request,
                                                                              AsyncHandler<DescribeReportDefinitionsRequest,DescribeReportDefinitionsResult> asyncHandler)

Description copied from interface: AWSCostAndUsageReportAsync

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

Specified by:

describeReportDefinitionsAsync in interface AWSCostAndUsageReportAsync

Parameters:

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

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the DescribeReportDefinitions operation returned by the service.

See Also:

AWS API Documentation

modifyReportDefinitionAsync

public Future<ModifyReportDefinitionResult> modifyReportDefinitionAsync(ModifyReportDefinitionRequest request)

Description copied from interface: AWSCostAndUsageReportAsync

Allows you to programatically update your report preferences.

Specified by:

modifyReportDefinitionAsync in interface AWSCostAndUsageReportAsync

Returns:

A Java Future containing the result of the ModifyReportDefinition operation returned by the service.

See Also:

AWS API Documentation

modifyReportDefinitionAsync

public Future<ModifyReportDefinitionResult> modifyReportDefinitionAsync(ModifyReportDefinitionRequest request,
                                                                        AsyncHandler<ModifyReportDefinitionRequest,ModifyReportDefinitionResult> asyncHandler)

Description copied from interface: AWSCostAndUsageReportAsync

Allows you to programatically update your report preferences.

Specified by:

modifyReportDefinitionAsync in interface AWSCostAndUsageReportAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ModifyReportDefinition operation returned by the service.

See Also:

AWS API Documentation

putReportDefinitionAsync

public Future<PutReportDefinitionResult> putReportDefinitionAsync(PutReportDefinitionRequest request)

Description copied from interface: AWSCostAndUsageReportAsync

Creates a new report using the description that you provide.

Specified by:

putReportDefinitionAsync in interface AWSCostAndUsageReportAsync

Parameters:

request - Creates a Cost and Usage Report.

Returns:

A Java Future containing the result of the PutReportDefinition operation returned by the service.

See Also:

AWS API Documentation

putReportDefinitionAsync

public Future<PutReportDefinitionResult> putReportDefinitionAsync(PutReportDefinitionRequest request,
                                                                  AsyncHandler<PutReportDefinitionRequest,PutReportDefinitionResult> asyncHandler)

Description copied from interface: AWSCostAndUsageReportAsync

Creates a new report using the description that you provide.

Specified by:

putReportDefinitionAsync in interface AWSCostAndUsageReportAsync

Parameters:

request - Creates a Cost and Usage Report.

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutReportDefinition operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSCostAndUsageReport

Overrides:

shutdown in class AWSCostAndUsageReportClient