Personalize / Client / list_dataset_export_jobs

list_dataset_export_jobs#

Personalize.Client.list_dataset_export_jobs(**kwargs)#

Returns a list of dataset export jobs that use the given dataset. When a dataset is not specified, all the dataset export jobs associated with the account are listed. The response provides the properties for each dataset export job, including the Amazon Resource Name (ARN). For more information on dataset export jobs, see CreateDatasetExportJob. For more information on datasets, see CreateDataset.

See also: AWS API Documentation

Request Syntax

response = client.list_dataset_export_jobs(
    datasetArn='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • datasetArn (string) – The Amazon Resource Name (ARN) of the dataset to list the dataset export jobs for.

  • nextToken (string) – A token returned from the previous call to ListDatasetExportJobs for getting the next set of dataset export jobs (if they exist).

  • maxResults (integer) – The maximum number of dataset export jobs to return.

Return type:

dict

Returns:

Response Syntax

{
    'datasetExportJobs': [
        {
            'datasetExportJobArn': 'string',
            'jobName': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • datasetExportJobs (list) –

      The list of dataset export jobs.

      • (dict) –

        Provides a summary of the properties of a dataset export job. For a complete listing, call the DescribeDatasetExportJob API.

        • datasetExportJobArn (string) –

          The Amazon Resource Name (ARN) of the dataset export job.

        • jobName (string) –

          The name of the dataset export job.

        • status (string) –

          The status of the dataset export job.

          A dataset export job can be in one of the following states:

          • CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED

        • creationDateTime (datetime) –

          The date and time (in Unix time) that the dataset export job was created.

        • lastUpdatedDateTime (datetime) –

          The date and time (in Unix time) that the dataset export job status was last updated.

        • failureReason (string) –

          If a dataset export job fails, the reason behind the failure.

    • nextToken (string) –

      A token for getting the next set of dataset export jobs (if they exist).

Exceptions