Amazon Lookout for Equipment is no longer open to new customers.
Existing customers can continue to use the service as normal.
For capabilities similar to Amazon Lookout for Equipment see our
blog post
Lists all retraining schedulers in your account, filtering by model name prefix and status.
Request Syntax
{
"MaxResults": number,
"ModelNameBeginsWith": "string",
"NextToken": "string",
"Status": "string"
}Request Parameters
The request accepts the following data in JSON format.
- MaxResults
-
Specifies the maximum number of retraining schedulers to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- ModelNameBeginsWith
-
Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$Required: No
- NextToken
-
If the number of results exceeds the maximum, a pagination token is returned. Use the token in the request to show the next page of retraining schedulers.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}Required: No
- Status
-
Specify this field to only list retraining schedulers whose status matches the value you specify.
Type: String
Valid Values:
PENDING | RUNNING | STOPPING | STOPPEDRequired: No
Response Syntax
{
"NextToken": "string",
"RetrainingSchedulerSummaries": [
{
"LookbackWindow": "string",
"ModelArn": "string",
"ModelName": "string",
"RetrainingFrequency": "string",
"RetrainingStartDate": number,
"Status": "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.
- NextToken
-
If the number of results exceeds the maximum, this pagination token is returned. Use this token in the request to show the next page of retraining schedulers.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192} - RetrainingSchedulerSummaries
-
Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.
Type: Array of RetrainingSchedulerSummary objects
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:
