monitoring_alerts

Creates, updates, deletes, gets or lists a monitoring_alerts resource.

Overview

Name	monitoring_alerts
Type	Resource
Id	aws.sagemaker.monitoring_alerts

Fields

The following fields are returned by SELECT queries:

list_monitoring_alerts

Name	Datatype	Description
actions	object	A list of alert actions taken in response to an alert going into InAlert status.
alert_status	string	The current status of an alert. (InAlert, OK)
creation_time	string (date-time)	A timestamp that indicates when a monitor alert was created.
datapoints_to_alert	integer	Within EvaluationPeriod, how many execution failures will raise an alert.
evaluation_period	integer	The number of most recent monitoring executions to consider when evaluating alert status.
last_modified_time	string (date-time)	A timestamp that indicates when a monitor alert was last updated.
monitoring_alert_name	string	The name of a monitoring alert. (pattern: <code>[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_monitoring_alerts	select	region		Gets the alerts for a single monitoring schedule.
update_monitoring_alert	update	region, MonitoringScheduleName, MonitoringAlertName, DatapointsToAlert, EvaluationPeriod		Update the parameters of a model monitor alert.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_monitoring_alerts

Gets the alerts for a single monitoring schedule.

SELECT
actions,
alert_status,
creation_time,
datapoints_to_alert,
evaluation_period,
last_modified_time,
monitoring_alert_name
FROM aws.sagemaker.monitoring_alerts
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_monitoring_alert

Update the parameters of a model monitor alert.

UPDATE aws.sagemaker.monitoring_alerts
SET 
MonitoringScheduleName = '{{ MonitoringScheduleName }}',
MonitoringAlertName = '{{ MonitoringAlertName }}',
DatapointsToAlert = {{ DatapointsToAlert }},
EvaluationPeriod = {{ EvaluationPeriod }}
WHERE 
region = '{{ region }}' --required
AND MonitoringScheduleName = '{{ MonitoringScheduleName }}' --required
AND MonitoringAlertName = '{{ MonitoringAlertName }}' --required
AND DatapointsToAlert = '{{ DatapointsToAlert }}' --required
AND EvaluationPeriod = '{{ EvaluationPeriod }}' --required
RETURNING
monitoring_alert_name,
monitoring_schedule_arn;