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

************************
ListMonitoringExecutions
************************



.. py:class:: SageMaker.Paginator.ListMonitoringExecutions

  ::

    
    paginator = client.get_paginator('list_monitoring_executions')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          MonitoringScheduleName='string',
          EndpointName='string',
          SortBy='CreationTime'|'ScheduledTime'|'Status',
          SortOrder='Ascending'|'Descending',
          ScheduledTimeBefore=datetime(2015, 1, 1),
          ScheduledTimeAfter=datetime(2015, 1, 1),
          CreationTimeBefore=datetime(2015, 1, 1),
          CreationTimeAfter=datetime(2015, 1, 1),
          LastModifiedTimeBefore=datetime(2015, 1, 1),
          LastModifiedTimeAfter=datetime(2015, 1, 1),
          StatusEquals='Pending'|'Completed'|'CompletedWithViolations'|'InProgress'|'Failed'|'Stopping'|'Stopped',
          MonitoringJobDefinitionName='string',
          MonitoringTypeEquals='DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type MonitoringScheduleName: string
    :param MonitoringScheduleName: 

      Name of a specific schedule to fetch jobs for.

      

    
    :type EndpointName: string
    :param EndpointName: 

      Name of a specific endpoint to fetch jobs for.

      

    
    :type SortBy: string
    :param SortBy: 

      Whether to sort the results by the ``Status``, ``CreationTime``, or ``ScheduledTime`` field. The default is ``CreationTime``.

      

    
    :type SortOrder: string
    :param SortOrder: 

      Whether to sort the results in ``Ascending`` or ``Descending`` order. The default is ``Descending``.

      

    
    :type ScheduledTimeBefore: datetime
    :param ScheduledTimeBefore: 

      Filter for jobs scheduled before a specified time.

      

    
    :type ScheduledTimeAfter: datetime
    :param ScheduledTimeAfter: 

      Filter for jobs scheduled after a specified time.

      

    
    :type CreationTimeBefore: datetime
    :param CreationTimeBefore: 

      A filter that returns only jobs created before a specified time.

      

    
    :type CreationTimeAfter: datetime
    :param CreationTimeAfter: 

      A filter that returns only jobs created after a specified time.

      

    
    :type LastModifiedTimeBefore: datetime
    :param LastModifiedTimeBefore: 

      A filter that returns only jobs modified after a specified time.

      

    
    :type LastModifiedTimeAfter: datetime
    :param LastModifiedTimeAfter: 

      A filter that returns only jobs modified before a specified time.

      

    
    :type StatusEquals: string
    :param StatusEquals: 

      A filter that retrieves only jobs with a specific status.

      

    
    :type MonitoringJobDefinitionName: string
    :param MonitoringJobDefinitionName: 

      Gets a list of the monitoring job runs of the specified monitoring job definitions.

      

    
    :type MonitoringTypeEquals: string
    :param MonitoringTypeEquals: 

      A filter that returns only the monitoring job runs of the specified monitoring type.

      

    
    :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**

      
      ::

        {
            'MonitoringExecutionSummaries': [
                {
                    'MonitoringScheduleName': 'string',
                    'ScheduledTime': datetime(2015, 1, 1),
                    'CreationTime': datetime(2015, 1, 1),
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'MonitoringExecutionStatus': 'Pending'|'Completed'|'CompletedWithViolations'|'InProgress'|'Failed'|'Stopping'|'Stopped',
                    'ProcessingJobArn': 'string',
                    'EndpointName': 'string',
                    'FailureReason': 'string',
                    'MonitoringJobDefinitionName': 'string',
                    'MonitoringType': 'DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **MonitoringExecutionSummaries** *(list) --* 

          A JSON array in which each element is a summary for a monitoring execution.

          
          

          - *(dict) --* 

            Summary of information about the last monitoring job to run.

            
            

            - **MonitoringScheduleName** *(string) --* 

              The name of the monitoring schedule.

              
            

            - **ScheduledTime** *(datetime) --* 

              The time the monitoring job was scheduled.

              
            

            - **CreationTime** *(datetime) --* 

              The time at which the monitoring job was created.

              
            

            - **LastModifiedTime** *(datetime) --* 

              A timestamp that indicates the last time the monitoring job was modified.

              
            

            - **MonitoringExecutionStatus** *(string) --* 

              The status of the monitoring job.

              
            

            - **ProcessingJobArn** *(string) --* 

              The Amazon Resource Name (ARN) of the monitoring job.

              
            

            - **EndpointName** *(string) --* 

              The name of the endpoint used to run the monitoring job.

              
            

            - **FailureReason** *(string) --* 

              Contains the reason a monitoring job failed, if it failed.

              
            

            - **MonitoringJobDefinitionName** *(string) --* 

              The name of the monitoring job.

              
            

            - **MonitoringType** *(string) --* 

              The type of the monitoring job.

              
        
      
    