exports

Creates, updates, deletes, gets or lists an exports resource.

Overview

Name	exports
Type	Resource
Id	aws.bcm_data_exports.exports

Fields

The following fields are returned by SELECT queries:

get_export

Name	Datatype	Description
export	object	The data for this specific export.
export_status	object	The status of this specific export.

list_exports

Name	Datatype	Description
export_arn	string	The Amazon Resource Name (ARN) for this export. (pattern: <code>arn:aws[-a-z0-9]:(bcm-data-exports):[-a-z0-9]:[0-9]{12}:[-a-zA-Z0-9/:_]+</code>)
export_name	string	The name of this specific data export. (pattern: <code>[0-9A-Za-z-_]+</code>)
export_status	object	The status of this specific data export.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_export	select	region		Views the definition of an existing data export.
list_exports	select	region		Lists all data export definitions.
create_export	insert	region		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.
update_export	update	region, ExportArn		Updates an existing data export by overwriting all export parameters. All export parameters must be provided in the UpdateExport request.
delete_export	delete	region		Deletes an existing data export.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_export

Views the definition of an existing data export.

SELECT
export,
export_status
FROM aws.bcm_data_exports.exports
WHERE region = '{{ region }}' -- required
;

list_exports

Lists all data export definitions.

SELECT
export_arn,
export_name,
export_status
FROM aws.bcm_data_exports.exports
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_export

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.

INSERT INTO aws.bcm_data_exports.exports (
Export,
ResourceTags,
region
)
SELECT 
'{{ Export }}',
'{{ ResourceTags }}',
'{{ region }}'
RETURNING
export_arn
;

Manifest

# Description fields are for documentation purposes
- name: exports
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the exports resource.
  - name: Export
    description: |
      The details of the export, including data query, name, description, and destination configuration.
    value:
      ExportArn: "{{ ExportArn }}"
      Name: "{{ Name }}"
      Description: "{{ Description }}"
      DataQuery:
        QueryStatement: "{{ QueryStatement }}"
        TableConfigurations: "{{ TableConfigurations }}"
      DestinationConfigurations:
        S3Destination:
          S3Bucket: "{{ S3Bucket }}"
          S3BucketOwner: "{{ S3BucketOwner }}"
          S3Prefix: "{{ S3Prefix }}"
          S3Region: "{{ S3Region }}"
          S3OutputConfigurations:
            OutputType: "{{ OutputType }}"
            Format: "{{ Format }}"
            Compression: "{{ Compression }}"
            Overwrite: "{{ Overwrite }}"
      RefreshCadence:
        Frequency: "{{ Frequency }}"
  - name: ResourceTags
    description: |
      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.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_export

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

UPDATE aws.bcm_data_exports.exports
SET 
ExportArn = '{{ ExportArn }}',
Export = '{{ Export }}'
WHERE 
region = '{{ region }}' --required
AND ExportArn = '{{ ExportArn }}' --required
RETURNING
export_arn;

DELETE examples

delete_export

Deletes an existing data export.

DELETE FROM aws.bcm_data_exports.exports
WHERE region = '{{ region }}' --required
;