com.amazonaws.services.costandusagereport

Interface AWSCostAndUsageReport

All Known Subinterfaces:

AWSCostAndUsageReportAsync

All Known Implementing Classes:

AbstractAWSCostAndUsageReport, AbstractAWSCostAndUsageReportAsync, AWSCostAndUsageReportAsyncClient, AWSCostAndUsageReportClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSCostAndUsageReport

Interface for accessing AWS Cost and Usage Report Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSCostAndUsageReport instead.

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

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DeleteReportDefinitionResult	deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest) Deletes the specified report.
DescribeReportDefinitionsResult	describeReportDefinitions(DescribeReportDefinitionsRequest describeReportDefinitionsRequest) 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 modifyReportDefinitionRequest) Allows you to programatically update your report preferences.
PutReportDefinitionResult	putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest) Creates a new report using the description that you provide.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("cur.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cur.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "cur.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "cur.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "cur.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

deleteReportDefinition

DeleteReportDefinitionResult deleteReportDefinition(DeleteReportDefinitionRequest deleteReportDefinitionRequest)

Deletes the specified report.

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

DescribeReportDefinitionsResult describeReportDefinitions(DescribeReportDefinitionsRequest describeReportDefinitionsRequest)

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

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

ModifyReportDefinitionResult modifyReportDefinition(ModifyReportDefinitionRequest modifyReportDefinitionRequest)

Allows you to programatically update your report preferences.

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

PutReportDefinitionResult putReportDefinition(PutReportDefinitionRequest putReportDefinitionRequest)

Creates a new report using the description that you provide.

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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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