MonitoringSchedule - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

MonitoringSchedule

A schedule for a model monitoring job. For information about model monitor, see Amazon SageMaker Model Monitor.

Contents

CreationTime

The time that the monitoring schedule was created.

Type: Timestamp

Required: No

EndpointName

The endpoint that hosts the model being monitored.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: No

FailureReason

If the monitoring schedule failed, the reason it failed.

Type: String

Length Constraints: Maximum length of 1024.

Required: No

LastModifiedTime

The last time the monitoring schedule was changed.

Type: Timestamp

Required: No

LastMonitoringExecutionSummary

Summary of information about the last monitoring job to run.

Type: MonitoringExecutionSummary object

Required: No

MonitoringScheduleArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No

MonitoringScheduleConfig

Configures the monitoring schedule and defines the monitoring job.

Type: MonitoringScheduleConfig object

Required: No

MonitoringScheduleName

The name of the monitoring schedule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$

Required: No

MonitoringScheduleStatus

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.

Type: String

Valid Values: Pending | Failed | Scheduled | Stopped

Required: No

MonitoringType

The type of the monitoring job definition to schedule.

Type: String

Valid Values: DataQuality | ModelQuality | ModelBias | ModelExplainability

Required: No

Tags

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

Type: Array of Tag objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: