ListModels
Generates a list of all models in the account, including model name and ARN, dataset, and status.
Request Syntax
{
"DatasetNameBeginsWith": "string
",
"MaxResults": number
,
"ModelNameBeginsWith": "string
",
"NextToken": "string
",
"Status": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- DatasetNameBeginsWith
-
The beginning of the name of the dataset of the machine learning models to be listed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$
Required: No
- MaxResults
-
Specifies the maximum number of machine learning models to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- ModelNameBeginsWith
-
The beginning of the name of the machine learning models being listed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$
Required: No
- NextToken
-
An opaque pagination token indicating where to continue the listing of machine learning models.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}
Required: No
- Status
-
The status of the machine learning model.
Type: String
Valid Values:
IN_PROGRESS | SUCCESS | FAILED | IMPORT_IN_PROGRESS
Required: No
Response Syntax
{
"ModelSummaries": [
{
"ActiveModelVersion": number,
"ActiveModelVersionArn": "string",
"CreatedAt": number,
"DatasetArn": "string",
"DatasetName": "string",
"LatestScheduledRetrainingModelVersion": number,
"LatestScheduledRetrainingStartTime": number,
"LatestScheduledRetrainingStatus": "string",
"ModelArn": "string",
"ModelDiagnosticsOutputConfiguration": {
"KmsKeyId": "string",
"S3OutputConfiguration": {
"Bucket": "string",
"Prefix": "string"
}
},
"ModelName": "string",
"ModelQuality": "string",
"NextScheduledRetrainingStartDate": number,
"RetrainingSchedulerStatus": "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.
- ModelSummaries
-
Provides information on the specified model, including created time, model and dataset ARNs, and status.
Type: Array of ModelSummary objects
- NextToken
-
An opaque pagination token indicating where to continue the listing of machine learning models.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: