ListMonitoringAlertHistory
Gets a list of past alerts in a model monitoring schedule.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"MaxResults": number,
"MonitoringAlertName": "string",
"MonitoringScheduleName": "string",
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"StatusEquals": "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.
- CreationTimeAfter
-
A filter that returns only alerts created on or after the specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only alerts created on or before the specified time.
Type: Timestamp
Required: No
- 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
- 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: 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: No
- NextToken
-
If the result of the previous
ListMonitoringAlertHistoryrequest was truncated, the response includes aNextToken. 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
- SortBy
-
The field used to sort results. The default is
CreationTime.Type: String
Valid Values:
CreationTime | StatusRequired: No
- SortOrder
-
The sort order, whether
AscendingorDescending, of the alert history. The default isDescending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that retrieves only alerts with a specific status.
Type: String
Valid Values:
InAlert | OKRequired: No
Response Syntax
{
"MonitoringAlertHistory": [
{
"AlertStatus": "string",
"CreationTime": number,
"MonitoringAlertName": "string",
"MonitoringScheduleName": "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.
- MonitoringAlertHistory
-
An alert history for a model monitoring schedule.
Type: Array of MonitoringAlertHistorySummary objects
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
