Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListInferenceRecommendationsJobs

Lists recommendation jobs that satisfy various filters.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "LastModifiedTimeAfter": number,
   "LastModifiedTimeBefore": number,
   "MaxResults": number,
   "ModelNameEquals": "string",
   "ModelPackageVersionArnEquals": "string",
   "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 (timestamp).

Type: Timestamp

Required: No

CreationTimeBefore

A filter that returns only jobs created before the specified time (timestamp).

Type: Timestamp

Required: No

LastModifiedTimeAfter

A filter that returns only jobs that were last modified after the specified time (timestamp).

Type: Timestamp

Required: No

LastModifiedTimeBefore

A filter that returns only jobs that were last modified before the specified time (timestamp).

Type: Timestamp

Required: No

MaxResults

The maximum number of recommendations to return in the response.

Type: Integer

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

Required: No

ModelNameEquals

A filter that returns only jobs that were created for this model.

Type: String

Length Constraints: Maximum length of 63.

Pattern: ^[a-zA-Z0-9]([\-a-zA-Z0-9]*[a-zA-Z0-9])?

Required: No

ModelPackageVersionArnEquals

A filter that returns only jobs that were created for this versioned model package.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^arn:aws(-cn|-us-gov)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$

Required: No

NameContains

A string in the job name. This filter returns only recommendations whose name contains the specified string.

Type: String

Length Constraints: Maximum length of 63.

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

Required: No

NextToken

If the response to a previous ListInferenceRecommendationsJobsRequest request was truncated, the response includes a NextToken. To retrieve the next set of recommendations, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The parameter by which to sort the results.

Type: String

Valid Values: Name | CreationTime | Status

Required: No

SortOrder

The sort order for the results.

Type: String

Valid Values: Ascending | Descending

Required: No

StatusEquals

A filter that retrieves only inference recommendations jobs with a specific status.

Type: String

Required: No

Response Syntax


{
   "InferenceRecommendationsJobs": [ 
      { 
         "CompletionTime": number,
         "CreationTime": number,
         "FailureReason": "string",
         "JobArn": "string",
         "JobDescription": "string",
         "JobName": "string",
         "JobType": "string",
         "LastModifiedTime": number,
         "ModelName": "string",
         "ModelPackageVersionArn": "string",
         "RoleArn": "string",
         "SamplePayloadUrl": "string",
         "Status": "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.

InferenceRecommendationsJobs

The recommendations created from the Amazon SageMaker Inference Recommender job.

Type: Array of InferenceRecommendationsJob objects

NextToken

A token for getting the next set of recommendations, if there are any.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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