IoTAnalytics / Paginator / ListDatasets

ListDatasets#

class IoTAnalytics.Paginator.ListDatasets#

paginator = client.get_paginator('list_datasets')

paginate(**kwargs)#

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

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

{
    'datasetSummaries': [
        {
            'datasetName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdateTime': datetime(2015, 1, 1),
            'triggers': [
                {
                    'schedule': {
                        'expression': 'string'
                    },
                    'dataset': {
                        'name': 'string'
                    }
                },
            ],
            'actions': [
                {
                    'actionName': 'string',
                    'actionType': 'QUERY'|'CONTAINER'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- datasetSummaries (list) –
  
  A list of DatasetSummary objects.
  - (dict) –
    
    A summary of information about a dataset.
    - datasetName (string) –
      
      The name of the dataset.
    - status (string) –
      
      The status of the dataset.
    - creationTime (datetime) –
      
      The time the dataset was created.
    - lastUpdateTime (datetime) –
      
      The last time the dataset was updated.
    - triggers (list) –
      
      A list of triggers. A trigger causes dataset content to be populated at a specified time interval or when another dataset is populated. The list of triggers can be empty or contain up to five DataSetTrigger objects
      - (dict) –
        
        The DatasetTrigger that specifies when the dataset is automatically updated.
        
        schedule (dict) –
        
        The Schedule when the trigger is initiated.
        
        expression (string) –
        
        The expression that defines when to trigger an update. For more information, see Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.
        
        dataset (dict) –
        
        The dataset whose content creation triggers the creation of this dataset’s contents.
        
        name (string) –
        
        The name of the dataset whose content generation triggers the new dataset content generation.
    - actions (list) –
      
      A list of DataActionSummary objects.
      - (dict) –
        
        Information about the action that automatically creates the dataset’s contents.
        
        actionName (string) –
        
        The name of the action that automatically creates the dataset’s contents.
        
        actionType (string) –
        
        The type of action by which the dataset’s contents are automatically created.
- NextToken (string) –
  
  A token to resume pagination.