Skip to content

/AWS1/CL_PZZ=>CREATEBATCHINFERENCEJOB()

About CreateBatchInferenceJob

Generates batch recommendations based on a list of items or users stored in Amazon S3 and exports the recommendations to an Amazon S3 bucket.

To generate batch recommendations, specify the ARN of a solution version and an Amazon S3 URI for the input and output data. For user personalization, popular items, and personalized ranking solutions, the batch inference job generates a list of recommended items for each user ID in the input file. For related items solutions, the job generates a list of recommended items for each item ID in the input file.

For more information, see Creating a batch inference job .

If you use the Similar-Items recipe, Amazon Personalize can add descriptive themes to batch recommendations. To generate themes, set the job's mode to THEME_GENERATION and specify the name of the field that contains item names in the input data.

For more information about generating themes, see Batch recommendations with themes from Content Generator .

You can't get batch recommendations with the Trending-Now or Next-Best-Action recipes.

Method Signature

IMPORTING

Required arguments:

IV_JOBNAME TYPE /AWS1/PZZNAME /AWS1/PZZNAME

The name of the batch inference job to create.

IV_SOLUTIONVERSIONARN TYPE /AWS1/PZZARN /AWS1/PZZARN

The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.

IO_JOBINPUT TYPE REF TO /AWS1/CL_PZZBTCINFERENCEJOBINP /AWS1/CL_PZZBTCINFERENCEJOBINP

The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.

IO_JOBOUTPUT TYPE REF TO /AWS1/CL_PZZBTCINFERENCEJOBOUT /AWS1/CL_PZZBTCINFERENCEJOBOUT

The path to the Amazon S3 bucket where the job's output will be stored.

IV_ROLEARN TYPE /AWS1/PZZROLEARN /AWS1/PZZROLEARN

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.

Optional arguments:

IV_FILTERARN TYPE /AWS1/PZZARN /AWS1/PZZARN

The ARN of the filter to apply to the batch inference job. For more information on using filters, see Filtering batch recommendations.

IV_NUMRESULTS TYPE /AWS1/PZZNUMBATCHRESULTS /AWS1/PZZNUMBATCHRESULTS

The number of recommendations to retrieve.

IO_BATCHINFERENCEJOBCONFIG TYPE REF TO /AWS1/CL_PZZBTCINFERENCEJOBCFG /AWS1/CL_PZZBTCINFERENCEJOBCFG

The configuration details of a batch inference job.

IT_TAGS TYPE /AWS1/CL_PZZTAG=>TT_TAGS TT_TAGS

A list of tags to apply to the batch inference job.

IV_BATCHINFERENCEJOBMODE TYPE /AWS1/PZZBATCHINFERENCEJOBMODE /AWS1/PZZBATCHINFERENCEJOBMODE

The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to THEME_GENERATION. If you don't want to generate themes, use the default BATCH_INFERENCE.

When you get batch recommendations with themes, you will incur additional costs. For more information, see Amazon Personalize pricing.

IO_THEMEGENERATIONCONFIG TYPE REF TO /AWS1/CL_PZZTHEMEGENERATIONCFG /AWS1/CL_PZZTHEMEGENERATIONCFG

For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_PZZCREBTCINFERENCEJ01 /AWS1/CL_PZZCREBTCINFERENCEJ01