Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListBatchSegmentJobs

Gets a list of the batch segment jobs that have been performed off of a solution version that you specify.

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 segment 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 1500.

Pattern: \p{ASCII}{0,1500}

Required: No

solutionVersionArn

The Amazon Resource Name (ARN) of the solution version that the batch segment jobs used to generate batch segments.

Type: String

Length Constraints: Maximum length of 256.

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

Required: No

Response Syntax


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

batchSegmentJobs

A list containing information on each job that is returned.

Type: Array of BatchSegmentJobSummary objects

Array Members: Maximum number of 100 items.

nextToken

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

Type: String

Length Constraints: Maximum length of 1500.

Pattern: \p{ASCII}{0,1500}

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