:doc:`LookoutEquipment <../../lookoutequipment>` / Client / list_datasets

*************
list_datasets
*************



.. py:method:: LookoutEquipment.Client.list_datasets(**kwargs)

  

  Lists all datasets currently available in your account, filtering on the dataset name.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/lookoutequipment-2020-12-15/ListDatasets>`_  


  **Request Syntax**
  ::

    response = client.list_datasets(
        NextToken='string',
        MaxResults=123,
        DatasetNameBeginsWith='string'
    )
    
  :type NextToken: string
  :param NextToken: 

    An opaque pagination token indicating where to continue the listing of datasets.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    Specifies the maximum number of datasets to list.

    

  
  :type DatasetNameBeginsWith: string
  :param DatasetNameBeginsWith: 

    The beginning of the name of the datasets to be listed.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'NextToken': 'string',
          'DatasetSummaries': [
              {
                  'DatasetName': 'string',
                  'DatasetArn': 'string',
                  'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE'|'IMPORT_IN_PROGRESS',
                  'CreatedAt': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        An opaque pagination token indicating where to continue the listing of datasets.

        
      

      - **DatasetSummaries** *(list) --* 

        Provides information about the specified dataset, including creation time, dataset ARN, and status.

        
        

        - *(dict) --* 

          Contains information about the specific data set, including name, ARN, and status.

          
          

          - **DatasetName** *(string) --* 

            The name of the dataset.

            
          

          - **DatasetArn** *(string) --* 

            The Amazon Resource Name (ARN) of the specified dataset.

            
          

          - **Status** *(string) --* 

            Indicates the status of the dataset.

            
          

          - **CreatedAt** *(datetime) --* 

            The time at which the dataset was created in Amazon Lookout for Equipment.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`LookoutEquipment.Client.exceptions.ValidationException`

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

  
  *   :py:class:`LookoutEquipment.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`LookoutEquipment.Client.exceptions.InternalServerException`

  