SageMaker / Paginator / ListMonitoringAlertHistory

ListMonitoringAlertHistory

class SageMaker.Paginator.ListMonitoringAlertHistory

paginator = client.get_paginator('list_monitoring_alert_history')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    MonitoringScheduleName='string',
    MonitoringAlertName='string',
    SortBy='CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    StatusEquals='InAlert'|'OK',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• MonitoringScheduleName (string) – The name of a monitoring schedule.

• MonitoringAlertName (string) – The name of a monitoring alert.

• SortBy (string) – The field used to sort results. The default is CreationTime.

• SortOrder (string) – The sort order, whether Ascending or Descending, of the alert history. The default is Descending.

• CreationTimeBefore (datetime) – A filter that returns only alerts created on or before the specified time.

• CreationTimeAfter (datetime) – A filter that returns only alerts created on or after the specified time.

• StatusEquals (string) – A filter that retrieves only alerts with a specific status.

• 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

{
    'MonitoringAlertHistory': [
        {
            'MonitoringScheduleName': 'string',
            'MonitoringAlertName': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'AlertStatus': 'InAlert'|'OK'
        },
    ],

}

Response Structure

• (dict) –

  • MonitoringAlertHistory (list) –

    An alert history for a model monitoring schedule.

    • (dict) –

      Provides summary information of an alert’s history.

      • MonitoringScheduleName (string) –

        The name of a monitoring schedule.

      • MonitoringAlertName (string) –

        The name of a monitoring alert.

      • CreationTime (datetime) –

        A timestamp that indicates when the first alert transition occurred in an alert history. An alert transition can be from status InAlert to OK, or from OK to InAlert.

      • AlertStatus (string) –

        The current alert status of an alert.