Skip to content
AWS for Query.Farm

aws.config.get_compliance_summary_by_resource_type

Example SQL Queries

SELECT * FROM
aws.config.get_compliance_summary_by_resource_type;

Description

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

Table Definition

Column NameColumn Data Type
resource_types Input Column

Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.

For this request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance. You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

VARCHAR[]
Show child fields
resource_types[]
_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
compliance_summaries_by_resource_type

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

STRUCT(
    "resource_type" VARCHAR,
    "compliance_summary" STRUCT(
        "compliant_resource_count" STRUCT(
            "capped_count" BIGINT,
            "cap_exceeded" BOOLEAN
        ),
        "non_compliant_resource_count" STRUCT(
            "capped_count" BIGINT,
            "cap_exceeded" BOOLEAN
        ),
        "compliance_summary_timestamp" TIMESTAMP_S
    )
)[]
Show child fields
compliance_summaries_by_resource_type[]
Show child fields
compliance_summaries_by_resource_type[].compliance_summary

The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.

Show child fields
compliance_summaries_by_resource_type[].compliance_summary.compliance_summary_timestamp

The time that Config created the compliance summary.

compliance_summaries_by_resource_type[].compliance_summary.compliant_resource_count

The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

Show child fields
compliance_summaries_by_resource_type[].compliance_summary.compliant_resource_count.cap_exceeded

Indicates whether the maximum count is reached.

compliance_summaries_by_resource_type[].compliance_summary.compliant_resource_count.capped_count

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

compliance_summaries_by_resource_type[].compliance_summary.non_compliant_resource_count

The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

Show child fields
compliance_summaries_by_resource_type[].compliance_summary.non_compliant_resource_count.cap_exceeded

Indicates whether the maximum count is reached.

compliance_summaries_by_resource_type[].compliance_summary.non_compliant_resource_count.capped_count

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

compliance_summaries_by_resource_type[].resource_type

The type of Amazon Web Services resource.