data_set_export_tasks

Creates, updates, deletes, gets or lists a data_set_export_tasks resource.

Overview

Name	data_set_export_tasks
Type	Resource
Id	aws.m2.data_set_export_tasks

Fields

The following fields are returned by SELECT queries:

get_data_set_export_task

Name	Datatype	Description
kms_key_arn	string	The identifier of a customer managed key used for exported data set encryption.
status	string	The status of the task. (Creating, Running, Completed, Failed)
status_reason	string	If dataset export failed, the failure reason will show here.
summary	object	A summary of the status of the task.
task_id	string	The task identifier. (pattern: <code>^\S{1,80}$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_set_export_task	select	application_id, task_id, region		Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.
create_data_set_export_task	insert	application_id, region, exportConfig		Starts a data set export task for a specific application.

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
application_id	string	The unique identifier of the application for which you want to export data sets.
region	string	AWS region (default: us-east-1)
task_id	string	The task identifier returned by the CreateDataSetExportTask operation.

SELECT examples

get_data_set_export_task

Gets the status of a data set import task initiated with the CreateDataSetExportTask operation.

SELECT
kms_key_arn,
status,
status_reason,
summary,
task_id
FROM aws.m2.data_set_export_tasks
WHERE application_id = '{{ application_id }}' -- required
AND task_id = '{{ task_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_data_set_export_task

Starts a data set export task for a specific application.

INSERT INTO aws.m2.data_set_export_tasks (
clientToken,
exportConfig,
kmsKeyId,
application_id,
region
)
SELECT 
'{{ clientToken }}',
'{{ exportConfig }}' /* required */,
'{{ kmsKeyId }}',
'{{ application_id }}',
'{{ region }}'
RETURNING
task_id
;

Manifest

# Description fields are for documentation purposes
- name: data_set_export_tasks
props:
  - name: application_id
    value: "{{ application_id }}"
    description: Required parameter for the data_set_export_tasks resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the data_set_export_tasks resource.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A client token is a unique, case-sensitive string of up to 128 ASCII characters with ASCII values of 33-126 inclusive. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
  - name: exportConfig
    description: |
      Identifies one or more data sets you want to import with the CreateDataSetExportTask operation.
    value:
      dataSets:
        - datasetName: "{{ datasetName }}"
          externalLocation:
            s3Location: "{{ s3Location }}"
      s3Location: "{{ s3Location }}"
  - name: kmsKeyId
    value: "{{ kmsKeyId }}"