checks

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

Overview

Name	checks
Type	Resource
Id	aws.trustedadvisor.checks

Fields

The following fields are returned by SELECT queries:

list_checks

Name	Datatype	Description
id	string	The unique identifier of the AWS Trusted Advisor Check
name	string	The name of the AWS Trusted Advisor Check
arn	string	The ARN of the AWS Trusted Advisor Check (pattern: <code>arn:[\w-]+:trustedadvisor:::check/[\w-]+</code>)
aws_resource_types	array	The AWS resource types that this check evaluates (for example, AWS::EC2::Instance).
aws_services	array	The AWS Services that the Check applies to
check_granularity	string	The granularity level at which the check operates: resource, account, or account_region.
description	string	A description of what the AWS Trusted Advisor Check is monitoring
metadata	object	The column headings for the metadata returned in the resource
pillars	array	The Recommendation pillars that the AWS Trusted Advisor Check falls under
recommendation_id	string	The recommendation identifier associated with the check.
resource_arn_queryable	boolean	Indicates whether this check is supported by the ListRecommendationsForResource API.
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)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_checks	select	region	nextToken, maxResults, pillar, awsService, source, language	List a filterable set of Checks. This API provides global 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
region	string	AWS region (default: us-east-1)
awsService	string	The aws service associated with the check
language	string	The ISO 639-1 code for the language that you want your checks 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 check
source	string	The source of the check

SELECT examples

list_checks

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

SELECT
id,
name,
arn,
aws_resource_types,
aws_services,
check_granularity,
description,
metadata,
pillars,
recommendation_id,
resource_arn_queryable,
source
FROM aws.trustedadvisor.checks
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND pillar = '{{ pillar }}'
AND awsService = '{{ awsService }}'
AND source = '{{ source }}'
AND language = '{{ language }}'
;