SageMaker / Client / list_monitoring_schedules

list_monitoring_schedules#

SageMaker.Client.list_monitoring_schedules(**kwargs)#

Returns list of all monitoring schedules.

Request Syntax

response = client.list_monitoring_schedules(
    EndpointName='string',
    SortBy='Name'|'CreationTime'|'Status',
    SortOrder='Ascending'|'Descending',
    NextToken='string',
    MaxResults=123,
    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'
)

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.
NextToken (string) – The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.
MaxResults (integer) – The maximum number of jobs to return in the response. The default value is 10.
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.

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'
        },
    ],
    'NextToken': 'string'
}

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.
- NextToken (string) –
  
  If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.