:doc:`IoTSiteWise <../../iotsitewise>` / Paginator / ListDatasets

************
ListDatasets
************



.. py:class:: IoTSiteWise.Paginator.ListDatasets

  ::

    
    paginator = client.get_paginator('list_datasets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IoTSiteWise.Client.list_datasets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotsitewise-2019-12-02/ListDatasets>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          sourceType='KENDRA',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type sourceType: string
    :param sourceType: **[REQUIRED]** 

      The type of data source for the dataset.

      

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

      
      ::

        {
            'datasetSummaries': [
                {
                    'id': 'string',
                    'arn': 'string',
                    'name': 'string',
                    'description': 'string',
                    'creationDate': datetime(2015, 1, 1),
                    'lastUpdateDate': datetime(2015, 1, 1),
                    'status': {
                        'state': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'FAILED',
                        'error': {
                            'code': 'VALIDATION_ERROR'|'INTERNAL_FAILURE',
                            'message': 'string',
                            'details': [
                                {
                                    'code': 'INCOMPATIBLE_COMPUTE_LOCATION'|'INCOMPATIBLE_FORWARDING_CONFIGURATION',
                                    'message': 'string'
                                },
                            ]
                        }
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **datasetSummaries** *(list) --* 

          A list that summarizes the dataset response.

          
          

          - *(dict) --* 

            The summary details for the dataset.

            
            

            - **id** *(string) --* 

              The ID of the dataset.

              
            

            - **arn** *(string) --* 

              The `ARN <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`__ of the dataset. The format is ``arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId}``.

              
            

            - **name** *(string) --* 

              The name of the dataset.

              
            

            - **description** *(string) --* 

              A description about the dataset, and its functionality.

              
            

            - **creationDate** *(datetime) --* 

              The dataset creation date, in Unix epoch time.

              
            

            - **lastUpdateDate** *(datetime) --* 

              The date the dataset was last updated, in Unix epoch time.

              
            

            - **status** *(dict) --* 

              The status of the dataset. This contains the state and any error messages. The state is ``ACTIVE`` when ready to use.

              
              

              - **state** *(string) --* 

                The current status of the dataset.

                
              

              - **error** *(dict) --* 

                Contains the details of an IoT SiteWise error.

                
                

                - **code** *(string) --* 

                  The error code.

                  
                

                - **message** *(string) --* 

                  The error message.

                  
                

                - **details** *(list) --* 

                  A list of detailed errors.

                  
                  

                  - *(dict) --* 

                    Contains detailed error information.

                    
                    

                    - **code** *(string) --* 

                      The error code.

                      
                    

                    - **message** *(string) --* 

                      The error message.

                      
                
              
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    