SageMaker / Paginator / ListMonitoringAlerts

ListMonitoringAlerts

class SageMaker.Paginator.ListMonitoringAlerts

paginator = client.get_paginator('list_monitoring_alerts')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_monitoring_alerts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    MonitoringScheduleName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• MonitoringScheduleName (string) –

  [REQUIRED]

  The name of a monitoring schedule.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

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
                }
            }
        },
    ],

}

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.