sagemaker.core.model_monitor.monitoring_alert#

This module contains code related to the MonitoringAlerts.

Classes

ModelDashboardIndicatorAction(enabled)

An abstraction represents the monitoring dashboard indicator action summary.

MonitoringAlertActions(model_dashboard_indicator)

An abstraction represents the monitoring action.

MonitoringAlertHistorySummary(alert_name, ...)

An abstraction represents the monitoring alert history summary.

MonitoringAlertSummary(alert_name, ...)

An abstraction represents the monitoring alert summary.

class sagemaker.core.model_monitor.monitoring_alert.ModelDashboardIndicatorAction(enabled: bool)[source]#

Bases: object

An abstraction represents the monitoring dashboard indicator action summary.

enabled#

A boolean flag indicating if the model dashboard indicator is enabled or not.

Type:

bool

enabled: bool#
class sagemaker.core.model_monitor.monitoring_alert.MonitoringAlertActions(model_dashboard_indicator: ModelDashboardIndicatorAction)[source]#

Bases: object

An abstraction represents the monitoring action.

model_dashboard_indicator#
Type:

ModelDashboardIndicatorAction

model_dashboard_indicator: ModelDashboardIndicatorAction#
class sagemaker.core.model_monitor.monitoring_alert.MonitoringAlertHistorySummary(alert_name: str, creation_time: str, alert_status: str)[source]#

Bases: object

An abstraction represents the monitoring alert history summary.

alert_name#

Monitoring alert name.

Type:

str

creation_time#

Creation time of the alert.

Type:

str

alert_status#

Alert status, either InAlert or Ok.

Type:

str

alert_name: str#
alert_status: str#
creation_time: str#
class sagemaker.core.model_monitor.monitoring_alert.MonitoringAlertSummary(alert_name: str, creation_time: str, last_modified_time: str, alert_status: str, data_points_to_alert: int, evaluation_period: int, actions: MonitoringAlertActions)[source]#

Bases: object

An abstraction represents the monitoring alert summary.

alert_name#

Monitoring alert name.

Type:

str

creation_time#

Creation time of the alert.

Type:

str

last_modified_time#

Last modified time of the alert.

Type:

str

alert_status#

Alert status, either InAlert or Ok.

Type:

str

data_points_to_alert#

Data points to evaluate to determine the alert status.

Type:

int

evaluation_period#

Period to evaluate the alert status.

Type:

int

actions#

A list of actions to take when monitoring is InAlert

Type:

MonitoringAlertActions

actions: MonitoringAlertActions#
alert_name: str#
alert_status: str#
creation_time: str#
data_points_to_alert: int#
evaluation_period: int#
last_modified_time: str#