CreateBatchInferenceJobRequest ¶

class CreateBatchInferenceJobRequest(TypedDict, closed=True):
    job_name: "capo_personalize.types.name.Name"
    """<p>The name of the batch inference job to create.</p>"""
    solution_version_arn: "capo_personalize.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the solution version that will be used to generate the batch inference recommendations.</p>"""
    filter_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the filter to apply to the batch inference 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>.</p>"""
    num_results: NotRequired["capo_personalize.types.num_batch_results.NumBatchResults"]
    """<p>The number of recommendations to retrieve.</p>"""
    job_input: "capo_personalize.types.batch_inference_job_input.BatchInferenceJobInput"
    """<p>The Amazon S3 path that leads to the input file to base your recommendations on. The input material must be in JSON format.</p>"""
    job_output: (
        "capo_personalize.types.batch_inference_job_output.BatchInferenceJobOutput"
    )
    """<p>The path to the Amazon S3 bucket where the job's output will be stored.</p>"""
    role_arn: "capo_personalize.types.role_arn.RoleArn"
    """<p>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.</p>"""
    batch_inference_job_config: NotRequired[
        "capo_personalize.types.batch_inference_job_config.BatchInferenceJobConfig"
    ]
    """<p>The configuration details of a batch inference job.</p>"""
    tags: NotRequired["capo_personalize.types.tags.Tags"]
    """<p>A list of <a href="https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html">tags</a> to apply to the batch inference job.</p>"""
    batch_inference_job_mode: NotRequired[
        "capo_personalize.types.batch_inference_job_mode.BatchInferenceJobMode"
    ]
    """<p>The mode of the batch inference job. To generate descriptive themes for groups of similar items, set the job mode to <code>THEME_GENERATION</code>. If you don't want to generate themes, use the default <code>BATCH_INFERENCE</code>.</p> <p> When you get batch recommendations with themes, you will incur additional costs. For more information, see <a href="https://aws.amazon.com/personalize/pricing/">Amazon Personalize pricing</a>. </p>"""
    theme_generation_config: NotRequired[
        "capo_personalize.types.theme_generation_config.ThemeGenerationConfig"
    ]
    """<p>For theme generation jobs, specify the name of the column in your Items dataset that contains each item's name.</p>"""