ListDataQualityJobDefinitions - Amazon SageMaker Service

ListDataQualityJobDefinitions

Lists the data quality job definitions in your account.

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 data quality monitoring job definitions created after the specified time.

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only data quality monitoring job definitions created before the specified time.

Type: Timestamp

Required: No

EndpointName

A filter that lists the data quality job definitions associated with the specified endpoint.

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 data quality monitoring job definitions to return in the response.

Type: Integer

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

Required: No

NameContains

A string in the data quality monitoring job definition name. This filter returns only data quality monitoring job definitions whose name contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

NextToken

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of transform jobs, use the token in the next request.>

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The field to sort results by. The default is CreationTime.

Type: String

Valid Values: Name | CreationTime

Required: No

SortOrder

The sort order for results. 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 list of data quality monitoring job definitions.

Type: Array of MonitoringJobDefinitionSummary objects

NextToken

If the result of the previous ListDataQualityJobDefinitions request was truncated, the response includes a NextToken. To retrieve the next set of data quality monitoring job definitions, use the token in the next 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 AWS SDKs, see the following: