LookoutEquipment / Client / list_retraining_schedulers

list_retraining_schedulers¶

LookoutEquipment.Client.list_retraining_schedulers(**kwargs)¶

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

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

Request Syntax

response = client.list_retraining_schedulers(
    ModelNameBeginsWith='string',
    Status='PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
    NextToken='string',
    MaxResults=123
)

Parameters:

ModelNameBeginsWith (string) – Specify this field to only list retraining schedulers whose machine learning models begin with the value you specify.
Status (string) – Specify this field to only list retraining schedulers whose status matches the value you specify.
NextToken (string) – 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.
MaxResults (integer) – Specifies the maximum number of retraining schedulers to list.

Return type:

dict

Returns:

Response Syntax

{
    'RetrainingSchedulerSummaries': [
        {
            'ModelName': 'string',
            'ModelArn': 'string',
            'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
            'RetrainingStartDate': datetime(2015, 1, 1),
            'RetrainingFrequency': 'string',
            'LookbackWindow': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- RetrainingSchedulerSummaries (list) –
  
  Provides information on the specified retraining scheduler, including the model name, model ARN, status, and start date.
  - (dict) –
    
    Provides information about the specified retraining scheduler, including model name, status, start date, frequency, and lookback window.
    - ModelName (string) –
      
      The name of the model that the retraining scheduler is attached to.
    - ModelArn (string) –
      
      The ARN of the model that the retraining scheduler is attached to.
    - Status (string) –
      
      The status of the retraining scheduler.
    - RetrainingStartDate (datetime) –
      
      The start date for the retraining scheduler. Lookout for Equipment truncates the time you provide to the nearest UTC day.
    - RetrainingFrequency (string) –
      
      The frequency at which the model retraining is set. This follows the ISO 8601 guidelines.
    - LookbackWindow (string) –
      
      The number of past days of data used for retraining.
- NextToken (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.

list_retraining_schedulers¶

Danger

Request Syntax

Response Syntax

Response Structure

Exceptions