com.amazonaws.services.bcmdataexports

Class AWSBCMDataExportsClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.bcmdataexports.AWSBCMDataExportsClient

All Implemented Interfaces:

AWSBCMDataExports

Direct Known Subclasses:

AWSBCMDataExportsAsyncClient

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

Client for accessing AWS Billing and Cost Management Data Exports. All service calls made using this client are blocking, and will not return until the service call completes.

You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost optimization recommendations.

The Data Exports API provides the following endpoint:

• https://bcm-data-exports.us-east-1.api.aws

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.bcmdataexports.AWSBCMDataExports

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSBCMDataExportsClientBuilder	builder()
CreateExportResult	createExport(CreateExportRequest request) Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.
DeleteExportResult	deleteExport(DeleteExportRequest request) Deletes an existing data export.
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.
GetExecutionResult	getExecution(GetExecutionRequest request) Exports data based on the source data update.
GetExportResult	getExport(GetExportRequest request) Views the definition of an existing data export.
GetTableResult	getTable(GetTableRequest request) Returns the metadata for the specified table and table properties.
ListExecutionsResult	listExecutions(ListExecutionsRequest request) Lists the historical executions for the export.
ListExportsResult	listExports(ListExportsRequest request) Lists all data export definitions.
ListTablesResult	listTables(ListTablesRequest request) Lists all available tables in data exports.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List tags associated with an existing data export.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) Adds tags for an existing data export definition.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes tags associated with an existing data export definition.
UpdateExportResult	updateExport(UpdateExportRequest request) Updates an existing data export by overwriting all export parameters.

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

Method Detail

builder

public static AWSBCMDataExportsClientBuilder builder()

createExport

public CreateExportResult createExport(CreateExportRequest request)

Creates a data export and specifies the data query, the delivery preference, and any optional resource tags.

A DataQuery consists of both a QueryStatement and TableConfigurations.

The QueryStatement is an SQL statement. Data Exports only supports a limited subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To view the available tables and columns, see the Data Exports table dictionary.

The TableConfigurations is a collection of specified TableProperties for the table being queried in the QueryStatement. TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. However, tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. For more information on table configurations, see Data query. To view the table properties available for each table, see the Data Exports table dictionary or use the ListTables API to get a response of all tables and their available properties.

Specified by:

createExport in interface AWSBCMDataExports

Parameters:

createExportRequest -

Returns:

Result of the CreateExport operation returned by the service.

Throws:

ServiceQuotaExceededException - You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

deleteExport

public DeleteExportResult deleteExport(DeleteExportRequest request)

Deletes an existing data export.

Specified by:

deleteExport in interface AWSBCMDataExports

Parameters:

deleteExportRequest -

Returns:

Result of the DeleteExport operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getExecution

public GetExecutionResult getExecution(GetExecutionRequest request)

Exports data based on the source data update.

Specified by:

getExecution in interface AWSBCMDataExports

Parameters:

getExecutionRequest -

Returns:

Result of the GetExecution operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getExport

public GetExportResult getExport(GetExportRequest request)

Views the definition of an existing data export.

Specified by:

getExport in interface AWSBCMDataExports

Parameters:

getExportRequest -

Returns:

Result of the GetExport operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

getTable

public GetTableResult getTable(GetTableRequest request)

Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.

Specified by:

getTable in interface AWSBCMDataExports

Parameters:

getTableRequest -

Returns:

Result of the GetTable operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listExecutions

public ListExecutionsResult listExecutions(ListExecutionsRequest request)

Lists the historical executions for the export.

Specified by:

listExecutions in interface AWSBCMDataExports

Parameters:

listExecutionsRequest -

Returns:

Result of the ListExecutions operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listExports

public ListExportsResult listExports(ListExportsRequest request)

Lists all data export definitions.

Specified by:

listExports in interface AWSBCMDataExports

Parameters:

listExportsRequest -

Returns:

Result of the ListExports operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listTables

public ListTablesResult listTables(ListTablesRequest request)

Lists all available tables in data exports.

Specified by:

listTables in interface AWSBCMDataExports

Parameters:

listTablesRequest -

Returns:

Result of the ListTables operation returned by the service.

Throws:

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

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List tags associated with an existing data export.

Specified by:

listTagsForResource in interface AWSBCMDataExports

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

Adds tags for an existing data export definition.

Specified by:

tagResource in interface AWSBCMDataExports

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes tags associated with an existing data export definition.

Specified by:

untagResource in interface AWSBCMDataExports

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services service.

See Also:

AWS API Documentation

updateExport

public UpdateExportResult updateExport(UpdateExportRequest request)

Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.

Specified by:

updateExport in interface AWSBCMDataExports

Parameters:

updateExportRequest -

Returns:

Result of the UpdateExport operation returned by the service.

Throws:

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

ResourceNotFoundException - The specified Amazon Resource Name (ARN) in the request doesn't exist.

ThrottlingException - The request was denied due to request throttling.

ValidationException - The input fails to satisfy the constraints specified by an Amazon Web Services 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 AWSBCMDataExports

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSBCMDataExports

Overrides:

shutdown in class AmazonWebServiceClient