ListAIRecommendationJobs
Returns a list of AI recommendation jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"MaxResults": number,
"NameContains": "string",
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"StatusEquals": "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 jobs created after the specified time.
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only jobs created before the specified time.
Type: Timestamp
Required: No
- MaxResults
-
The maximum number of recommendation jobs to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NameContains
-
A string in the job name. This filter returns only jobs whose name contains the specified string.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 63.
Pattern:
[a-zA-Z0-9\-]+Required: No
- NextToken
-
If the previous call to
ListAIRecommendationJobsdidn't return the full set of jobs, the call returns a token for getting the next set.Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*Required: No
- SortBy
-
The field to sort results by. The default is
CreationTime.Type: String
Valid Values:
Name | CreationTime | StatusRequired: No
- SortOrder
-
The sort order for results. The default is
Descending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that returns only recommendation jobs with the specified status.
Type: String
Valid Values:
InProgress | Completed | Failed | Stopping | StoppedRequired: No
Response Syntax
{
"AIRecommendationJobs": [
{
"AIRecommendationJobArn": "string",
"AIRecommendationJobName": "string",
"AIRecommendationJobStatus": "string",
"CreationTime": number,
"EndTime": number
}
],
"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.
- AIRecommendationJobs
-
An array of
AIRecommendationJobSummaryobjects, one for each recommendation job that matches the specified filters.Type: Array of AIRecommendationJobSummary objects
- NextToken
-
If the response is truncated, Amazon SageMaker AI returns this token. To retrieve the next set of jobs, use it in the subsequent request.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Error Types.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
