ListModelQualityJobDefinitions
Gets a list of model quality monitoring 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 model quality monitoring job definitions created after the specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only model quality monitoring job definitions created before the specified time.
Type: Timestamp
Required: No
- EndpointName
-
A filter that returns only model quality monitoring job definitions that are 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 results to return in a call to
ListModelQualityJobDefinitions.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A string in the transform job name. This filter returns only model 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
ListModelQualityJobDefinitionsrequest was truncated, the response includes aNextToken. To retrieve the next set of model quality monitoring job definitions, 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 | CreationTimeRequired: No
- SortOrder
-
Whether to sort the results in
AscendingorDescendingorder. The default isDescending.Type: String
Valid Values:
Ascending | DescendingRequired: 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 summaries of model quality monitoring job definitions.
Type: Array of MonitoringJobDefinitionSummary objects
- NextToken
-
If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of model quality monitoring job definitions, use it 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:
