:doc:`IoTAnalytics <../../iotanalytics>` / Client / list_dataset_contents

*********************
list_dataset_contents
*********************



.. py:method:: IoTAnalytics.Client.list_dataset_contents(**kwargs)

  

  Lists information about dataset contents that have been created.

  

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


  **Request Syntax**
  ::

    response = client.list_dataset_contents(
        datasetName='string',
        nextToken='string',
        maxResults=123,
        scheduledOnOrAfter=datetime(2015, 1, 1),
        scheduledBefore=datetime(2015, 1, 1)
    )
    
  :type datasetName: string
  :param datasetName: **[REQUIRED]** 

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

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in this request.

    

  
  :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)

    

  
  
  :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) --* 

        The token to retrieve the next set of results, or ``null`` if there are no more results.

        
  
  **Exceptions**
  
  *   :py:class:`IoTAnalytics.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTAnalytics.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTAnalytics.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`IoTAnalytics.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoTAnalytics.Client.exceptions.ResourceNotFoundException`

  