LookoutEquipment / Client / list_datasets

list_datasets#

LookoutEquipment.Client.list_datasets(**kwargs)#

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

Request Syntax

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

Parameters:

NextToken (string) – An opaque pagination token indicating where to continue the listing of datasets.
MaxResults (integer) – Specifies the maximum number of datasets to list.
DatasetNameBeginsWith (string) – The beginning of the name of the datasets to be listed.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'DatasetSummaries': [
        {
            'DatasetName': 'string',
            'DatasetArn': 'string',
            'Status': 'CREATED'|'INGESTION_IN_PROGRESS'|'ACTIVE',
            '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

LookoutEquipment.Client.exceptions.ValidationException
LookoutEquipment.Client.exceptions.ThrottlingException
LookoutEquipment.Client.exceptions.AccessDeniedException
LookoutEquipment.Client.exceptions.InternalServerException