:doc:`SageMaker <../../sagemaker>` / Paginator / ListMonitoringAlertHistory

**************************
ListMonitoringAlertHistory
**************************



.. py:class:: SageMaker.Paginator.ListMonitoringAlertHistory

  ::

    
    paginator = client.get_paginator('list_monitoring_alert_history')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SageMaker.Client.list_monitoring_alert_history`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListMonitoringAlertHistory>`_    


    **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'
          }
      )
      
    :type MonitoringScheduleName: string
    :param MonitoringScheduleName: 

      The name of a monitoring schedule.

      

    
    :type MonitoringAlertName: string
    :param MonitoringAlertName: 

      The name of a monitoring alert.

      

    
    :type SortBy: string
    :param SortBy: 

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

      

    
    :type SortOrder: string
    :param SortOrder: 

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

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

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

      

    
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

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

      

    
    :type StatusEquals: string
    :param StatusEquals: 

      A filter that retrieves only alerts with a specific status.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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.

              
        
      
    