Skip to content

Bedrock Agentcore  >  Operations  >  get_recommendation

get_recommendation

Operation

get_recommendation async

get_recommendation(input: GetRecommendationInput, plugins: list[Plugin] | None = None) -> GetRecommendationOutput

Retrieves detailed information about a recommendation, including its configuration, status, and results.

Parameters:

Name Type Description Default
input GetRecommendationInput

An instance of GetRecommendationInput.

required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
GetRecommendationOutput

An instance of GetRecommendationOutput.

Input

GetRecommendationInput dataclass

Dataclass for GetRecommendationInput structure.

Attributes

recommendation_id class-attribute instance-attribute
recommendation_id: str | None = None

The unique identifier of the recommendation to retrieve.

Output

GetRecommendationOutput dataclass

Dataclass for GetRecommendationOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

The timestamp when the recommendation was created.

description class-attribute instance-attribute
description: str | None = None

The description of the recommendation.

kms_key_arn class-attribute instance-attribute
kms_key_arn: str | None = None

The ARN of the KMS key used to encrypt recommendation data.

name instance-attribute
name: str

The name of the recommendation.

recommendation_arn instance-attribute
recommendation_arn: str

The Amazon Resource Name (ARN) of the recommendation.

recommendation_config instance-attribute
recommendation_config: RecommendationConfig

The configuration for the recommendation.

recommendation_id instance-attribute
recommendation_id: str

The unique identifier of the recommendation.

recommendation_result class-attribute instance-attribute
recommendation_result: RecommendationResult | None = None

The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is COMPLETED.

status instance-attribute

The current status of the recommendation.

type instance-attribute

The type of recommendation.

updated_at instance-attribute
updated_at: datetime

The timestamp when the recommendation was last updated.