Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListModelVersions

Generates a list of all model versions for a given model, including the model version, model version ARN, and status. To list a subset of versions, use the MaxModelVersion and MinModelVersion fields.

Request Syntax


{
   "CreatedAtEndTime": number,
   "CreatedAtStartTime": number,
   "MaxModelVersion": number,
   "MaxResults": number,
   "MinModelVersion": number,
   "ModelName": "string",
   "NextToken": "string",
   "SourceType": "string",
   "Status": "string"
}

Request Parameters

The request accepts the following data in JSON format.

CreatedAtEndTime

Filter results to return all the model versions created before this time.

Type: Timestamp

Required: No

CreatedAtStartTime

Filter results to return all the model versions created after this time.

Type: Timestamp

Required: No

MaxModelVersion

Specifies the highest version of the model to return in the list.

Type: Long

Valid Range: Minimum value of 1.

Required: No

MaxResults

Specifies the maximum number of machine learning model versions to list.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

MinModelVersion

Specifies the lowest version of the model to return in the list.

Type: Long

Valid Range: Minimum value of 1.

Required: No

ModelName

Then name of the machine learning model for which the model versions are to be listed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: Yes

NextToken

If the total number of results exceeds the limit that the response can display, the response returns an opaque pagination token indicating where to continue the listing of machine learning model versions. Use this token in the NextToken field in the request to list the next page of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Required: No

SourceType

Filter the results based on the way the model version was generated.

Type: String

Valid Values: TRAINING | RETRAINING | IMPORT

Required: No

Status

Filter the results based on the current status of the model version.

Type: String

Valid Values: IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS | CANCELED

Required: No

Response Syntax


{
   "ModelVersionSummaries": [ 
      { 
         "CreatedAt": number,
         "ModelArn": "string",
         "ModelName": "string",
         "ModelQuality": "string",
         "ModelVersion": number,
         "ModelVersionArn": "string",
         "SourceType": "string",
         "Status": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ModelVersionSummaries

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

Note

If you don't supply the ModelName request parameter, or if you supply the name of a model that doesn't exist, ListModelVersions returns an empty array in ModelVersionSummaries.

Type: Array of ModelVersionSummary objects

NextToken

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Errors

AccessDeniedException

The request could not be completed because you do not have access to the resource.

HTTP Status Code: 400

InternalServerException

Processing of the request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The resource requested could not be found. Verify the resource ID and retry your request.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related AWS service that's being utilized.

HTTP Status Code: 400