describe_recommender ¶

describe_recommender(
    recommender_arn: Arn, *, config_overrides: Optional[PersonalizeClientConfig] = None
) -> DescribeRecommenderResponse

Describes the given recommender, including its status.

A recommender can be in one of the following states:

CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE
DELETE PENDING > DELETE IN_PROGRESS

When the status is CREATE FAILED, the response includes the failureReason key, which describes why.

The modelMetrics key is null when the recommender is being created or deleted.

For more information on recommenders, see CreateRecommender.

Parameters:

recommender_arn (Arn) –

The Amazon Resource Name (ARN) of the recommender to describe.

Raises:

InvalidInputException –

Provide a valid value for the field or parameter.
ResourceNotFoundException –

Could not find the specified resource.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_personalize/_services/personalize.py

def describe_recommender(
    self,
    recommender_arn: "capo_personalize.types.arn.Arn",
    *,
    config_overrides: Optional[PersonalizeClientConfig] = None,
) -> "capo_personalize.types.describe_recommender_response.DescribeRecommenderResponse":
    """<p>Describes the given recommender, including its status.</p> <p>A recommender can be in one of the following states:</p> <ul> <li> <p>CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED</p> </li> <li> <p>STOP PENDING > STOP IN_PROGRESS > INACTIVE > START PENDING > START IN_PROGRESS > ACTIVE</p> </li> <li> <p>DELETE PENDING > DELETE IN_PROGRESS</p> </li> </ul> <p>When the <code>status</code> is <code>CREATE FAILED</code>, the response includes the <code>failureReason</code> key, which describes why.</p> <p>The <code>modelMetrics</code> key is null when the recommender is being created or deleted.</p> <p>For more information on recommenders, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/API_CreateRecommender.html">CreateRecommender</a>.</p>

    Args:
        recommender_arn: <p>The Amazon Resource Name (ARN) of the recommender to describe.</p>

    Raises:
        capo_personalize.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_personalize.types.describe_recommender_request.DescribeRecommenderRequest]",
    ) -> OperationResponse[
        "capo_personalize.types.describe_recommender_response.DescribeRecommenderResponse"
    ]:
        import capo_personalize._operations.amazon_personalize.describe_recommender

        output, http_response = (
            capo_personalize._operations.amazon_personalize.describe_recommender.describe_recommender(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRecommender")
    )
    input_: capo_personalize.types.describe_recommender_request.DescribeRecommenderRequest = {
        "recommender_arn": recommender_arn
    }

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