ListDatasetContents¶

class IoTAnalytics.Paginator.ListDatasetContents¶

paginator = client.get_paginator('list_dataset_contents')

paginate(**kwargs)¶

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    datasetName='string',
    scheduledOnOrAfter=datetime(2015, 1, 1),
    scheduledBefore=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters

datasetName (string) --
[REQUIRED]

The name of the dataset whose contents information you want to list.
scheduledOnOrAfter (datetime) -- A filter to limit results to those dataset contents whose creation is scheduled on or after the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
scheduledBefore (datetime) -- A filter to limit results to those dataset contents whose creation is scheduled before the given time. See the field triggers.schedule in the CreateDataset request. (timestamp)
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

{
    'datasetContentSummaries': [
        {
            'version': 'string',
            'status': {
                'state': 'CREATING'|'SUCCEEDED'|'FAILED',
                'reason': 'string'
            },
            'creationTime': datetime(2015, 1, 1),
            'scheduleTime': datetime(2015, 1, 1),
            'completionTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- datasetContentSummaries (list) --
  
  Summary information about dataset contents that have been created.
  - (dict) --
    
    Summary information about dataset contents.
    - version (string) --
      
      The version of the dataset contents.
    - status (dict) --
      
      The status of the dataset contents.
      - state (string) --
        
        The state of the dataset contents. Can be one of READY, CREATING, SUCCEEDED, or FAILED.
      - reason (string) --
        
        The reason the dataset contents are in this state.
    - creationTime (datetime) --
      
      The actual time the creation of the dataset contents was started.
    - scheduleTime (datetime) --
      
      The time the creation of the dataset contents was scheduled to start.
    - completionTime (datetime) --
      
      The time the dataset content status was updated to SUCCEEDED or FAILED.
- NextToken (string) --
  
  A token to resume pagination.

Table Of Contents

ListDatasetContents¶