Personalize / Client / list_dataset_import_jobs

list_dataset_import_jobs#

Personalize.Client.list_dataset_import_jobs(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

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

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

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

Return type:

dict

Returns:

Response Syntax

{
    'datasetImportJobs': [
        {
            'datasetImportJobArn': 'string',
            'jobName': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string',
            'importMode': 'FULL'|'INCREMENTAL'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • datasetImportJobs (list) –

      The list of dataset import jobs.

      • (dict) –

        Provides a summary of the properties of a dataset import job. For a complete listing, call the DescribeDatasetImportJob API.

        • datasetImportJobArn (string) –

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

        • jobName (string) –

          The name of the dataset import job.

        • status (string) –

          The status of the dataset import job.

          A dataset import 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 import job was created.

        • lastUpdatedDateTime (datetime) –

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

        • failureReason (string) –

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

        • importMode (string) –

          The import mode the dataset import job used to update the data in the dataset. For more information see Updating existing bulk data.

    • nextToken (string) –

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

Exceptions

  • Personalize.Client.exceptions.InvalidInputException

  • Personalize.Client.exceptions.InvalidNextTokenException