Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateRetrainingScheduler

Creates a retraining scheduler on the specified model.

Request Syntax


{
   "ClientToken": "string",
   "LookbackWindow": "string",
   "ModelName": "string",
   "PromoteMode": "string",
   "RetrainingFrequency": "string",
   "RetrainingStartDate": number
}

Request Parameters

The request accepts the following data in JSON format.

ClientToken

A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

Type: String

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

Pattern: \p{ASCII}{1,256}

Required: Yes

LookbackWindow

The number of past days of data that will be used for retraining.

Type: String

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

Required: Yes

ModelName

The name of the model to add the retraining scheduler to.

Type: String

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

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

Required: Yes

PromoteMode

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

Type: String

Valid Values: MANAGED | MANUAL

Required: No

RetrainingFrequency

This parameter uses the ISO 8601 standard to set the frequency at which you want retraining to occur in terms of Years, Months, and/or Days (note: other parameters like Time are not currently supported). The minimum value is 30 days (P30D) and the maximum value is 1 year (P1Y). For example, the following values are valid:

P3M15D – Every 3 months and 15 days
P2M – Every 2 months
P150D – Every 150 days

Type: String

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

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

Required: Yes

RetrainingStartDate

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

Type: Timestamp

Required: No

Response Syntax


{
   "ModelArn": "string",
   "ModelName": "string",
   "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.

ModelArn

The ARN of the model that you added the retraining scheduler 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 you added the retraining scheduler to.

Type: String

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

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

Status

The status of the retraining scheduler.

Type: String

Valid Values: PENDING | RUNNING | STOPPING | STOPPED

Errors

AccessDeniedException

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

HTTP Status Code: 400

ConflictException

The request could not be completed due to a conflict with the current state of the target 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