AWS.BCMDataExports — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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:

Sending a Request Using BCMDataExports

var bcmdataexports = new AWS.BCMDataExports();
bcmdataexports.createExport(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the BCMDataExports object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var bcmdataexports = new AWS.BCMDataExports({apiVersion: '2023-11-26'});

You can also set the API version globally in AWS.config.apiVersions using the bcmdataexports service identifier:

AWS.config.apiVersions = {
  bcmdataexports: '2023-11-26',
  // other service API versions
};

var bcmdataexports = new AWS.BCMDataExports();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.BCMDataExports(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Property Details

endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

Method Details

createExport(params = {}, callback) ⇒ AWS.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.

deleteExport(params = {}, callback) ⇒ AWS.Request

Deletes an existing data export.

getExecution(params = {}, callback) ⇒ AWS.Request

Exports data based on the source data update.

getExport(params = {}, callback) ⇒ AWS.Request

Views the definition of an existing data export.

getTable(params = {}, callback) ⇒ AWS.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.

listExecutions(params = {}, callback) ⇒ AWS.Request

Lists the historical executions for the export.

listExports(params = {}, callback) ⇒ AWS.Request

Lists all data export definitions.

listTables(params = {}, callback) ⇒ AWS.Request

Lists all available tables in data exports.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

List tags associated with an existing data export.

tagResource(params = {}, callback) ⇒ AWS.Request

Adds tags for an existing data export definition.

untagResource(params = {}, callback) ⇒ AWS.Request

Deletes tags associated with an existing data export definition.

updateExport(params = {}, callback) ⇒ AWS.Request

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