Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListMonitoringAlerts

Gets the alerts for a single monitoring schedule.

Request Syntax


{
   "MaxResults": number,
   "MonitoringScheduleName": "string",
   "NextToken": "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.

MaxResults

The maximum number of results to display. The default is 100.

Type: Integer

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

Required: No

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

NextToken

If the result of the previous ListMonitoringAlerts request was truncated, the response includes a NextToken. To retrieve the next set of alerts in the history, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

Response Syntax


{
   "MonitoringAlertSummaries": [ 
      { 
         "Actions": { 
            "ModelDashboardIndicator": { 
               "Enabled": boolean
            }
         },
         "AlertStatus": "string",
         "CreationTime": number,
         "DatapointsToAlert": number,
         "EvaluationPeriod": number,
         "LastModifiedTime": number,
         "MonitoringAlertName": "string"
      }
   ],
   "NextToken": "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.

MonitoringAlertSummaries

A JSON array where each element is a summary for a monitoring alert.

Type: Array of MonitoringAlertSummary objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

NextToken

If the response is truncated, SageMaker returns this token. To retrieve the next set of alerts, use it in the subsequent request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400