Skip to content

MonitoringSchedule

Source code in docs_src/capo_sagemaker/types/monitoring_schedule.py
class MonitoringSchedule(TypedDict, closed=True):
    monitoring_schedule_arn: NotRequired[
        "capo_sagemaker.types.monitoring_schedule_arn.MonitoringScheduleArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the monitoring schedule.</p>"""
    monitoring_schedule_name: NotRequired[
        "capo_sagemaker.types.monitoring_schedule_name.MonitoringScheduleName"
    ]
    """<p>The name of the monitoring schedule.</p>"""
    monitoring_schedule_status: NotRequired[
        "capo_sagemaker.types.schedule_status.ScheduleStatus"
    ]
    """<p>The status of the monitoring schedule. This can be one of the following values.</p> <ul> <li> <p> <code>PENDING</code> - The schedule is pending being created.</p> </li> <li> <p> <code>FAILED</code> - The schedule failed.</p> </li> <li> <p> <code>SCHEDULED</code> - The schedule was successfully created.</p> </li> <li> <p> <code>STOPPED</code> - The schedule was stopped.</p> </li> </ul>"""
    monitoring_type: NotRequired["capo_sagemaker.types.monitoring_type.MonitoringType"]
    """<p>The type of the monitoring job definition to schedule.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If the monitoring schedule failed, the reason it failed.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time that the monitoring schedule was created.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The last time the monitoring schedule was changed.</p>"""
    monitoring_schedule_config: NotRequired[
        "capo_sagemaker.types.monitoring_schedule_config.MonitoringScheduleConfig"
    ]
    endpoint_name: NotRequired["capo_sagemaker.types.endpoint_name.EndpointName"]
    """<p>The endpoint that hosts the model being monitored.</p>"""
    last_monitoring_execution_summary: NotRequired[
        "capo_sagemaker.types.monitoring_execution_summary.MonitoringExecutionSummary"
    ]
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>A list of the tags associated with the monitoring schedlue. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a> in the <i>Amazon Web Services General Reference Guide</i>.</p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time that the monitoring schedule was created.

endpoint_name instance-attribute

endpoint_name: NotRequired[EndpointName]

The endpoint that hosts the model being monitored.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the monitoring schedule failed, the reason it failed.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The last time the monitoring schedule was changed.

last_monitoring_execution_summary instance-attribute

last_monitoring_execution_summary: NotRequired[MonitoringExecutionSummary]

monitoring_schedule_arn instance-attribute

monitoring_schedule_arn: NotRequired[MonitoringScheduleArn]

The Amazon Resource Name (ARN) of the monitoring schedule.

monitoring_schedule_config instance-attribute

monitoring_schedule_config: NotRequired[MonitoringScheduleConfig]

monitoring_schedule_name instance-attribute

monitoring_schedule_name: NotRequired[MonitoringScheduleName]

The name of the monitoring schedule.

monitoring_schedule_status instance-attribute

monitoring_schedule_status: NotRequired[ScheduleStatus]

The status of the monitoring schedule. This can be one of the following values.

  • PENDING - The schedule is pending being created.

  • FAILED - The schedule failed.

  • SCHEDULED - The schedule was successfully created.

  • STOPPED - The schedule was stopped.

monitoring_type instance-attribute

monitoring_type: NotRequired[MonitoringType]

The type of the monitoring job definition to schedule.

tags instance-attribute

tags: NotRequired[TagList]

A list of the tags associated with the monitoring schedlue. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.