Personalize / Paginator / ListDatasets

ListDatasets

class Personalize.Paginator.ListDatasets

paginator = client.get_paginator('list_datasets')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetGroupArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• datasetGroupArn (string) – The Amazon Resource Name (ARN) of the dataset group that contains the datasets to list.

• 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

{
    'datasets': [
        {
            'name': 'string',
            'datasetArn': 'string',
            'datasetType': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • datasets (list) –

    An array of Dataset objects. Each object provides metadata information.

    • (dict) –

      Provides a summary of the properties of a dataset. For a complete listing, call the DescribeDataset API.

      • name (string) –

        The name of the dataset.

      • datasetArn (string) –

        The Amazon Resource Name (ARN) of the dataset.

      • datasetType (string) –

        The dataset type. One of the following values:

        • Interactions

        • Items

        • Users

        • Event-Interactions

      • status (string) –

        The status of the dataset.

        A dataset can be in one of the following states:

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

        • DELETE PENDING > DELETE IN_PROGRESS

      • creationDateTime (datetime) –

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

      • lastUpdatedDateTime (datetime) –

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

  • NextToken (string) –

    A token to resume pagination.