recommendations

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

Overview

Name	recommendations
Type	Resource
Id	aws.trustedadvisor.recommendations

Fields

The following fields are returned by SELECT queries:

get_recommendation

Name	Datatype	Description
id	string	The ID which identifies where the Recommendation was produced
name	string	The name of the AWS Trusted Advisor Recommendation
arn	string	The ARN of the Recommendation (pattern: <code>arn:[\w-]+:trustedadvisor::\d{12}:recommendation/[\w-]+</code>)
aws_services	array	The AWS Services that the Recommendation applies to
check_arn	string	The AWS Trusted Advisor Check ARN that relates to the Recommendation
created_at	string (date-time)	When the Recommendation was created, if created by AWS Trusted Advisor Priority
created_by	string	The creator, if created by AWS Trusted Advisor Priority
description	string	A description for AWS Trusted Advisor recommendations
last_updated_at	string (date-time)	When the Recommendation was last updated
lifecycle_stage	string	The lifecycle stage from AWS Trusted Advisor Priority (in_progress, pending_response, dismissed, resolved)
pillar_specific_aggregates	object	The pillar aggregations for cost savings
pillars	array	The Pillars that the Recommendation is optimizing
resolved_at	string (date-time)	When the Recommendation was resolved
resources_aggregates	object	An aggregation of all resources
source	string	The source of the Recommendation (aws_config, compute_optimizer, cost_explorer, lse, manual, pse, rds, resilience, resilience_hub, security_hub, stir, ta_check, well_architected, cost_optimization_hub)
status	string	The status of the Recommendation (ok, warning, error)
status_reason	string	This attribute provides additional details about potential discrepancies in check status determination. (no_data_ok)
type_	string	Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority (standard, priority)
update_reason	string	Reason for the lifecycle stage change (pattern: <code>[\s\S]*</code>)
update_reason_code	string	Reason code for the lifecycle state change (non_critical_account, temporary_account, valid_business_case, other_methods_available, low_priority, not_applicable, other)
updated_on_behalf_of	string	The person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority
updated_on_behalf_of_job_title	string	The job title of the person on whose behalf a Technical Account Manager (TAM) updated the recommendation. This information is only available when a Technical Account Manager takes an action on a recommendation managed by AWS Trusted Advisor Priority

list_recommendations

Name	Datatype	Description
id	string	The ID which identifies where the Recommendation was produced
name	string	The name of the AWS Trusted Advisor Recommendation
arn	string	The ARN of the Recommendation (pattern: <code>arn:[\w-]+:trustedadvisor::\d{12}:recommendation/[\w-]+</code>)
aws_services	array	The AWS Services that the Recommendation applies to
check_arn	string	The AWS Trusted Advisor Check ARN that relates to the Recommendation
created_at	string (date-time)	When the Recommendation was created, if created by AWS Trusted Advisor Priority
last_updated_at	string (date-time)	When the Recommendation was last updated
lifecycle_stage	string	The lifecycle stage from AWS Trusted Advisor Priority (in_progress, pending_response, dismissed, resolved)
pillar_specific_aggregates	object	The pillar aggregations for cost savings
pillars	array	The Pillars that the Recommendation is optimizing
resources_aggregates	object	An aggregation of all resources
source	string	The source of the Recommendation (aws_config, compute_optimizer, cost_explorer, lse, manual, pse, rds, resilience, resilience_hub, security_hub, stir, ta_check, well_architected, cost_optimization_hub)
status	string	The status of the Recommendation (ok, warning, error)
status_reason	string	This attribute provides additional details about potential discrepancies in check status determination. (no_data_ok)
type_	string	Whether the Recommendation was automated or generated by AWS Trusted Advisor Priority (standard, priority)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_recommendation	select	recommendation_identifier, region	language	Get a specific Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
list_recommendations	select	region	nextToken, maxResults, type, status, pillar, awsService, source, checkIdentifier, afterLastUpdatedAt, beforeLastUpdatedAt, language	List a filterable set of Recommendations. This API provides global recommendations, eliminating the need to call the API in each AWS Region.
update_recommendation_lifecycle	update	recommendation_identifier, region, lifecycleStage		Update the lifecyle of a Recommendation. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region.

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_identifier	string	The Recommendation identifier for AWS Trusted Advisor Priority recommendations
region	string	AWS region (default: us-east-1)
afterLastUpdatedAt	string (date-time)	After the last update of the Recommendation
awsService	string	The aws service associated with the Recommendation
beforeLastUpdatedAt	string (date-time)	Before the last update of the Recommendation
checkIdentifier	string	The check identifier of the Recommendation
language	string	The ISO 639-1 code for the language that you want your recommendations to appear in.
maxResults	integer	The maximum number of results to return per page.
nextToken	string	The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
pillar	string	The pillar of the Recommendation
source	string	The source of the Recommendation
status	string	The status of the Recommendation
type	string	The type of the Recommendation

SELECT examples

get_recommendation

Get a specific Recommendation. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

SELECT
id,
name,
arn,
aws_services,
check_arn,
created_at,
created_by,
description,
last_updated_at,
lifecycle_stage,
pillar_specific_aggregates,
pillars,
resolved_at,
resources_aggregates,
source,
status,
status_reason,
type_,
update_reason,
update_reason_code,
updated_on_behalf_of,
updated_on_behalf_of_job_title
FROM aws.trustedadvisor.recommendations
WHERE recommendation_identifier = '{{ recommendation_identifier }}' -- required
AND region = '{{ region }}' -- required
AND language = '{{ language }}'
;

list_recommendations

List a filterable set of Recommendations. This API provides global recommendations, eliminating the need to call the API in each AWS Region.

SELECT
id,
name,
arn,
aws_services,
check_arn,
created_at,
last_updated_at,
lifecycle_stage,
pillar_specific_aggregates,
pillars,
resources_aggregates,
source,
status,
status_reason,
type_
FROM aws.trustedadvisor.recommendations
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND type = '{{ type }}'
AND status = '{{ status }}'
AND pillar = '{{ pillar }}'
AND awsService = '{{ awsService }}'
AND source = '{{ source }}'
AND checkIdentifier = '{{ checkIdentifier }}'
AND afterLastUpdatedAt = '{{ afterLastUpdatedAt }}'
AND beforeLastUpdatedAt = '{{ beforeLastUpdatedAt }}'
AND language = '{{ language }}'
;

UPDATE examples

update_recommendation_lifecycle

Update the lifecyle of a Recommendation. This API only supports prioritized recommendations and updates global priority recommendations, eliminating the need to call the API in each AWS Region.

UPDATE aws.trustedadvisor.recommendations
SET 
lifecycleStage = '{{ lifecycleStage }}',
updateReason = '{{ updateReason }}',
updateReasonCode = '{{ updateReasonCode }}'
WHERE 
recommendation_identifier = '{{ recommendation_identifier }}' --required
AND region = '{{ region }}' --required
AND lifecycleStage = '{{ lifecycleStage }}' --required;