MainframeModernization / Client / create_data_set_export_task

create_data_set_export_task

MainframeModernization.Client.create_data_set_export_task(**kwargs)

Starts a data set export task for a specific application.

See also: AWS API Documentation

Request Syntax

response = client.create_data_set_export_task(
    applicationId='string',
    clientToken='string',
    exportConfig={
        'dataSets': [
            {
                'datasetName': 'string',
                'externalLocation': {
                    's3Location': 'string'
                }
            },
        ],
        's3Location': 'string'
    },
    kmsKeyId='string'
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The unique identifier of the application for which you want to export data sets.

  • clientToken (string) –

    Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create a data set export. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

    This field is autopopulated if not provided.

  • exportConfig (dict) –

    [REQUIRED]

    The data set export task configuration.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: dataSets, s3Location.

    • dataSets (list) –

      The data sets.

      • (dict) –

        Identifies a specific data set to export from an external location.

        • datasetName (string) – [REQUIRED]

          The data set.

        • externalLocation (dict) – [REQUIRED]

          The location of the data set.

          Note

          This is a Tagged Union structure. Only one of the following top level keys can be set: s3Location.

          • s3Location (string) –

            The URI of the Amazon S3 bucket.

    • s3Location (string) –

      The Amazon S3 location of the data sets.

  • kmsKeyId (string) – The identifier of a customer managed key.

Return type:

dict

Returns:

Response Syntax

{
    'taskId': 'string'
}

Response Structure

  • (dict) –

    • taskId (string) –

      The task identifier. This operation is asynchronous. Use this identifier with the GetDataSetExportTask operation to obtain the status of this task.

Exceptions