Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRetrainingScheduler

Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.

Request Syntax


{
   "ModelName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

ModelName

The name of the model that the retraining scheduler is attached to.

Type: String

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

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

Required: Yes

Response Syntax


{
   "CreatedAt": number,
   "LookbackWindow": "string",
   "ModelArn": "string",
   "ModelName": "string",
   "PromoteMode": "string",
   "RetrainingFrequency": "string",
   "RetrainingStartDate": number,
   "Status": "string",
   "UpdatedAt": number
}

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.

CreatedAt

Indicates the time and date at which the retraining scheduler was created.

Type: Timestamp

LookbackWindow

The number of past days of data used for retraining.

Type: String

Pattern: ^P180D$|^P360D$|^P540D$|^P720D$

ModelArn

The ARN of the model that the retraining scheduler is attached to.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:model\/.+

ModelName

The name of the model that the retraining scheduler is attached to.

Type: String

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

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

PromoteMode

Indicates how the service uses new models. In MANAGED mode, new models are used for inference if they have better performance than the current model. In MANUAL mode, the new models are not used until they are manually activated.

Type: String

Valid Values: MANAGED | MANUAL

RetrainingFrequency

The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.

Type: String

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

Pattern: ^P(\dY)?(\d{1,2}M)?(\d{1,3}D)?$

RetrainingStartDate

The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.

Type: Timestamp

Status

The status of the retraining scheduler.

Type: String

Valid Values: PENDING | RUNNING | STOPPING | STOPPED

UpdatedAt

Indicates the time and date at which the retraining scheduler was updated.

Type: Timestamp

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