Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1466276261.1 KB

Creates a batch segment job. The operation can handle up to 50 million records and the input file must be in JSON format. For more information, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recommendations-batch.html">Getting batch recommendations and user segments</a>.

post/#X-Amz-Target=AmazonPersonalize.CreateBatchSegmentJob

Headers

X-Amz-Target'AmazonPersonalize.CreateBatchSegmentJob' required

Request body

jobNamestring required

The name of the batch segment job to create.

solutionVersionArnstring required

The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.

filterArnstring

The ARN of the filter to apply to the batch segment job. For more information on using filters, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter-batch.html">Filtering batch recommendations</a>.

numResultsinteger

The number of predicted users generated by the batch segment job for each line of input data.

roleArnstring required

The ARN of the Amazon Identity and Access Management role that has permissions to read and write to your input and output Amazon S3 buckets respectively.

Response

Success

batchSegmentJobArnstring

The ARN of the batch segment job.