ListDataQualityJobDefinitionsCommand

Suggest an Edit

Lists the data quality job definitions in your account.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerClient, ListDataQualityJobDefinitionsCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, ListDataQualityJobDefinitionsCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // ListDataQualityJobDefinitionsRequest
  EndpointName: "STRING_VALUE",
  SortBy: "Name" || "CreationTime",
  SortOrder: "Ascending" || "Descending",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  NameContains: "STRING_VALUE",
  CreationTimeBefore: new Date("TIMESTAMP"),
  CreationTimeAfter: new Date("TIMESTAMP"),
};
const command = new ListDataQualityJobDefinitionsCommand(input);
const response = await client.send(command);
// { // ListDataQualityJobDefinitionsResponse
//   JobDefinitionSummaries: [ // MonitoringJobDefinitionSummaryList // required
//     { // MonitoringJobDefinitionSummary
//       MonitoringJobDefinitionName: "STRING_VALUE", // required
//       MonitoringJobDefinitionArn: "STRING_VALUE", // required
//       CreationTime: new Date("TIMESTAMP"), // required
//       EndpointName: "STRING_VALUE", // required
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListDataQualityJobDefinitionsCommand Input

See ListDataQualityJobDefinitionsCommandInput for more details

Parameter
Type
Description
CreationTimeAfter
Date | undefined

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

CreationTimeBefore
Date | undefined

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

EndpointName
string | undefined

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

MaxResults
number | undefined

The maximum number of data quality monitoring job definitions to return in the response.

NameContains
string | undefined

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.

NextToken
string | undefined

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.

SortBy
MonitoringJobDefinitionSortKey | undefined

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

SortOrder
SortOrder | undefined

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

ListDataQualityJobDefinitionsCommand Output

See ListDataQualityJobDefinitionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
JobDefinitionSummaries
Required
MonitoringJobDefinitionSummary[] | undefined

A list of data quality monitoring job definitions.

NextToken
string | undefined

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.

Throws

Name
Fault
Details
SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.