Skip to content

describe_ai_recommendation_job

describe_ai_recommendation_job(
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    ai_recommendation_job_name: Optional[AIEntityName] = None,
) -> DescribeAIRecommendationJobResponse

Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.

Parameters:

  • ai_recommendation_job_name (Optional[AIEntityName], default: None ) –

    The name of the AI recommendation job to describe.

Raises:

Source code in docs_src/capo_sagemaker/_services/sage_maker.py
def describe_ai_recommendation_job(
    self,
    *,
    config_overrides: Optional[SageMakerClientConfig] = None,
    ai_recommendation_job_name: Optional[
        "capo_sagemaker.types.ai_entity_name.AIEntityName"
    ] = None,
) -> "capo_sagemaker.types.describe_ai_recommendation_job_response.DescribeAIRecommendationJobResponse":
    """<p>Returns details of an AI recommendation job, including its status, model source, performance targets, optimization recommendations, and deployment configurations.</p>

    Args:
        ai_recommendation_job_name: <p>The name of the AI recommendation job to describe.</p>

    Raises:
        capo_sagemaker.errors.resource_not_found.ResourceNotFound: <p>Resource being access is not found.</p>
        capo_sagemaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sagemaker.types.describe_ai_recommendation_job_request.DescribeAIRecommendationJobRequest]",
    ) -> OperationResponse[
        "capo_sagemaker.types.describe_ai_recommendation_job_response.DescribeAIRecommendationJobResponse"
    ]:
        import capo_sagemaker._operations.sage_maker.describe_ai_recommendation_job

        output, http_response = (
            capo_sagemaker._operations.sage_maker.describe_ai_recommendation_job.describe_ai_recommendation_job(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAIRecommendationJob")
    )
    input_: capo_sagemaker.types.describe_ai_recommendation_job_request.DescribeAIRecommendationJobRequest = {}
    if ai_recommendation_job_name is not None:
        input_["ai_recommendation_job_name"] = ai_recommendation_job_name

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output