list_models#

LookoutEquipment.Client.list_models(**kwargs)#

Generates a list of all models in the account, including model name and ARN, dataset, and status.

Request Syntax

response = client.list_models(
    NextToken='string',
    MaxResults=123,
    Status='IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS',
    ModelNameBeginsWith='string',
    DatasetNameBeginsWith='string'
)

Parameters:

NextToken (string) – An opaque pagination token indicating where to continue the listing of machine learning models.
MaxResults (integer) – Specifies the maximum number of machine learning models to list.
Status (string) – The status of the machine learning model.
ModelNameBeginsWith (string) – The beginning of the name of the machine learning models being listed.
DatasetNameBeginsWith (string) – The beginning of the name of the dataset of the machine learning models to be listed.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ModelSummaries': [
        {
            'ModelName': 'string',
            'ModelArn': 'string',
            'DatasetName': 'string',
            'DatasetArn': 'string',
            'Status': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS',
            'CreatedAt': datetime(2015, 1, 1),
            'ActiveModelVersion': 123,
            'ActiveModelVersionArn': 'string',
            'LatestScheduledRetrainingStatus': 'IN_PROGRESS'|'SUCCESS'|'FAILED'|'IMPORT_IN_PROGRESS'|'CANCELED',
            'LatestScheduledRetrainingModelVersion': 123,
            'LatestScheduledRetrainingStartTime': datetime(2015, 1, 1),
            'NextScheduledRetrainingStartDate': datetime(2015, 1, 1),
            'RetrainingSchedulerStatus': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  An opaque pagination token indicating where to continue the listing of machine learning models.
- ModelSummaries (list) –
  
  Provides information on the specified model, including created time, model and dataset ARNs, and status.
  - (dict) –
    
    Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status.
    - ModelName (string) –
      
      The name of the machine learning model.
    - ModelArn (string) –
      
      The Amazon Resource Name (ARN) of the machine learning model.
    - DatasetName (string) –
      
      The name of the dataset being used for the machine learning model.
    - DatasetArn (string) –
      
      The Amazon Resource Name (ARN) of the dataset used to create the model.
    - Status (string) –
      
      Indicates the status of the machine learning model.
    - CreatedAt (datetime) –
      
      The time at which the specific model was created.
    - ActiveModelVersion (integer) –
      
      The model version that the inference scheduler uses to run an inference execution.
    - ActiveModelVersionArn (string) –
      
      The Amazon Resource Name (ARN) of the model version that is set as active. The active model version is the model version that the inference scheduler uses to run an inference execution.
    - LatestScheduledRetrainingStatus (string) –
      
      Indicates the status of the most recent scheduled retraining run.
    - LatestScheduledRetrainingModelVersion (integer) –
      
      Indicates the most recent model version that was generated by retraining.
    - LatestScheduledRetrainingStartTime (datetime) –
      
      Indicates the start time of the most recent scheduled retraining run.
    - NextScheduledRetrainingStartDate (datetime) –
      
      Indicates the date that the next scheduled retraining run will start on. Lookout for Equipment truncates the time you provide to the nearest UTC day.
    - RetrainingSchedulerStatus (string) –
      
      Indicates the status of the retraining scheduler.

Exceptions

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