list_models#

LookoutforVision.Client.list_models(**kwargs)#

Lists the versions of a model in an Amazon Lookout for Vision project.

The ListModels operation is eventually consistent. Recent calls to CreateModel might take a while to appear in the response from ListProjects.

This operation requires permissions to perform the lookoutvision:ListModels operation.

Request Syntax

response = client.list_models(
    ProjectName='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

ProjectName (string) –
[REQUIRED]

The name of the project that contains the model versions that you want to list.
NextToken (string) – If the previous response was incomplete (because there is more data to retrieve), Amazon Lookout for Vision returns a pagination token in the response. You can use this pagination token to retrieve the next set of models.
MaxResults (integer) – The maximum number of results to return per paginated call. The largest value you can specify is 100. If you specify a value greater than 100, a ValidationException error occurs. The default value is 100.

Return type:

dict

Returns:

Response Syntax

{
    'Models': [
        {
            'CreationTimestamp': datetime(2015, 1, 1),
            'ModelVersion': 'string',
            'ModelArn': 'string',
            'Description': 'string',
            'Status': 'TRAINING'|'TRAINED'|'TRAINING_FAILED'|'STARTING_HOSTING'|'HOSTED'|'HOSTING_FAILED'|'STOPPING_HOSTING'|'SYSTEM_UPDATING'|'DELETING',
            'StatusMessage': 'string',
            'Performance': {
                'F1Score': ...,
                'Recall': ...,
                'Precision': ...
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Models (list) –
  
  A list of model versions in the specified project.
  - (dict) –
    
    Describes an Amazon Lookout for Vision model.
    - CreationTimestamp (datetime) –
      
      The unix timestamp for the date and time that the model was created.
    - ModelVersion (string) –
      
      The version of the model.
    - ModelArn (string) –
      
      The Amazon Resource Name (ARN) of the model.
    - Description (string) –
      
      The description for the model.
    - Status (string) –
      
      The status of the model.
    - StatusMessage (string) –
      
      The status message for the model.
    - Performance (dict) –
      
      Performance metrics for the model. Not available until training has successfully completed.
      - F1Score (float) –
        
        The overall F1 score metric for the trained model.
      - Recall (float) –
        
        The overall recall metric value for the trained model.
      - Precision (float) –
        
        The overall precision metric value for the trained model.
- NextToken (string) –
  
  If the response is truncated, Amazon Lookout for Vision returns this token that you can use in the subsequent request to retrieve the next set of models.

Exceptions

LookoutforVision.Client.exceptions.AccessDeniedException
LookoutforVision.Client.exceptions.InternalServerException
LookoutforVision.Client.exceptions.ValidationException
LookoutforVision.Client.exceptions.ConflictException
LookoutforVision.Client.exceptions.ResourceNotFoundException
LookoutforVision.Client.exceptions.ThrottlingException