:doc:`IoTAnalytics <../../iotanalytics>` / Paginator / ListDatasetContents

*******************
ListDatasetContents
*******************



.. py:class:: IoTAnalytics.Paginator.ListDatasetContents

  ::

    
    paginator = client.get_paginator('list_dataset_contents')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoTAnalytics.Client.list_dataset_contents`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListDatasetContents>`_    


    **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'
          }
      )
      
    :type datasetName: string
    :param datasetName: **[REQUIRED]** 

      The name of the dataset whose contents information you want to list.

      

    
    :type scheduledOnOrAfter: datetime
    :param scheduledOnOrAfter: 

      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)

      

    
    :type scheduledBefore: datetime
    :param scheduledBefore: 

      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)

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

          
    