UpdateMonitoringAlert - Amazon SageMaker

UpdateMonitoringAlert

Update the parameters of a model monitor alert.

Request Syntax

{ "DatapointsToAlert": number, "EvaluationPeriod": number, "MonitoringAlertName": "string", "MonitoringScheduleName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DatapointsToAlert

Within EvaluationPeriod, how many execution failures will raise an alert.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: Yes

EvaluationPeriod

The number of most recent monitoring executions to consider when evaluating alert status.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: Yes

MonitoringAlertName

The name of a monitoring alert.

Type: String

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

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

Required: Yes

MonitoringScheduleName

The name of a 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: Yes

Response Syntax

{ "MonitoringAlertName": "string", "MonitoringScheduleArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MonitoringAlertName

The name of a monitoring alert.

Type: String

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

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

MonitoringScheduleArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

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