Personalize / Paginator / ListDatasetImportJobs

ListDatasetImportJobs#

class Personalize.Paginator.ListDatasetImportJobs#
paginator = client.get_paginator('list_dataset_import_jobs')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from Personalize.Client.list_dataset_import_jobs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • datasetArn (string) – The Amazon Resource Name (ARN) of the dataset to list the dataset import jobs for.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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 to resume pagination.