Skip to content

List Monitoring Schedules

sagemaker_list_monitoring_schedules R Documentation

Returns list of all monitoring schedules

Description

Returns list of all monitoring schedules.

Usage

sagemaker_list_monitoring_schedules(EndpointName, SortBy, SortOrder,
  NextToken, MaxResults, NameContains, CreationTimeBefore,
  CreationTimeAfter, LastModifiedTimeBefore, LastModifiedTimeAfter,
  StatusEquals, MonitoringJobDefinitionName, MonitoringTypeEquals)

Arguments

EndpointName

Name of a specific endpoint to fetch schedules for.

SortBy

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

SortOrder

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

NextToken

The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

MaxResults

The maximum number of jobs to return in the response. The default value is 10.

NameContains

Filter for monitoring schedules whose name contains a specified string.

CreationTimeBefore

A filter that returns only monitoring schedules created before a specified time.

CreationTimeAfter

A filter that returns only monitoring schedules created after a specified time.

LastModifiedTimeBefore

A filter that returns only monitoring schedules modified before a specified time.

LastModifiedTimeAfter

A filter that returns only monitoring schedules modified after a specified time.

StatusEquals

A filter that returns only monitoring schedules modified before a specified time.

MonitoringJobDefinitionName

Gets a list of the monitoring schedules for the specified monitoring job definition.

MonitoringTypeEquals

A filter that returns only the monitoring schedules for the specified monitoring type.

Value

A list with the following syntax: 

list(
  MonitoringScheduleSummaries = list(
    list(
      MonitoringScheduleName = "string",
      MonitoringScheduleArn = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      MonitoringScheduleStatus = "Pending"|"Failed"|"Scheduled"|"Stopped",
      EndpointName = "string",
      MonitoringJobDefinitionName = "string",
      MonitoringType = "DataQuality"|"ModelQuality"|"ModelBias"|"ModelExplainability"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_monitoring_schedules(
  EndpointName = "string",
  SortBy = "Name"|"CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  NameContains = "string",
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  StatusEquals = "Pending"|"Failed"|"Scheduled"|"Stopped",
  MonitoringJobDefinitionName = "string",
  MonitoringTypeEquals = "DataQuality"|"ModelQuality"|"ModelBias"|"ModelExplainability"
)