Skip to main content

recommendations

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

Overview

Namerecommendations
TypeResource
Idaws.devops_agent.recommendations

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
additional_contextstringAdditional context for recommendation
agent_space_arnstringARN of the agent space this recommendation belongs to
contentobjectContent of the recommendation
created_atstring (date-time)Timestamp when this recommendation was created
goal_idstringID of the goal this recommendation is associated with
goal_versioninteger (int64)Version of the goal at the time this recommendation was generated
prioritystringPriority level of the recommendation (HIGH, MEDIUM, LOW)
rank_positionintegerPosition in ranked list (1 = highest priority)
ranked_atstring (date-time)Timestamp when the recommendation was last ranked
recommendation_idstringThe unique identifier for this recommendation
statusstringCurrent status of the recommendation (PROPOSED, ACCEPTED, REJECTED, CLOSED, COMPLETED, UPDATE_IN_PROGRESS)
task_idstringID of the task that generated the recommendation
title_stringThe title of the recommendation
updated_atstring (date-time)Timestamp when this recommendation was last updated
versioninteger (int64)Version number for optimistic locking

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_recommendationselectagent_space_id, recommendation_id, regionrecommendationVersionRetrieves a specific recommendation by its ID
list_recommendationsselectagent_space_id, regionLists recommendations for the specified agent space
update_recommendationupdateagent_space_id, recommendation_id, regionUpdates an existing recommendation with new content, status, or metadata

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.

NameDatatypeDescription
agent_space_idstringThe unique identifier for the agent space containing the recommendation
recommendation_idstringThe unique identifier for the recommendation to update
regionstringAWS region (default: us-east-1)
recommendationVersioninteger (int64)Specific version of the recommendation to retrieve. If not specified, returns the latest version.

SELECT examples

Retrieves a specific recommendation by its ID

SELECT
additional_context,
agent_space_arn,
content,
created_at,
goal_id,
goal_version,
priority,
rank_position,
ranked_at,
recommendation_id,
status,
task_id,
title_,
updated_at,
version
FROM aws.devops_agent.recommendations
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND recommendation_id = '{{ recommendation_id }}' -- required
AND region = '{{ region }}' -- required
AND recommendationVersion = '{{ recommendationVersion }}'
;

UPDATE examples

Updates an existing recommendation with new content, status, or metadata

UPDATE aws.devops_agent.recommendations
SET
status = '{{ status }}',
additionalContext = '{{ additionalContext }}',
clientToken = '{{ clientToken }}'
WHERE
agent_space_id = '{{ agent_space_id }}' --required
AND recommendation_id = '{{ recommendation_id }}' --required
AND region = '{{ region }}' --required
RETURNING
recommendation;