BCMDataExportsClient

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

Installation

NPM
npm install @aws-sdk/client-bcm-data-exports
Yarn
yarn add @aws-sdk/client-bcm-data-exports
pnpm
pnpm add @aws-sdk/client-bcm-data-exports

BCMDataExportsClient Operations

Command
Summary
CreateExportCommand

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.

DeleteExportCommand

Deletes an existing data export.

GetExecutionCommand

Exports data based on the source data update.

GetExportCommand

Views the definition of an existing data export.

GetTableCommand

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.

ListExecutionsCommand

Lists the historical executions for the export.

ListExportsCommand

Lists all data export definitions.

ListTablesCommand

Lists all available tables in data exports.

ListTagsForResourceCommand

List tags associated with an existing data export.

TagResourceCommand

Adds tags for an existing data export definition.

UntagResourceCommand

Deletes tags associated with an existing data export definition.

UpdateExportCommand

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

BCMDataExportsClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: BCMDataExportsClientConfig