Personalize / Paginator / ListDatasetExportJobs

ListDatasetExportJobs

class Personalize.Paginator.ListDatasetExportJobs

paginator = client.get_paginator('list_dataset_export_jobs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Personalize.Client.list_dataset_export_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 export 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

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