ListModelExplainabilityJobDefinitions - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ListModelExplainabilityJobDefinitions

Lists model explainability job definitions that satisfy various filters.

Request Syntax

{ "CreationTimeAfter": number, "CreationTimeBefore": number, "EndpointName": "string", "MaxResults": number, "NameContains": "string", "NextToken": "string", "SortBy": "string", "SortOrder": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

CreationTimeAfter

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

Type: Timestamp

Required: No

CreationTimeBefore

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

Type: Timestamp

Required: No

EndpointName

Name of the endpoint to monitor for model explainability.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: No

MaxResults

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

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NameContains

Filter for model explainability jobs whose name contains a specified string.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

Whether to sort results by the Name or CreationTime field. The default is CreationTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

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

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax

{ "JobDefinitionSummaries": [ { "CreationTime": number, "EndpointName": "string", "MonitoringJobDefinitionArn": "string", "MonitoringJobDefinitionName": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

JobDefinitionSummaries

A JSON array in which each element is a summary for a explainability bias jobs.

Type: Array of MonitoringJobDefinitionSummary objects

NextToken

If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of jobs, use it in the subsequent request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: