Skip to content

List Monitoring Alert History

sagemaker_list_monitoring_alert_history R Documentation

Gets a list of past alerts in a model monitoring schedule

Description

Gets a list of past alerts in a model monitoring schedule.

Usage

sagemaker_list_monitoring_alert_history(MonitoringScheduleName,
  MonitoringAlertName, SortBy, SortOrder, NextToken, MaxResults,
  CreationTimeBefore, CreationTimeAfter, StatusEquals)

Arguments

MonitoringScheduleName

The name of a monitoring schedule.

MonitoringAlertName

The name of a monitoring alert.

SortBy

The field used to sort results. The default is CreationTime.

SortOrder

The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

NextToken

If the result of the previous list_monitoring_alert_history 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.

MaxResults

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

CreationTimeBefore

A filter that returns only alerts created on or before the specified time.

CreationTimeAfter

A filter that returns only alerts created on or after the specified time.

StatusEquals

A filter that retrieves only alerts with a specific status.

Value

A list with the following syntax: 

list(
  MonitoringAlertHistory = list(
    list(
      MonitoringScheduleName = "string",
      MonitoringAlertName = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      AlertStatus = "InAlert"|"OK"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_monitoring_alert_history(
  MonitoringScheduleName = "string",
  MonitoringAlertName = "string",
  SortBy = "CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  StatusEquals = "InAlert"|"OK"
)