List Monitoring Executions

sagemaker_list_monitoring_executions

R Documentation

Returns list of all monitoring job executions

Description

Returns list of all monitoring job executions.

Usage

sagemaker_list_monitoring_executions(MonitoringScheduleName,
  EndpointName, SortBy, SortOrder, NextToken, MaxResults,
  ScheduledTimeBefore, ScheduledTimeAfter, CreationTimeBefore,
  CreationTimeAfter, LastModifiedTimeBefore, LastModifiedTimeAfter,
  StatusEquals, MonitoringJobDefinitionName, MonitoringTypeEquals)

Arguments

MonitoringScheduleName

Name of a specific schedule to fetch jobs for.

EndpointName

Name of a specific endpoint to fetch jobs 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.

ScheduledTimeBefore

Filter for jobs scheduled before a specified time.

ScheduledTimeAfter

Filter for jobs scheduled after a specified time.

CreationTimeBefore

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

CreationTimeAfter

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

LastModifiedTimeBefore

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

LastModifiedTimeAfter

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

StatusEquals

A filter that retrieves only jobs with a specific status.

MonitoringJobDefinitionName

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

MonitoringTypeEquals

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

Value

A list with the following syntax:

list(
  MonitoringExecutionSummaries = list(
    list(
      MonitoringScheduleName = "string",
      ScheduledTime = as.POSIXct(
        "2015-01-01"
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      MonitoringExecutionStatus = "Pending"|"Completed"|"CompletedWithViolations"|"InProgress"|"Failed"|"Stopping"|"Stopped",
      ProcessingJobArn = "string",
      EndpointName = "string",
      FailureReason = "string",
      MonitoringJobDefinitionName = "string",
      MonitoringType = "DataQuality"|"ModelQuality"|"ModelBias"|"ModelExplainability"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_monitoring_executions(
  MonitoringScheduleName = "string",
  EndpointName = "string",
  SortBy = "CreationTime"|"ScheduledTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  ScheduledTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  ScheduledTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  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"|"Completed"|"CompletedWithViolations"|"InProgress"|"Failed"|"Stopping"|"Stopped",
  MonitoringJobDefinitionName = "string",
  MonitoringTypeEquals = "DataQuality"|"ModelQuality"|"ModelBias"|"ModelExplainability"
)