Skip to content

BatchInferenceJob

Source code in docs_src/capo_personalize/types/batch_inference_job.py
class BatchInferenceJob(TypedDict, closed=True):
    job_name: NotRequired["capo_personalize.types.name.Name"]
    """<p>The name of the batch inference job.</p>"""
    batch_inference_job_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The Amazon Resource Name (ARN) of the batch inference job.</p>"""
    filter_arn: NotRequired["capo_personalize.types.arn.Arn"]
    """<p>The ARN of the filter used on the batch inference job.</p>"""
    failure_reason: NotRequired["capo_personalize.types.failure_reason.FailureReason"]
    """<p>If the batch inference 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 from which the batch inference job was created.</p>"""
    num_results: NotRequired["capo_personalize.types.num_batch_results.NumBatchResults"]
    """<p>The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.</p>"""
    job_input: NotRequired[
        "capo_personalize.types.batch_inference_job_input.BatchInferenceJobInput"
    ]
    """<p>The Amazon S3 path that leads to the input data used to generate the batch inference job.</p>"""
    job_output: NotRequired[
        "capo_personalize.types.batch_inference_job_output.BatchInferenceJobOutput"
    ]
    """<p>The Amazon S3 bucket that contains the output data generated by the batch inference job.</p>"""
    batch_inference_job_config: NotRequired[
        "capo_personalize.types.batch_inference_job_config.BatchInferenceJobConfig"
    ]
    """<p>A string to string map of the configuration details of a batch inference 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 inference job.</p>"""
    batch_inference_job_mode: NotRequired[
        "capo_personalize.types.batch_inference_job_mode.BatchInferenceJobMode"
    ]
    """<p>The job's mode.</p>"""
    theme_generation_config: NotRequired[
        "capo_personalize.types.theme_generation_config.ThemeGenerationConfig"
    ]
    """<p>The job's theme generation settings.</p>"""
    status: NotRequired["capo_personalize.types.status.Status"]
    """<p>The status of the batch inference 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 inference job was created.</p>"""
    last_updated_date_time: NotRequired["capo_personalize.types.date.Date"]
    """<p>The time at which the batch inference job was last updated.</p>"""

batch_inference_job_arn instance-attribute

batch_inference_job_arn: NotRequired[Arn]

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

batch_inference_job_config instance-attribute

batch_inference_job_config: NotRequired[BatchInferenceJobConfig]

A string to string map of the configuration details of a batch inference job.

batch_inference_job_mode instance-attribute

batch_inference_job_mode: NotRequired[BatchInferenceJobMode]

The job's mode.

creation_date_time instance-attribute

creation_date_time: NotRequired[Date]

The time at which the batch inference job was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

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

filter_arn instance-attribute

filter_arn: NotRequired[Arn]

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

job_input instance-attribute

job_input: NotRequired[BatchInferenceJobInput]

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

job_name instance-attribute

job_name: NotRequired[Name]

The name of the batch inference job.

job_output instance-attribute

job_output: NotRequired[BatchInferenceJobOutput]

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

last_updated_date_time instance-attribute

last_updated_date_time: NotRequired[Date]

The time at which the batch inference job was last updated.

num_results instance-attribute

num_results: NotRequired[NumBatchResults]

The number of recommendations generated by the batch inference job. This number includes the error messages generated for failed input records.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

solution_version_arn instance-attribute

solution_version_arn: NotRequired[Arn]

The Amazon Resource Name (ARN) of the solution version from which the batch inference job was created.

status instance-attribute

status: NotRequired[Status]

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

  • PENDING

  • IN PROGRESS

  • ACTIVE

  • CREATE FAILED

theme_generation_config instance-attribute

theme_generation_config: NotRequired[ThemeGenerationConfig]

The job's theme generation settings.