Skip to content

DescribeMonitoringScheduleResponse

Source code in docs_src/capo_sagemaker/types/describe_monitoring_schedule_response.py
class DescribeMonitoringScheduleResponse(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>Name of the monitoring schedule.</p>"""
    monitoring_schedule_status: NotRequired[
        "capo_sagemaker.types.schedule_status.ScheduleStatus"
    ]
    """<p>The status of an monitoring job.</p>"""
    monitoring_type: NotRequired["capo_sagemaker.types.monitoring_type.MonitoringType"]
    """<p>The type of the monitoring job that this schedule runs. This is one of the following values.</p> <ul> <li> <p> <code>DATA_QUALITY</code> - The schedule is for a data quality monitoring job.</p> </li> <li> <p> <code>MODEL_QUALITY</code> - The schedule is for a model quality monitoring job.</p> </li> <li> <p> <code>MODEL_BIAS</code> - The schedule is for a bias monitoring job.</p> </li> <li> <p> <code>MODEL_EXPLAINABILITY</code> - The schedule is for an explainability monitoring job.</p> </li> </ul>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time at which the monitoring job was created.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time at which the monitoring job was last modified.</p>"""
    monitoring_schedule_config: NotRequired[
        "capo_sagemaker.types.monitoring_schedule_config.MonitoringScheduleConfig"
    ]
    """<p>The configuration object that specifies the monitoring schedule and defines the monitoring job.</p>"""
    endpoint_name: NotRequired["capo_sagemaker.types.endpoint_name.EndpointName"]
    """<p> The name of the endpoint for the monitoring job.</p>"""
    last_monitoring_execution_summary: NotRequired[
        "capo_sagemaker.types.monitoring_execution_summary.MonitoringExecutionSummary"
    ]
    """<p>Describes metadata on the last execution to run, if there was one.</p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The time at which the monitoring job was created.

endpoint_name instance-attribute

endpoint_name: NotRequired[EndpointName]

The name of the endpoint for the monitoring job.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

A string, up to one KB in size, that contains the reason a monitoring job failed, if it failed.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

The time at which the monitoring job was last modified.

last_monitoring_execution_summary instance-attribute

last_monitoring_execution_summary: NotRequired[MonitoringExecutionSummary]

Describes metadata on the last execution to run, if there was one.

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]

The configuration object that specifies the monitoring schedule and defines the monitoring job.

monitoring_schedule_name instance-attribute

monitoring_schedule_name: NotRequired[MonitoringScheduleName]

Name of the monitoring schedule.

monitoring_schedule_status instance-attribute

monitoring_schedule_status: NotRequired[ScheduleStatus]

The status of an monitoring job.

monitoring_type instance-attribute

monitoring_type: NotRequired[MonitoringType]

The type of the monitoring job that this schedule runs. This is one of the following values.

  • DATA_QUALITY - The schedule is for a data quality monitoring job.

  • MODEL_QUALITY - The schedule is for a model quality monitoring job.

  • MODEL_BIAS - The schedule is for a bias monitoring job.

  • MODEL_EXPLAINABILITY - The schedule is for an explainability monitoring job.