BCMDataExports

import { BCMDataExports } from "https://aws-api-bqtgftz736ft.deno.dev/v0.5/services/bcmdataexports.ts?docs=full";

class BCMDataExports {

constructor(apiFactory: client.ApiFactory);

async createExport(params: CreateExportRequest, opts?: client.RequestOptions): Promise<CreateExportResponse>;

async deleteExport(params: DeleteExportRequest, opts?: client.RequestOptions): Promise<DeleteExportResponse>;

async getExecution(params: GetExecutionRequest, opts?: client.RequestOptions): Promise<GetExecutionResponse>;

async getExport(params: GetExportRequest, opts?: client.RequestOptions): Promise<GetExportResponse>;

async getTable(params: GetTableRequest, opts?: client.RequestOptions): Promise<GetTableResponse>;

async listExecutions(params: ListExecutionsRequest, opts?: client.RequestOptions): Promise<ListExecutionsResponse>;

async listExports(params?: ListExportsRequest, opts?: client.RequestOptions): Promise<ListExportsResponse>;

async listTables(params?: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResponse>;

async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;

async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;

async updateExport(params: UpdateExportRequest, opts?: client.RequestOptions): Promise<UpdateExportResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new BCMDataExports(apiFactory: client.ApiFactory)

[src]

§Methods

createExport(params: CreateExportRequest, opts?: client.RequestOptions): Promise<CreateExportResponse>

[src]

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: DeleteExportRequest, opts?: client.RequestOptions): Promise<DeleteExportResponse>

[src]

Deletes an existing data export.

getExecution(params: GetExecutionRequest, opts?: client.RequestOptions): Promise<GetExecutionResponse>

[src]

Exports data based on the source data update.

getExport(params: GetExportRequest, opts?: client.RequestOptions): Promise<GetExportResponse>

[src]

Views the definition of an existing data export.

getTable(params: GetTableRequest, opts?: client.RequestOptions): Promise<GetTableResponse>

[src]

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: ListExecutionsRequest, opts?: client.RequestOptions): Promise<ListExecutionsResponse>

[src]

Lists the historical executions for the export.

listExports(params?: ListExportsRequest, opts?: client.RequestOptions): Promise<ListExportsResponse>

[src]

Lists all data export definitions.

listTables(params?: ListTablesRequest, opts?: client.RequestOptions): Promise<ListTablesResponse>

[src]

Lists all available tables in data exports.

listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>

[src]

List tags associated with an existing data export.

tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Adds tags for an existing data export definition.

untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>

[src]

Deletes tags associated with an existing data export definition.

updateExport(params: UpdateExportRequest, opts?: client.RequestOptions): Promise<UpdateExportResponse>

[src]

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

§Static Properties

ApiMetadata: client.ApiMetadata

[src]