Skip to content
AWS for Query.Farm

aws.config.describe_aggregate_compliance_by_config_rules

Example SQL Queries

SELECT * FROM
aws.config.describe_aggregate_compliance_by_config_rules
WHERE
"configuration_aggregator_name" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
configuration_aggregator_name Required Input Column

The name of the configuration aggregator.

VARCHAR
filters Input Column

Filters the results by ConfigRuleComplianceFilters object. 

STRUCT(
    "config_rule_name" VARCHAR,
    "compliance_type" VARCHAR,
    "account_id" VARCHAR,
    "aws_region" VARCHAR
)
Show child fields
filters.account_id

The 12-digit account ID of the source account.

filters.aws_region

The source region where the data is aggregated.

filters.compliance_type

The rule compliance status.

For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

filters.config_rule_name

The name of the Config rule.

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
account_id

The 12-digit account ID of the source account.

VARCHAR
aws_region

The source region from where the data is aggregated.

VARCHAR
compliance

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

STRUCT(
    "compliance_type" VARCHAR,
    "compliance_contributor_count" STRUCT(
        "capped_count" BIGINT,
        "cap_exceeded" BOOLEAN
    )
)
Show child fields
compliance.compliance_contributor_count

The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

Show child fields
compliance.compliance_contributor_count.cap_exceeded

Indicates whether the maximum count is reached.

compliance.compliance_contributor_count.capped_count

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

compliance.compliance_type

Indicates whether an Amazon Web Services resource or Config rule is compliant.

A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.

For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

config_rule_name

The name of the Config rule.

VARCHAR