aggregate_compliance_by_config_rules

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

Overview

Name	aggregate_compliance_by_config_rules
Type	Resource
Id	aws.config.aggregate_compliance_by_config_rules

Fields

The following fields are returned by SELECT queries:

describe_aggregate_compliance_by_config_rules

Name	Datatype	Description
account_id	string	The 12-digit account ID of the source account. (pattern: <code>\d{12}</code>)
aws_region	string	The source region from where the data is aggregated.
compliance	object	Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
config_rule_name	string	The name of the Config rule. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_aggregate_compliance_by_config_rules	select	region		Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

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)

SELECT examples

describe_aggregate_compliance_by_config_rules

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

SELECT
account_id,
aws_region,
compliance,
config_rule_name
FROM aws.config.aggregate_compliance_by_config_rules
WHERE region = '{{ region }}' -- required
;