get_recommendation¶
Operation¶
get_recommendation
¶
get_recommendation(request: GetRecommendationInput | GetRecommendationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRecommendationInputDict]) -> GetRecommendationOutput
Retrieves detailed information about a recommendation, including its configuration, status, and results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetRecommendationInput | GetRecommendationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetRecommendationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetRecommendationOutput
|
An instance of |
get_recommendation
async
¶
get_recommendation(request: GetRecommendationInput | GetRecommendationInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetRecommendationInputDict]) -> GetRecommendationOutput
Retrieves detailed information about a recommendation, including its configuration, status, and results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetRecommendationInput | GetRecommendationInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetRecommendationInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetRecommendationOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetRecommendationOutput
dataclass
¶
Bases: _SerdeShape
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 = ...
The description of the recommendation.
kms_key_arn
class-attribute
instance-attribute
¶
kms_key_arn: str | None = ...
The ARN of the KMS key used to encrypt recommendation data.
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 = ...
The result of the recommendation, containing the optimized system prompt
or tool descriptions. Only present when the recommendation status is
COMPLETED.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.