recommendations
Creates, updates, deletes, gets or lists a recommendations resource.
Overview
| Name | recommendations |
| Type | Resource |
| Id | aws.devops_agent.recommendations |
Fields
The following fields are returned by SELECT queries:
- get_recommendation
- list_recommendations
| Name | Datatype | Description |
|---|---|---|
additional_context | string | Additional context for recommendation |
agent_space_arn | string | ARN of the agent space this recommendation belongs to |
content | object | Content of the recommendation |
created_at | string (date-time) | Timestamp when this recommendation was created |
goal_id | string | ID of the goal this recommendation is associated with |
goal_version | integer (int64) | Version of the goal at the time this recommendation was generated |
priority | string | Priority level of the recommendation (HIGH, MEDIUM, LOW) |
rank_position | integer | Position in ranked list (1 = highest priority) |
ranked_at | string (date-time) | Timestamp when the recommendation was last ranked |
recommendation_id | string | The unique identifier for this recommendation |
status | string | Current status of the recommendation (PROPOSED, ACCEPTED, REJECTED, CLOSED, COMPLETED, UPDATE_IN_PROGRESS) |
task_id | string | ID of the task that generated the recommendation |
title_ | string | The title of the recommendation |
updated_at | string (date-time) | Timestamp when this recommendation was last updated |
version | integer (int64) | Version number for optimistic locking |
| Name | Datatype | Description |
|---|---|---|
next_token | string | Token for retrieving the next page of results, if more results are available |
recommendations | array | List of recommendations matching the request criteria |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_recommendation | select | agent_space_id, recommendation_id, region | recommendationVersion | Retrieves a specific recommendation by its ID |
list_recommendations | select | agent_space_id, region | Lists recommendations for the specified agent space | |
update_recommendation | update | agent_space_id, recommendation_id, region | Updates 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.
| Name | Datatype | Description |
|---|---|---|
agent_space_id | string | The unique identifier for the agent space containing the recommendation |
recommendation_id | string | The unique identifier for the recommendation to update |
region | string | AWS region (default: us-east-1) |
recommendationVersion | integer (int64) | Specific version of the recommendation to retrieve. If not specified, returns the latest version. |
SELECT examples
- get_recommendation
- list_recommendations
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 }}'
;
Lists recommendations for the specified agent space
SELECT
next_token,
recommendations
FROM aws.devops_agent.recommendations
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples
- update_recommendation
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;