SageMaker / Paginator / ListMonitoringSchedules

ListMonitoringSchedules#

class SageMaker.Paginator.ListMonitoringSchedules#
paginator = client.get_paginator('list_monitoring_schedules')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    EndpointName='string',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NameContains='string',
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
    LastModifiedTimeBefore=datetime(2015, 1, 1),
    LastModifiedTimeAfter=datetime(2015, 1, 1),
    StatusEquals='Pending'|'Failed'|'Scheduled'|'Stopped',
    MonitoringJobDefinitionName='string',
    MonitoringTypeEquals='DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

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

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

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

  • NameContains (string) – Filter for monitoring schedules whose name contains a specified string.

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

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

  • LastModifiedTimeBefore (datetime) – A filter that returns only monitoring schedules modified before a specified time.

  • LastModifiedTimeAfter (datetime) – A filter that returns only monitoring schedules modified after a specified time.

  • StatusEquals (string) – A filter that returns only monitoring schedules modified before a specified time.

  • MonitoringJobDefinitionName (string) – Gets a list of the monitoring schedules for the specified monitoring job definition.

  • MonitoringTypeEquals (string) – A filter that returns only the monitoring schedules for 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:

dict

Returns:

Response Syntax

{
    'MonitoringScheduleSummaries': [
        {
            'MonitoringScheduleName': 'string',
            'MonitoringScheduleArn': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'LastModifiedTime': datetime(2015, 1, 1),
            'MonitoringScheduleStatus': 'Pending'|'Failed'|'Scheduled'|'Stopped',
            'EndpointName': 'string',
            'MonitoringJobDefinitionName': 'string',
            'MonitoringType': 'DataQuality'|'ModelQuality'|'ModelBias'|'ModelExplainability'
        },
    ],

}

Response Structure

  • (dict) –

    • MonitoringScheduleSummaries (list) –

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

      • (dict) –

        Summarizes the monitoring schedule.

        • MonitoringScheduleName (string) –

          The name of the monitoring schedule.

        • MonitoringScheduleArn (string) –

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

        • CreationTime (datetime) –

          The creation time of the monitoring schedule.

        • LastModifiedTime (datetime) –

          The last time the monitoring schedule was modified.

        • MonitoringScheduleStatus (string) –

          The status of the monitoring schedule.

        • EndpointName (string) –

          The name of the endpoint using the monitoring schedule.

        • MonitoringJobDefinitionName (string) –

          The name of the monitoring job definition that the schedule is for.

        • MonitoringType (string) –

          The type of the monitoring job definition that the schedule is for.