SageMaker / Client / list_monitoring_alerts

list_monitoring_alerts#

SageMaker.Client.list_monitoring_alerts(**kwargs)#

Gets the alerts for a single monitoring schedule.

See also: AWS API Documentation

Request Syntax

response = client.list_monitoring_alerts(
    MonitoringScheduleName='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • MonitoringScheduleName (string) –

    [REQUIRED]

    The name of a monitoring schedule.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of results to display. The default is 100.

Return type:

dict

Returns:

Response Syntax

{
    'MonitoringAlertSummaries': [
        {
            'MonitoringAlertName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'AlertStatus': 'InAlert'|'OK',
            'DatapointsToAlert': 123,
            'EvaluationPeriod': 123,
            'Actions': {
                'ModelDashboardIndicator': {
                    'Enabled': True|False
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • MonitoringAlertSummaries (list) –

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

      • (dict) –

        Provides summary information about a monitor alert.

        • MonitoringAlertName (string) –

          The name of a monitoring alert.

        • CreationTime (datetime) –

          A timestamp that indicates when a monitor alert was created.

        • LastModifiedTime (datetime) –

          A timestamp that indicates when a monitor alert was last updated.

        • AlertStatus (string) –

          The current status of an alert.

        • DatapointsToAlert (integer) –

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

        • EvaluationPeriod (integer) –

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

        • Actions (dict) –

          A list of alert actions taken in response to an alert going into InAlert status.

          • ModelDashboardIndicator (dict) –

            An alert action taken to light up an icon on the Model Dashboard when an alert goes into InAlert status.

            • Enabled (boolean) –

              Indicates whether the alert action is turned on.

    • NextToken (string) –

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

Exceptions