ForecastService / Paginator / ListDatasets

ListDatasets

class ForecastService.Paginator.ListDatasets

paginator = client.get_paginator('list_datasets')

paginate(**kwargs)

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

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

{
    'Datasets': [
        {
            'DatasetArn': 'string',
            'DatasetName': 'string',
            'DatasetType': 'TARGET_TIME_SERIES'|'RELATED_TIME_SERIES'|'ITEM_METADATA',
            'Domain': 'RETAIL'|'CUSTOM'|'INVENTORY_PLANNING'|'EC2_CAPACITY'|'WORK_FORCE'|'WEB_TRAFFIC'|'METRICS',
            'CreationTime': datetime(2015, 1, 1),
            'LastModificationTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • Datasets (list) –

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

    • (dict) –

      Provides a summary of the dataset properties used in the ListDatasets operation. To get the complete set of properties, call the DescribeDataset operation, and provide the DatasetArn.

      • DatasetArn (string) –

        The Amazon Resource Name (ARN) of the dataset.

      • DatasetName (string) –

        The name of the dataset.

      • DatasetType (string) –

        The dataset type.

      • Domain (string) –

        The domain associated with the dataset.

      • CreationTime (datetime) –

        When the dataset was created.

      • LastModificationTime (datetime) –

        When you create a dataset, LastModificationTime is the same as CreationTime. While data is being imported to the dataset, LastModificationTime is the current time of the ListDatasets call. After a CreateDatasetImportJob operation has finished, LastModificationTime is when the import job completed or failed.