organization_recommendation_resources

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

Overview

Name	organization_recommendation_resources
Type	Resource
Id	aws.trustedadvisor.organization_recommendation_resources

Fields

The following fields are returned by SELECT queries:

list_organization_recommendation_resources

Name	Datatype	Description
id	string	The ID of the Recommendation Resource
account_id	string	The AWS account ID (pattern: <code>\d+</code>)
arn	string	The ARN of the Recommendation Resource (pattern: <code>arn:[\w-]+:trustedadvisor::\d{12}:recommendation-resource/[\w-]+/[\w-]+</code>)
aws_resource_id	string	The AWS resource identifier. There are certain checks that generate recommendation resources without an awsResourceId.
exclusion_status	string	The exclusion status of the Recommendation Resource (excluded, included)
last_updated_at	string (date-time)	When the Recommendation Resource was last updated
metadata	object	Metadata associated with the Recommendation Resource
recommendation_arn	string	The Recommendation ARN (pattern: <code>arn:[\w-]+:trustedadvisor:::organization-recommendation/[\w-]+</code>)
region_code	string	The AWS Region code that the Recommendation Resource is in
status	string	The current status of the Recommendation Resource (ok, warning, error)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_organization_recommendation_resources	select	organization_recommendation_identifier, region	nextToken, maxResults, status, exclusionStatus, regionCode, affectedAccountId	List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations and provides 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
organization_recommendation_identifier	string	The AWS Organization organization's Recommendation identifier
region	string	AWS region (default: us-east-1)
affectedAccountId	string	An account affected by this organization recommendation
exclusionStatus	string	The exclusion status of the resource
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.
regionCode	string	The AWS Region code of the resource
status	string	The status of the resource

SELECT examples

list_organization_recommendation_resources

List Resources of a Recommendation within an Organization. This API only supports prioritized recommendations and provides global priority recommendations, eliminating the need to call the API in each AWS Region.

SELECT
id,
account_id,
arn,
aws_resource_id,
exclusion_status,
last_updated_at,
metadata,
recommendation_arn,
region_code,
status
FROM aws.trustedadvisor.organization_recommendation_resources
WHERE organization_recommendation_identifier = '{{ organization_recommendation_identifier }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND status = '{{ status }}'
AND exclusionStatus = '{{ exclusionStatus }}'
AND regionCode = '{{ regionCode }}'
AND affectedAccountId = '{{ affectedAccountId }}'
;