SageMaker / Paginator / ListMonitoringExecutions


class SageMaker.Paginator.ListMonitoringExecutions#
paginator = client.get_paginator('list_monitoring_executions')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    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),
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • MonitoringScheduleName (string) – Name of a specific schedule to fetch jobs for.

  • EndpointName (string) – Name of a specific endpoint to fetch jobs for.

  • SortBy (string) – Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

  • SortOrder (string) – Whether to sort the results in Ascending or Descending order. The default is Descending.

  • ScheduledTimeBefore (datetime) – Filter for jobs scheduled before a specified time.

  • ScheduledTimeAfter (datetime) – Filter for jobs scheduled after a specified time.

  • CreationTimeBefore (datetime) – A filter that returns only jobs created before a specified time.

  • CreationTimeAfter (datetime) – A filter that returns only jobs created after a specified time.

  • LastModifiedTimeBefore (datetime) – A filter that returns only jobs modified after a specified time.

  • LastModifiedTimeAfter (datetime) – A filter that returns only jobs modified before a specified time.

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

  • MonitoringJobDefinitionName (string) – Gets a list of the monitoring job runs of the specified monitoring job definitions.

  • MonitoringTypeEquals (string) – A filter that returns only the monitoring job runs of the specified monitoring type.

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



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.