retraining_schedulers

Creates, updates, deletes, gets or lists a retraining_schedulers resource.

Overview

Name	retraining_schedulers
Type	Resource
Id	aws.lookoutequipment.retraining_schedulers

Fields

The following fields are returned by SELECT queries:

describe_retraining_scheduler

Name	Datatype	Description
created_at	string (date-time)	Indicates the time and date at which the retraining scheduler was created.
lookback_window	string	The number of past days of data used for retraining. (pattern: <code>^P180D$|^P360D$|^P540D$|^P720D$</code>)
model_arn	string	The ARN of the model that the retraining scheduler is attached to. (pattern: <code>arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9-]*:[0-9]{12}:model/.+</code>)
model_name	string	The name of the model that the retraining scheduler is attached to. (pattern: <code>^[0-9a-zA-Z_-]{1,200}$</code>)
promote_mode	string	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. (MANAGED, MANUAL)
retraining_frequency	string	The frequency at which the model retraining is set. This follows the ISO 8601 guidelines. (pattern: <code>^P(\dY)?(\d{1,2}M)?(\d{1,3}D)?$</code>)
retraining_start_date	string (date-time)	The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
status	string	The status of the retraining scheduler. (PENDING, RUNNING, STOPPING, STOPPED)
updated_at	string (date-time)	Indicates the time and date at which the retraining scheduler was updated.

list_retraining_schedulers

Name	Datatype	Description
next_token	string	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. (pattern: <code>\p{ASCII}{0,8192}</code>)
retraining_scheduler_summaries	array	Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_retraining_scheduler	select	region		Provides a description of the retraining scheduler, including information such as the model name and retraining parameters.
list_retraining_schedulers	select	region		Lists all retraining schedulers in your account, filtering by model name prefix and status.
create_retraining_scheduler	insert	region, ModelName, RetrainingFrequency, LookbackWindow, ClientToken		Creates a retraining scheduler on the specified model.
update_retraining_scheduler	update	region, ModelName		Updates a retraining scheduler.
delete_retraining_scheduler	delete	region		Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_retraining_scheduler

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

SELECT
created_at,
lookback_window,
model_arn,
model_name,
promote_mode,
retraining_frequency,
retraining_start_date,
status,
updated_at
FROM aws.lookoutequipment.retraining_schedulers
WHERE region = '{{ region }}' -- required
;

list_retraining_schedulers

Lists all retraining schedulers in your account, filtering by model name prefix and status.

SELECT
next_token,
retraining_scheduler_summaries
FROM aws.lookoutequipment.retraining_schedulers
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_retraining_scheduler

Creates a retraining scheduler on the specified model.

INSERT INTO aws.lookoutequipment.retraining_schedulers (
ModelName,
RetrainingStartDate,
RetrainingFrequency,
LookbackWindow,
PromoteMode,
ClientToken,
region
)
SELECT 
'{{ ModelName }}' /* required */,
'{{ RetrainingStartDate }}',
'{{ RetrainingFrequency }}' /* required */,
'{{ LookbackWindow }}' /* required */,
'{{ PromoteMode }}',
'{{ ClientToken }}' /* required */,
'{{ region }}'
RETURNING
model_arn,
model_name,
status
;

Manifest

# Description fields are for documentation purposes
- name: retraining_schedulers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the retraining_schedulers resource.
  - name: ModelName
    value: "{{ ModelName }}"
    description: |
      The name of the model to add the retraining scheduler to.
  - name: RetrainingStartDate
    value: "{{ RetrainingStartDate }}"
    description: |
      The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
  - name: RetrainingFrequency
    value: "{{ RetrainingFrequency }}"
    description: |
      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
  - name: LookbackWindow
    value: "{{ LookbackWindow }}"
    description: |
      The number of past days of data that will be used for retraining.
  - name: PromoteMode
    value: "{{ PromoteMode }}"
    description: |
      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.
    valid_values: ['MANAGED', 'MANUAL']
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      A unique identifier for the request. If you do not set the client request token, Amazon Lookout for Equipment generates one.

UPDATE examples

update_retraining_scheduler

Updates a retraining scheduler.

UPDATE aws.lookoutequipment.retraining_schedulers
SET 
ModelName = '{{ ModelName }}',
RetrainingStartDate = '{{ RetrainingStartDate }}',
RetrainingFrequency = '{{ RetrainingFrequency }}',
LookbackWindow = '{{ LookbackWindow }}',
PromoteMode = '{{ PromoteMode }}'
WHERE 
region = '{{ region }}' --required
AND ModelName = '{{ ModelName }}' --required;

DELETE examples

delete_retraining_scheduler

Deletes a retraining scheduler from a model. The retraining scheduler must be in the STOPPED status.

DELETE FROM aws.lookoutequipment.retraining_schedulers
WHERE region = '{{ region }}' --required
;