Personalize / Paginator / ListDatasetGroups

ListDatasetGroups

class Personalize.Paginator.ListDatasetGroups

paginator = client.get_paginator('list_dataset_groups')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'datasetGroups': [
        {
            'name': 'string',
            'datasetGroupArn': 'string',
            'status': 'string',
            'creationDateTime': datetime(2015, 1, 1),
            'lastUpdatedDateTime': datetime(2015, 1, 1),
            'failureReason': 'string',
            'domain': 'ECOMMERCE'|'VIDEO_ON_DEMAND'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • datasetGroups (list) –

    The list of your dataset groups.

    • (dict) –

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

      • name (string) –

        The name of the dataset group.

      • datasetGroupArn (string) –

        The Amazon Resource Name (ARN) of the dataset group.

      • status (string) –

        The status of the dataset group.

        A dataset group can be in one of the following states:

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

        • DELETE PENDING

      • creationDateTime (datetime) –

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

      • lastUpdatedDateTime (datetime) –

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

      • failureReason (string) –

        If creating a dataset group fails, the reason behind the failure.

      • domain (string) –

        The domain of a Domain dataset group.

  • NextToken (string) –

    A token to resume pagination.