ForecastService / Paginator / ListDatasetGroups

ListDatasetGroups#

class ForecastService.Paginator.ListDatasetGroups#
paginator = client.get_paginator('list_dataset_groups')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ForecastService.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': [
        {
            'DatasetGroupArn': 'string',
            'DatasetGroupName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

  • (dict) –

    • DatasetGroups (list) –

      An array of objects that summarize each dataset group’s properties.

      • (dict) –

        Provides a summary of the dataset group properties used in the ListDatasetGroups operation. To get the complete set of properties, call the DescribeDatasetGroup operation, and provide the DatasetGroupArn .

        • DatasetGroupArn (string) –

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

        • DatasetGroupName (string) –

          The name of the dataset group.

        • CreationTime (datetime) –

          When the dataset group was created.

        • LastModificationTime (datetime) –

          When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated, LastModificationTime is the current time of the ListDatasetGroups call.