LookoutEquipment / Client / describe_retraining_scheduler

describe_retraining_scheduler#

LookoutEquipment.Client.describe_retraining_scheduler(**kwargs)#

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

Request Syntax

response = client.describe_retraining_scheduler(
    ModelName='string'
)

Parameters:

ModelName (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ModelName': 'string',
    'ModelArn': 'string',
    'RetrainingStartDate': datetime(2015, 1, 1),
    'RetrainingFrequency': 'string',
    'LookbackWindow': 'string',
    'Status': 'PENDING'|'RUNNING'|'STOPPING'|'STOPPED',
    'PromoteMode': 'MANAGED'|'MANUAL',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- 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.
- 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.
- Status (string) –
  
  The status of the retraining scheduler.
- PromoteMode (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.
- CreatedAt (datetime) –
  
  Indicates the time and date at which the retraining scheduler was created.
- UpdatedAt (datetime) –
  
  Indicates the time and date at which the retraining scheduler was updated.

Exceptions

LookoutEquipment.Client.exceptions.ValidationException
LookoutEquipment.Client.exceptions.ResourceNotFoundException
LookoutEquipment.Client.exceptions.ThrottlingException
LookoutEquipment.Client.exceptions.AccessDeniedException
LookoutEquipment.Client.exceptions.InternalServerException