Bcm Data Exports

create_export(export)
create_export(export, params::Dict{String,<:Any})

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.

Arguments

• export: The details of the export, including data query, name, description, and destination configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.

delete_export(export_arn)
delete_export(export_arn, params::Dict{String,<:Any})

Deletes an existing data export.

Arguments

• export_arn: The Amazon Resource Name (ARN) for this export.

get_execution(execution_id, export_arn)
get_execution(execution_id, export_arn, params::Dict{String,<:Any})

Exports data based on the source data update.

Arguments

• execution_id: The ID for this specific execution.
• export_arn: The Amazon Resource Name (ARN) of the Export object that generated this specific execution.

get_export(export_arn)
get_export(export_arn, params::Dict{String,<:Any})

Views the definition of an existing data export.

Arguments

• export_arn: The Amazon Resource Name (ARN) for this export.

get_table(table_name)
get_table(table_name, params::Dict{String,<:Any})

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.

Arguments

• table_name: The name of the table.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "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.

list_executions(export_arn)
list_executions(export_arn, params::Dict{String,<:Any})

Lists the historical executions for the export.

Arguments

• export_arn: The Amazon Resource Name (ARN) for this export.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that are returned for the request.
• "NextToken": The token to retrieve the next set of results.

list_exports()
list_exports(params::Dict{String,<:Any})

Lists all data export definitions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that are returned for the request.
• "NextToken": The token to retrieve the next set of results.

list_tables()
list_tables(params::Dict{String,<:Any})

Lists all available tables in data exports.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that are returned for the request.
• "NextToken": The token to retrieve the next set of results.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

List tags associated with an existing data export.

Arguments

• resource_arn: The unique identifier for the resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of objects that are returned for the request.
• "NextToken": The token to retrieve the next set of results.

tag_resource(resource_arn, resource_tags)
tag_resource(resource_arn, resource_tags, params::Dict{String,<:Any})

Adds tags for an existing data export definition.

Arguments

• resource_arn: The unique identifier for the resource.
• resource_tags: 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.

untag_resource(resource_arn, resource_tag_keys)
untag_resource(resource_arn, resource_tag_keys, params::Dict{String,<:Any})

Deletes tags associated with an existing data export definition.

Arguments

• resource_arn: The unique identifier for the resource.
• resource_tag_keys: The tag keys that are associated with the resource ARN.

update_export(export, export_arn)
update_export(export, export_arn, params::Dict{String,<:Any})

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

Arguments

• export: The name and query details for the export.
• export_arn: The Amazon Resource Name (ARN) for this export.