Skip to content

BatchSegmentJob

Source code in docs_src/capo_personalize/types/batch_segment_job.py
class BatchSegmentJob(TypedDict, closed=True):
    job_name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the batch segment job.</p>"""
    batch_segment_job_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the batch segment job.</p>"""
    filter_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the filter used on the batch segment job.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If the batch segment job failed, the reason for the failure.</p>"""
    solution_version_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the solution version used by the batch segment job to generate batch segments.</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: NotRequired[
        "capo_personalize.types.batch_segment_job_input.BatchSegmentJobInput"
    ]
    """<p>The Amazon S3 path that leads to the input data used to generate the batch segment job.</p>"""
    job_output: NotRequired[
        "capo_personalize.types.batch_segment_job_output.BatchSegmentJobOutput"
    ]
    """<p>The Amazon S3 bucket that contains the output data generated by the batch segment job.</p>"""
    role_arn: NotRequired["capo_personalize.types.role_arn.RoleArn"]
    """<p>The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the batch segment job. The status is one of the following values:</p> <ul> <li> <p>PENDING</p> </li> <li> <p>IN PROGRESS</p> </li> <li> <p>ACTIVE</p> </li> <li> <p>CREATE FAILED</p> </li> </ul>"""
    creation_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The time at which the batch segment job was created.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The time at which the batch segment job last updated.</p>"""

batch_segment_job_arn instance-attribute

batch_segment_job_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the batch segment job.

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

The time at which the batch segment job was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the batch segment job failed, the reason for the failure.

filter_arn instance-attribute

filter_arn: NotRequired[Arn]

The ARN of the filter used on the batch segment job.

job_input instance-attribute

job_input: NotRequired[BatchSegmentJobInput]

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

job_name instance-attribute

job_name: NotRequired[Name]

The name of the batch segment job.

job_output instance-attribute

job_output: NotRequired[BatchSegmentJobOutput]

The Amazon S3 bucket that contains the output data generated by the batch segment job.

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

The time at which the batch segment job last updated.

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: NotRequired[RoleArn]

The ARN of the Amazon Identity and Access Management (IAM) role that requested the batch segment job.

solution_version_arn instance-attribute

solution_version_arn: NotRequired[Arn]

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

status instance-attribute

status: NotRequired[Status]

The status of the batch segment job. The status is one of the following values:

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED