agent_recommendations

Creates, updates, deletes, gets or lists an agent_recommendations resource.

Overview

Name	agent_recommendations
Type	Resource
Id	aws.wellarchitected.agent_recommendations

Fields

The following fields are returned by SELECT queries:

get_agent_recommendation

Name	Datatype	Description
applications	array	The applications that the recommendation targets.
aws_services	array	The Amazon Web Services services that the recommendation applies to.
business_units	array	The business units that own the affected resources.
created_at	string (date-time)	The timestamp when the recommendation was created.
created_by	string	The identifier of the user or system that created this recommendation.
cross_pillar_benefits	array	Cross-pillar benefits of acting on the recommendation.
description	string	A description of the recommendation.
effort	string	The effort required to implement the recommendation. (LARGE, MEDIUM, SMALL)
goals	array	Goals that this recommendation targets.
highlights	array	Highlights describing what was detected.
impact	string	The severity of the recommendation's impact. (HIGH, MEDIUM, LOW)
impact_details	array	Detailed impact information for the recommendation.
insights	array	A list of insights about the recommendation.
last_modified_at	string (date-time)	The timestamp when the recommendation was last modified.
last_modified_by	string	The identifier of the user or system that last modified this recommendation.
number_of_resources	integer	The number of Amazon Web Services resources this recommendation affects.
pillar	string	The Well-Architected Tool Framework pillar that the recommendation addresses. (COST_OPTIMIZATION, SECURITY, RESILIENCE, PERFORMANCE, OPERATIONAL_EXCELLENCE)
priority	string	The priority of the recommendation. (HIGH, MEDIUM, LOW)
profile_arn	string	The Amazon Resource Name (ARN) of the associated profile. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
recommendation_arn	string	The Amazon Resource Name (ARN) of the recommendation. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
remediation_summary	object	A high-level summary of the recommended remediation.
remediations	array	A list of remediations for the recommendation.
roi	object	The return on investment estimate for the recommendation.
sources	array	Sources that generated this recommendation.
state	string	The current state of the recommendation. (OPEN, CLOSED)
status	string	The current status of the recommendation. (ACTIVE, SUPPRESSED, COMPLETED)
tags	array	A set of key-value pairs associated with the recommendation, used for cost allocation and access control.
title_	string	The title of the recommendation.
trade_offs	array	Trade-offs of acting on the recommendation.
type_	string	The type of the recommendation. (RESOURCE, ARCHITECTURE, APPLICATION)
update_reason	string	The free-text reason associated with the recommendation's most recent status update.

list_agent_recommendations

Name	Datatype	Description
applications	array	The applications that the recommendation targets.
aws_services	array	The Amazon Web Services services that the recommendation applies to.
business_units	array	The business units that own the affected resources.
created_at	string (date-time)	The timestamp when the recommendation was created.
created_by	string	The identifier of the user or system that created this recommendation.
description	string	A description of the recommendation.
effort	string	The effort required to implement the recommendation. (LARGE, MEDIUM, SMALL)
impact	string	The severity of the recommendation's impact. (HIGH, MEDIUM, LOW)
last_modified_at	string (date-time)	The timestamp when the recommendation was last modified.
last_modified_by	string	The identifier of the user or system that last modified this recommendation.
number_of_resources	integer	The number of Amazon Web Services resources this recommendation affects.
pillar	string	The Well-Architected Tool Framework pillar that the recommendation addresses. (COST_OPTIMIZATION, SECURITY, RESILIENCE, PERFORMANCE, OPERATIONAL_EXCELLENCE)
priority	string	The priority of the recommendation. (HIGH, MEDIUM, LOW)
profile_arn	string	The Amazon Resource Name (ARN) of the associated profile. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)</code>)
recommendation_arn	string	The Amazon Resource Name (ARN) of the recommendation. (pattern: <code>arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>)
roi	object	The return on investment estimate for the recommendation.
state	string	The current state of the recommendation. (OPEN, CLOSED)
status	string	The current status of the recommendation. (ACTIVE, SUPPRESSED, COMPLETED)
title_	string	The title of the recommendation.
type_	string	The type of the recommendation. (RESOURCE, ARCHITECTURE, APPLICATION)
update_reason	string	The free-text reason associated with the recommendation's most recent status update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_recommendation	select	recommendation_arn, region	remediationType	Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.
list_agent_recommendations	select	profile_arn, region	maxResults, nextToken, state, pillar	Lists active optimization recommendations for a specified profile with optional filtering by state.
update_agent_recommendation_status	update	recommendation_arn, region, status		Updates the status of a recommendation to track its progress through the implementation lifecycle.
put_agent_recommendation_feedback	replace	recommendation_arn, region, type		Submits user feedback on a recommendation to help improve future optimization suggestions and track implementation outcomes.
start_agent_recommendation_generation	exec	profile_arn, region, types, scope		Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status.

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
profile_arn	string	The Amazon Resource Name (ARN) of the optimization profile to use for generating recommendations.
recommendation_arn	string	The Amazon Resource Name (ARN) of the recommendation to provide feedback for.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of recommendations to return in a single response.
nextToken	string	A pagination token returned from a previous call to continue retrieving results.
pillar	string	Optional filter to return only recommendations for the specified pillar.
remediationType	string	Optional filter on remediation type.
state	string	Optional filter to return only recommendations with the specified state (OPEN or CLOSED).

