Skip to content

List Model Explainability Job Definitions

sagemaker_list_model_explainability_job_definitions R Documentation

Lists model explainability job definitions that satisfy various filters

Description

Lists model explainability job definitions that satisfy various filters.

Usage

sagemaker_list_model_explainability_job_definitions(EndpointName,
  SortBy, SortOrder, NextToken, MaxResults, NameContains,
  CreationTimeBefore, CreationTimeAfter)

Arguments

EndpointName

Name of the endpoint to monitor for model explainability.

SortBy

Whether to sort results by the Name or CreationTime 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 model explainability jobs whose name contains a specified string.

CreationTimeBefore

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

CreationTimeAfter

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

Value

A list with the following syntax:

list(
  JobDefinitionSummaries = list(
    list(
      MonitoringJobDefinitionName = "string",
      MonitoringJobDefinitionArn = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      EndpointName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_model_explainability_job_definitions(
  EndpointName = "string",
  SortBy = "Name"|"CreationTime",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  NameContains = "string",
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  )
)