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
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.
Deletes an existing data export.
", "GetExecution": "Exports data based on the source data update.
", "GetExport": "Views the definition of an existing data export.
", "GetTable": "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.
", "ListExecutions": "Lists the historical executions for the export.
", "ListExports": "Lists all data export definitions.
", "ListTables": "Lists all available tables in data exports.
", "ListTagsForResource": "List tags associated with an existing data export.
", "TagResource": "Adds tags for an existing data export definition.
", "UntagResource": "Deletes tags associated with an existing data export definition.
", "UpdateExport": "Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.
" }, "shapes": { "Arn": { "base": null, "refs": { "CreateExportResponse$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "DeleteExportRequest$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "DeleteExportResponse$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "Export$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "ExportReference$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "GetExecutionRequest$ExportArn": "The Amazon Resource Name (ARN) of the Export object that generated this specific execution.
", "GetExportRequest$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "ListExecutionsRequest$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "ListTagsForResourceRequest$ResourceArn": "The unique identifier for the resource.
", "TagResourceRequest$ResourceArn": "The unique identifier for the resource.
", "UntagResourceRequest$ResourceArn": "The unique identifier for the resource.
", "UpdateExportRequest$ExportArn": "The Amazon Resource Name (ARN) for this export.
", "UpdateExportResponse$ExportArn": "The Amazon Resource Name (ARN) for this export.
" } }, "Column": { "base": "Includes basic information for a data column such as its description, name, and type.
", "refs": { "ColumnList$member": null } }, "ColumnList": { "base": null, "refs": { "GetTableResponse$Schema": "The schema of the table.
" } }, "CompressionOption": { "base": null, "refs": { "S3OutputConfigurations$Compression": "The compression type for the data export.
" } }, "CreateExportRequest": { "base": null, "refs": { } }, "CreateExportResponse": { "base": null, "refs": { } }, "DataQuery": { "base": "The SQL query of column selections and row filters from the data table you want.
", "refs": { "Export$DataQuery": "The data query for this specific data export.
" } }, "DeleteExportRequest": { "base": null, "refs": { } }, "DeleteExportResponse": { "base": null, "refs": { } }, "DestinationConfigurations": { "base": "The destinations used for data exports.
", "refs": { "Export$DestinationConfigurations": "The destination configuration for this specific data export.
" } }, "ExecutionReference": { "base": "The reference for the data export update.
", "refs": { "ExecutionReferenceList$member": null } }, "ExecutionReferenceList": { "base": null, "refs": { "ListExecutionsResponse$Executions": "The list of executions.
" } }, "ExecutionStatus": { "base": "The status of the execution.
", "refs": { "ExecutionReference$ExecutionStatus": "The status of this specific execution.
", "GetExecutionResponse$ExecutionStatus": "The status of this specific execution.
" } }, "ExecutionStatusCode": { "base": null, "refs": { "ExecutionStatus$StatusCode": "The code for the status of the execution.
" } }, "ExecutionStatusReason": { "base": null, "refs": { "ExecutionStatus$StatusReason": "The reason for the failed status.
", "ExportStatus$StatusReason": "The description for the status code.
" } }, "Export": { "base": "The details that are available for an export.
", "refs": { "CreateExportRequest$Export": "The details of the export, including data query, name, description, and destination configuration.
", "GetExecutionResponse$Export": "The export data for this specific execution. This export data is a snapshot from when the execution was generated. The data could be different from the current export data if the export was updated since the execution was generated.
", "GetExportResponse$Export": "The data for this specific export.
", "UpdateExportRequest$Export": "The name and query details for the export.
" } }, "ExportName": { "base": null, "refs": { "Export$Name": "The name of this specific data export.
", "ExportReference$ExportName": "The name of this specific data export.
" } }, "ExportReference": { "base": "The reference details for a given export.
", "refs": { "ExportReferenceList$member": null } }, "ExportReferenceList": { "base": null, "refs": { "ListExportsResponse$Exports": "The details of the exports, including name and export status.
" } }, "ExportStatus": { "base": "The status of the data export.
", "refs": { "ExportReference$ExportStatus": "The status of this specific data export.
", "GetExportResponse$ExportStatus": "The status of this specific export.
" } }, "ExportStatusCode": { "base": null, "refs": { "ExportStatus$StatusCode": "The status code for the request.
" } }, "FormatOption": { "base": null, "refs": { "S3OutputConfigurations$Format": "The file format for the data export.
" } }, "FrequencyOption": { "base": null, "refs": { "RefreshCadence$Frequency": "The frequency that data exports are updated. The export refreshes each time the source data updates, up to three times daily.
" } }, "GenericString": { "base": null, "refs": { "Column$Description": "The description for a column.
", "Column$Name": "The column name.
", "Column$Type": "The kind of data a column stores.
", "ExecutionReference$ExecutionId": "The ID for this specific execution.
", "Export$Description": "The description for this specific data export.
", "GenericStringList$member": null, "GetExecutionRequest$ExecutionId": "The ID for this specific execution.
", "GetExecutionResponse$ExecutionId": "The ID for this specific execution.
", "GetTableResponse$Description": "The table description.
", "InternalServerException$Message": null, "ResourceNotFoundException$Message": null, "ResourceNotFoundException$ResourceId": "The identifier of the resource that was not found.
", "ResourceNotFoundException$ResourceType": "The type of the resource that was not found.
", "S3Destination$S3Bucket": "The name of the Amazon S3 bucket used as the destination of a data export file.
", "S3Destination$S3Prefix": "The S3 path prefix you want prepended to the name of your data export.
", "S3Destination$S3Region": "The S3 bucket Region.
", "ServiceQuotaExceededException$Message": null, "ServiceQuotaExceededException$QuotaCode": "The quota code that was exceeded.
", "ServiceQuotaExceededException$ResourceId": "The identifier of the resource that exceeded quota.
", "ServiceQuotaExceededException$ResourceType": "The type of the resource that exceeded quota.
", "ServiceQuotaExceededException$ServiceCode": "The service code that exceeded quota. It will always be “AWSBillingAndCostManagementDataExports”.
", "Table$Description": "The description for the table.
", "TableProperties$value": null, "TablePropertyDescription$DefaultValue": "The default value for the table.
", "TablePropertyDescription$Description": "The description for the table.
", "TablePropertyDescription$Name": "The name of the table.
", "ThrottlingException$Message": null, "ThrottlingException$QuotaCode": "The quota code that exceeded the throttling limit.
", "ThrottlingException$ServiceCode": "The service code that exceeded the throttling limit. It will always be “AWSBillingAndCostManagementDataExports”.
", "ValidationException$Message": null, "ValidationExceptionField$Message": "A message with the reason for the validation exception error.
", "ValidationExceptionField$Name": "The field name where the invalid entry was detected.
" } }, "GenericStringList": { "base": null, "refs": { "TablePropertyDescription$ValidValues": "The valid values for the table.
" } }, "GetExecutionRequest": { "base": null, "refs": { } }, "GetExecutionResponse": { "base": null, "refs": { } }, "GetExportRequest": { "base": null, "refs": { } }, "GetExportResponse": { "base": null, "refs": { } }, "GetTableRequest": { "base": null, "refs": { } }, "GetTableResponse": { "base": null, "refs": { } }, "InternalServerException": { "base": "An error on the server occurred during the processing of your request. Try again later.
", "refs": { } }, "ListExecutionsRequest": { "base": null, "refs": { } }, "ListExecutionsResponse": { "base": null, "refs": { } }, "ListExportsRequest": { "base": null, "refs": { } }, "ListExportsResponse": { "base": null, "refs": { } }, "ListTablesRequest": { "base": null, "refs": { } }, "ListTablesResponse": { "base": null, "refs": { } }, "ListTagsForResourceRequest": { "base": null, "refs": { } }, "ListTagsForResourceResponse": { "base": null, "refs": { } }, "MaxResults": { "base": null, "refs": { "ListExecutionsRequest$MaxResults": "The maximum number of objects that are returned for the request.
", "ListExportsRequest$MaxResults": "The maximum number of objects that are returned for the request.
", "ListTablesRequest$MaxResults": "The maximum number of objects that are returned for the request.
", "ListTagsForResourceRequest$MaxResults": "The maximum number of objects that are returned for the request.
" } }, "NextPageToken": { "base": null, "refs": { "ListExecutionsRequest$NextToken": "The token to retrieve the next set of results.
", "ListExecutionsResponse$NextToken": "The token to retrieve the next set of results.
", "ListExportsRequest$NextToken": "The token to retrieve the next set of results.
", "ListExportsResponse$NextToken": "The token to retrieve the next set of results.
", "ListTablesRequest$NextToken": "The token to retrieve the next set of results.
", "ListTablesResponse$NextToken": "The token to retrieve the next set of results.
", "ListTagsForResourceRequest$NextToken": "The token to retrieve the next set of results.
", "ListTagsForResourceResponse$NextToken": "The token to retrieve the next set of results.
" } }, "OverwriteOption": { "base": null, "refs": { "S3OutputConfigurations$Overwrite": "The rule to follow when generating a version of the data export file. You have the choice to overwrite the previous version or to be delivered in addition to the previous versions. Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows you to track the changes in cost and usage data over time.
" } }, "QueryStatement": { "base": null, "refs": { "DataQuery$QueryStatement": "The query statement.
" } }, "RefreshCadence": { "base": "The cadence for Amazon Web Services to update the data export in your S3 bucket.
", "refs": { "Export$RefreshCadence": "The cadence for Amazon Web Services to update the export in your S3 bucket.
" } }, "ResourceNotFoundException": { "base": "The specified Amazon Resource Name (ARN) in the request doesn't exist.
", "refs": { } }, "ResourceTag": { "base": "The tag structure that contains a tag key and value.
", "refs": { "ResourceTagList$member": null } }, "ResourceTagKey": { "base": null, "refs": { "ResourceTag$Key": "The key that's associated with the tag.
", "ResourceTagKeyList$member": null } }, "ResourceTagKeyList": { "base": null, "refs": { "UntagResourceRequest$ResourceTagKeys": "The tag keys that are associated with the resource ARN.
" } }, "ResourceTagList": { "base": null, "refs": { "CreateExportRequest$ResourceTags": "An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.
", "ListTagsForResourceResponse$ResourceTags": "An optional list of tags to associate with the specified export. Each tag consists of a key and a value, and each key must be unique for the resource.
", "TagResourceRequest$ResourceTags": "The tags to associate with the resource. Each tag consists of a key and a value, and each key must be unique for the resource.
" } }, "ResourceTagValue": { "base": null, "refs": { "ResourceTag$Value": "The value that's associated with the tag.
" } }, "S3Destination": { "base": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a data exports file.
", "refs": { "DestinationConfigurations$S3Destination": "An object that describes the destination of the data exports file.
" } }, "S3OutputConfigurations": { "base": "The compression type, file format, and overwrite preference for the data export.
", "refs": { "S3Destination$S3OutputConfigurations": "The output configuration for the data export.
" } }, "S3OutputType": { "base": null, "refs": { "S3OutputConfigurations$OutputType": "The output type for the data export.
" } }, "ServiceQuotaExceededException": { "base": "You've reached the limit on the number of resources you can create, or exceeded the size of an individual resource.
", "refs": { } }, "SyntheticTimestamp_date_time": { "base": null, "refs": { "ExecutionStatus$CompletedAt": "The time when the execution was completed.
", "ExecutionStatus$CreatedAt": "The time when the execution was created.
", "ExecutionStatus$LastUpdatedAt": "The time when the execution was last updated.
", "ExportStatus$CreatedAt": "The timestamp of when the export was created.
", "ExportStatus$LastRefreshedAt": "The timestamp of when the export was last generated.
", "ExportStatus$LastUpdatedAt": "The timestamp of when the export was updated.
" } }, "Table": { "base": "The details for the data export table.
", "refs": { "TableList$member": null } }, "TableConfigurations": { "base": null, "refs": { "DataQuery$TableConfigurations": "The table configuration.
" } }, "TableList": { "base": null, "refs": { "ListTablesResponse$Tables": "The list of tables.
" } }, "TableName": { "base": null, "refs": { "GetTableRequest$TableName": "The name of the table.
", "GetTableResponse$TableName": "The name of the table.
", "Table$TableName": "The name of the table.
", "TableConfigurations$key": null } }, "TableProperties": { "base": null, "refs": { "GetTableRequest$TableProperties": "TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.
", "GetTableResponse$TableProperties": "TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified.
", "TableConfigurations$value": null } }, "TableProperty": { "base": null, "refs": { "TableProperties$key": null } }, "TablePropertyDescription": { "base": "The properties for the data export table.
", "refs": { "TablePropertyDescriptionList$member": null } }, "TablePropertyDescriptionList": { "base": null, "refs": { "Table$TableProperties": "The properties for the table.
" } }, "TagResourceRequest": { "base": null, "refs": { } }, "TagResourceResponse": { "base": null, "refs": { } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "UntagResourceRequest": { "base": null, "refs": { } }, "UntagResourceResponse": { "base": null, "refs": { } }, "UpdateExportRequest": { "base": null, "refs": { } }, "UpdateExportResponse": { "base": null, "refs": { } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "refs": { } }, "ValidationExceptionField": { "base": "The input failed to meet the constraints specified by the Amazon Web Services service in a specified field.
", "refs": { "ValidationExceptionFieldList$member": null } }, "ValidationExceptionFieldList": { "base": null, "refs": { "ValidationException$Fields": "The list of fields that are invalid.
" } }, "ValidationExceptionReason": { "base": null, "refs": { "ValidationException$Reason": "The reason for the validation exception.
" } } } }