SELECT examples

get_agent_recommendation

Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.

SELECT
applications,
aws_services,
business_units,
created_at,
created_by,
cross_pillar_benefits,
description,
effort,
goals,
highlights,
impact,
impact_details,
insights,
last_modified_at,
last_modified_by,
number_of_resources,
pillar,
priority,
profile_arn,
recommendation_arn,
remediation_summary,
remediations,
roi,
sources,
state,
status,
tags,
title_,
trade_offs,
type_,
update_reason
FROM aws.wellarchitected.agent_recommendations
WHERE recommendation_arn = '{{ recommendation_arn }}' -- required
AND region = '{{ region }}' -- required
AND remediationType = '{{ remediationType }}'
;

list_agent_recommendations

Lists active optimization recommendations for a specified profile with optional filtering by state.

SELECT
applications,
aws_services,
business_units,
created_at,
created_by,
description,
effort,
impact,
last_modified_at,
last_modified_by,
number_of_resources,
pillar,
priority,
profile_arn,
recommendation_arn,
roi,
state,
status,
title_,
type_,
update_reason
FROM aws.wellarchitected.agent_recommendations
WHERE profile_arn = '{{ profile_arn }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND state = '{{ state }}'
AND pillar = '{{ pillar }}'
;

UPDATE examples

update_agent_recommendation_status

Updates the status of a recommendation to track its progress through the implementation lifecycle.

UPDATE aws.wellarchitected.agent_recommendations
SET 
status = '{{ status }}',
updateReason = '{{ updateReason }}'
WHERE 
recommendation_arn = '{{ recommendation_arn }}' --required
AND region = '{{ region }}' --required
AND status = '{{ status }}' --required;

REPLACE examples

put_agent_recommendation_feedback

Submits user feedback on a recommendation to help improve future optimization suggestions and track implementation outcomes.

REPLACE aws.wellarchitected.agent_recommendations
SET 
type = '{{ type }}',
feedbackCategory = '{{ feedbackCategory }}',
comments = '{{ comments }}'
WHERE 
recommendation_arn = '{{ recommendation_arn }}' --required
AND region = '{{ region }}' --required
AND type = '{{ type }}' --required;

Lifecycle Methods

start_agent_recommendation_generation

Initiates a new recommendation generation process for the specified optimization profile. This asynchronous operation analyzes your Amazon Web Services resources and generates optimization recommendations based on the configured pillars and scope. Use GetAgentRecommendationGeneration to check status.

EXEC aws.wellarchitected.agent_recommendations.start_agent_recommendation_generation 
@profile_arn='{{ profile_arn }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"types": "{{ types }}", 
"name": "{{ name }}", 
"additionalContext": "{{ additionalContext }}", 
"scope": "{{ scope }}"
}'
;