Skip to content

CreateBatchSegmentJobRequest

Source code in docs_src/capo_personalize/types/create_batch_segment_job_request.py
class CreateBatchSegmentJobRequest(TypedDict, closed=True):
    job_name: "capo_personalize.types.name.Name"
    """<p>The name of the batch segment job to create.</p>"""
    solution_version_arn: "capo_personalize.types.arn.Arn"
    """<p>The Amazon Resource Name (ARN) of the solution version you want the batch segment job to use to generate batch segments.</p>"""
    filter_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>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>.</p>"""
    num_results: NotRequired["capo_personalize.types.num_batch_results.NumBatchResults"]
    """<p>The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.</p>"""
    job_input: "capo_personalize.types.batch_segment_job_input.BatchSegmentJobInput"
    """<p>The Amazon S3 path for the input data used to generate the batch segment job.</p>"""
    job_output: "capo_personalize.types.batch_segment_job_output.BatchSegmentJobOutput"
    """<p>The Amazon S3 path for the 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>"""
    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 segment job.</p>"""

filter_arn instance-attribute

filter_arn: NotRequired[Arn]

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

job_input instance-attribute

The Amazon S3 path for the input data used to generate the batch segment job.

job_name instance-attribute

job_name: Name

The name of the batch segment job to create.

job_output instance-attribute

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

num_results instance-attribute

num_results: NotRequired[NumBatchResults]

The number of predicted users generated by the batch segment job for each line of input data. The maximum number of users per segment is 5 million.

role_arn instance-attribute

role_arn: RoleArn

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.

solution_version_arn instance-attribute

solution_version_arn: Arn

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

tags instance-attribute

tags: NotRequired[Tags]

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