Amazon Personalize
Developer Guide

ListBatchInferenceJobs

Gets a list of the batch inference jobs that have been performed off of a solution version.

Request Syntax

{ "maxResults": number, "nextToken": "string", "solutionVersionArn": "string" }

Request Parameters

The request accepts the following data in JSON format.

maxResults

The maximum number of batch inference job results to return in each page. The default value is 100.

Type: Integer

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

Required: No

nextToken

The token to request the next page of results.

Type: String

Length Constraints: Maximum length of 1300.

Required: No

solutionVersionArn

The Amazon Resource Name (ARN) of the solution version from which the batch inference jobs were created.

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:([a-z\d-]+):personalize:.*:.*:.+

Required: No

Response Syntax

{ "batchInferenceJobs": [ { "batchInferenceJobArn": "string", "creationDateTime": number, "failureReason": "string", "jobName": "string", "lastUpdatedDateTime": number, "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.

batchInferenceJobs

A list containing information on each job that is returned.

Type: Array of BatchInferenceJobSummary objects

Array Members: Maximum number of 100 items.

nextToken

The token to use to retreive the next page of results. The value is null when there are no more results to return.

Type: String

Length Constraints: Maximum length of 1300.

Errors

InvalidInputException

Provide a valid value for the field or parameter.

HTTP Status Code: 400

InvalidNextTokenException

The token is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: