Skip to content

InferenceRecommendationsJob

Source code in docs_src/capo_sagemaker/types/inference_recommendations_job.py
class InferenceRecommendationsJob(TypedDict, closed=True):
    job_name: NotRequired[
        "capo_sagemaker.types.recommendation_job_name.RecommendationJobName"
    ]
    """<p>The name of the job.</p>"""
    job_description: NotRequired[
        "capo_sagemaker.types.recommendation_job_description.RecommendationJobDescription"
    ]
    """<p>The job description.</p>"""
    job_type: NotRequired[
        "capo_sagemaker.types.recommendation_job_type.RecommendationJobType"
    ]
    """<p>The recommendation job type.</p>"""
    job_arn: NotRequired[
        "capo_sagemaker.types.recommendation_job_arn.RecommendationJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the recommendation job.</p>"""
    status: NotRequired[
        "capo_sagemaker.types.recommendation_job_status.RecommendationJobStatus"
    ]
    """<p>The status of the job.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>A timestamp that shows when the job was created.</p>"""
    completion_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A timestamp that shows when the job completed.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>A timestamp that shows when the job was last modified.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If the job fails, provides information why the job failed.</p>"""
    model_name: NotRequired["capo_sagemaker.types.model_name.ModelName"]
    """<p>The name of the created model.</p>"""
    sample_payload_url: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).</p>"""
    model_package_version_arn: NotRequired[
        "capo_sagemaker.types.model_package_arn.ModelPackageArn"
    ]
    """<p>The Amazon Resource Name (ARN) of a versioned model package.</p>"""

completion_time instance-attribute

completion_time: NotRequired[Timestamp]

A timestamp that shows when the job completed.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

A timestamp that shows when the job was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the job fails, provides information why the job failed.

job_arn instance-attribute

job_arn: NotRequired[RecommendationJobArn]

The Amazon Resource Name (ARN) of the recommendation job.

job_description instance-attribute

job_description: NotRequired[RecommendationJobDescription]

The job description.

job_name instance-attribute

job_name: NotRequired[RecommendationJobName]

The name of the job.

job_type instance-attribute

job_type: NotRequired[RecommendationJobType]

The recommendation job type.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

A timestamp that shows when the job was last modified.

model_name instance-attribute

model_name: NotRequired[ModelName]

The name of the created model.

model_package_version_arn instance-attribute

model_package_version_arn: NotRequired[ModelPackageArn]

The Amazon Resource Name (ARN) of a versioned model package.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

sample_payload_url instance-attribute

sample_payload_url: NotRequired[S3Uri]

The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).

status instance-attribute

status: NotRequired[RecommendationJobStatus]

The status of the job.