recommendations

Creates, updates, deletes, gets or lists a recommendations resource.

Overview

Name	recommendations
Type	Resource
Id	aws.bedrock_agentcore.recommendations

Fields

The following fields are returned by SELECT queries:

get_recommendation

Name	Datatype	Description
name	string	The name of the recommendation. (pattern: <code>[a-zA-Z][a-zA-Z0-9_-]{0,47}</code>)
created_at	string (date-time)	The timestamp when the recommendation was created.
description	string	The description of the recommendation.
kms_key_arn	string	The ARN of the KMS key used to encrypt recommendation data. (pattern: <code>arn:aws(|-cn|-us-gov):kms:[a-zA-Z0-9-]*:[0-9]{12}:key/[a-zA-Z0-9-]{36}</code>)
recommendation_arn	string	The Amazon Resource Name (ARN) of the recommendation. (pattern: <code>arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:recommendation/[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}</code>)
recommendation_config	object	The configuration for the recommendation.
recommendation_id	string	The unique identifier of the recommendation. (pattern: <code>[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}</code>)
recommendation_result	object	The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is COMPLETED.
status	string	The current status of the recommendation. (PENDING, IN_PROGRESS, COMPLETED, FAILED, DELETING)
type_	string	The type of recommendation. (SYSTEM_PROMPT_RECOMMENDATION, TOOL_DESCRIPTION_RECOMMENDATION)
updated_at	string (date-time)	The timestamp when the recommendation was last updated.

list_recommendations

Name	Datatype	Description
name	string	The name of the recommendation. (pattern: <code>[a-zA-Z][a-zA-Z0-9_-]{0,47}</code>)
created_at	string (date-time)	The timestamp when the recommendation was created.
description	string	The description of the recommendation.
recommendation_arn	string	The Amazon Resource Name (ARN) of the recommendation. (pattern: <code>arn:aws[a-zA-Z-]*:bedrock-agentcore:[a-z0-9-]+:[0-9]{12}:recommendation/[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}</code>)
recommendation_id	string	The unique identifier of the recommendation. (pattern: <code>[0-9a-zA-Z_-]{1,48}-[0-9A-Z]{10}</code>)
status	string	The lifecycle status of a recommendation. (PENDING, IN_PROGRESS, COMPLETED, FAILED, DELETING)
type_	string	The type of recommendation. (SYSTEM_PROMPT_RECOMMENDATION, TOOL_DESCRIPTION_RECOMMENDATION)
updated_at	string (date-time)	The timestamp when the recommendation was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recommendation	select	recommendation_id, region		Retrieves detailed information about a recommendation, including its configuration, status, and results.
list_recommendations	select	region	maxResults, nextToken, status	Lists all recommendations in the account, with optional filtering by status.
delete_recommendation	delete	recommendation_id, region		Deletes a recommendation and its associated results.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
recommendation_id	string	The unique identifier of the recommendation to delete.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken	string	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
status	string	Optional filter to return only recommendations with the specified status.

SELECT examples

get_recommendation

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

SELECT
name,
created_at,
description,
kms_key_arn,
recommendation_arn,
recommendation_config,
recommendation_id,
recommendation_result,
status,
type_,
updated_at
FROM aws.bedrock_agentcore.recommendations
WHERE recommendation_id = '{{ recommendation_id }}' -- required
AND region = '{{ region }}' -- required
;

list_recommendations

Lists all recommendations in the account, with optional filtering by status.

SELECT
name,
created_at,
description,
recommendation_arn,
recommendation_id,
status,
type_,
updated_at
FROM aws.bedrock_agentcore.recommendations
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND status = '{{ status }}'
;

DELETE examples

delete_recommendation

Deletes a recommendation and its associated results.

DELETE FROM aws.bedrock_agentcore.recommendations
WHERE recommendation_id = '{{ recommendation_id }}' --required
AND region = '{{ region }}' --required
;