Skip to content

DescribeAIRecommendationJobResponse

Source code in docs_src/capo_sagemaker/types/describe_ai_recommendation_job_response.py
class DescribeAIRecommendationJobResponse(TypedDict, closed=True):
    ai_recommendation_job_name: NotRequired[
        "capo_sagemaker.types.ai_entity_name.AIEntityName"
    ]
    """<p>The name of the AI recommendation job.</p>"""
    ai_recommendation_job_arn: NotRequired[
        "capo_sagemaker.types.ai_recommendation_job_arn.AIRecommendationJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the AI recommendation job.</p>"""
    ai_recommendation_job_status: NotRequired[
        "capo_sagemaker.types.ai_recommendation_job_status.AIRecommendationJobStatus"
    ]
    """<p>The status of the AI recommendation job.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If the recommendation job failed, the reason it failed.</p>"""
    model_source: NotRequired["capo_sagemaker.types.ai_model_source.AIModelSource"]
    """<p>The source of the model that was analyzed.</p>"""
    output_config: NotRequired[
        "capo_sagemaker.types.ai_recommendation_output_result.AIRecommendationOutputResult"
    ]
    """<p>The output configuration for the recommendation job.</p>"""
    inference_specification: NotRequired[
        "capo_sagemaker.types.ai_recommendation_inference_specification.AIRecommendationInferenceSpecification"
    ]
    """<p>The inference framework configuration.</p>"""
    ai_workload_config_identifier: NotRequired[
        "capo_sagemaker.types.ai_resource_identifier.AIResourceIdentifier"
    ]
    """<p>The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.</p>"""
    optimize_model: NotRequired[
        "capo_sagemaker.types.ai_recommendation_allow_optimization.AIRecommendationAllowOptimization"
    ]
    """<p>Whether model optimization techniques were allowed.</p>"""
    performance_target: NotRequired[
        "capo_sagemaker.types.ai_recommendation_performance_target.AIRecommendationPerformanceTarget"
    ]
    """<p>The performance targets specified for the recommendation job.</p>"""
    recommendations: NotRequired[
        "capo_sagemaker.types.ai_recommendation_list.AIRecommendationList"
    ]
    """<p>The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.</p>"""
    compute_spec: NotRequired[
        "capo_sagemaker.types.ai_recommendation_compute_spec.AIRecommendationComputeSpec"
    ]
    """<p>The compute resource specification for the recommendation job.</p>"""
    adapter_source: NotRequired[
        "capo_sagemaker.types.ai_adapter_source.AIAdapterSource"
    ]
    """<p>The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates when the recommendation job was created.</p>"""
    start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates when the recommendation job started running.</p>"""
    end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>A timestamp that indicates when the recommendation job completed.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>The tags associated with the recommendation job.</p>"""

adapter_source instance-attribute

adapter_source: NotRequired[AIAdapterSource]

The LoRA adapter source that you specified when you created the recommendation job. This field is absent when you created the job without LoRA adapters.

ai_recommendation_job_arn instance-attribute

ai_recommendation_job_arn: NotRequired[AIRecommendationJobArn]

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

ai_recommendation_job_name instance-attribute

ai_recommendation_job_name: NotRequired[AIEntityName]

The name of the AI recommendation job.

ai_recommendation_job_status instance-attribute

ai_recommendation_job_status: NotRequired[AIRecommendationJobStatus]

The status of the AI recommendation job.

ai_workload_config_identifier instance-attribute

ai_workload_config_identifier: NotRequired[AIResourceIdentifier]

The name or Amazon Resource Name (ARN) of the AI workload configuration used for this recommendation job.

compute_spec instance-attribute

compute_spec: NotRequired[AIRecommendationComputeSpec]

The compute resource specification for the recommendation job.

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

A timestamp that indicates when the recommendation job was created.

end_time instance-attribute

end_time: NotRequired[Timestamp]

A timestamp that indicates when the recommendation job completed.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the recommendation job failed, the reason it failed.

inference_specification instance-attribute

inference_specification: NotRequired[AIRecommendationInferenceSpecification]

The inference framework configuration.

model_source instance-attribute

model_source: NotRequired[AIModelSource]

The source of the model that was analyzed.

optimize_model instance-attribute

optimize_model: NotRequired[AIRecommendationAllowOptimization]

Whether model optimization techniques were allowed.

output_config instance-attribute

output_config: NotRequired[AIRecommendationOutputResult]

The output configuration for the recommendation job.

performance_target instance-attribute

performance_target: NotRequired[AIRecommendationPerformanceTarget]

The performance targets specified for the recommendation job.

recommendations instance-attribute

recommendations: NotRequired[AIRecommendationList]

The list of optimization recommendations generated by the job. Each recommendation includes optimization details, deployment configuration, expected performance metrics, and the associated benchmark job ARN.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM role used by the recommendation job.

start_time instance-attribute

start_time: NotRequired[Timestamp]

A timestamp that indicates when the recommendation job started running.

tags instance-attribute

tags: NotRequired[TagList]

The tags associated with the recommendation job.