list_models

LookoutEquipment.Client.list_models(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters

• NextToken (string) -- An opaque pagination token indicating where to continue the listing of ML models.
• MaxResults (integer) -- Specifies the maximum number of ML models to list.
• Status (string) -- The status of the ML model.
• ModelNameBeginsWith (string) -- The beginning of the name of the ML models being listed.
• DatasetNameBeginsWith (string) -- The beginning of the name of the dataset of the ML 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',
            'CreatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • NextToken (string) --

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

  • ModelSummaries (list) --

    Provides information on the specified model, including created time, model and dataset ARNs, and status.

    • (dict) --

      Provides information about the specified ML model, including dataset and model names and ARNs, as well as status.

      • ModelName (string) --

        The name of the ML model.

      • ModelArn (string) --

        The Amazon Resource Name (ARN) of the ML model.

      • DatasetName (string) --

        The name of the dataset being used for the ML model.

      • DatasetArn (string) --

        The Amazon Resource Name (ARN) of the dataset used to create the model.

      • Status (string) --

        Indicates the status of the ML model.

      • CreatedAt (datetime) --

        The time at which the specific model was created.

Exceptions

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