Use `GetComplianceSummaryByConfigRule` with a CLI

PDF

RSS

Focus mode

Use GetComplianceSummaryByConfigRule with a CLI - AWS Config

The following code examples show how to use GetComplianceSummaryByConfigRule.

CLI

AWS CLI

To get the compliance summary for your AWS Config rules

The following command returns the number of rules that are compliant and the number that are noncompliant:


aws configservice get-compliance-summary-by-config-rule

In the output, the value for each CappedCount attribute indicates how many rules are compliant or noncompliant.

Output:


{
    "ComplianceSummary": {
        "NonCompliantResourceCount": {
            "CappedCount": 3,
            "CapExceeded": false
        },
        "ComplianceSummaryTimestamp": 1452204131.493,
        "CompliantResourceCount": {
            "CappedCount": 2,
            "CapExceeded": false
        }
    }
}

For API details, see GetComplianceSummaryByConfigRule in AWS CLI Command Reference.

PowerShell

Tools for PowerShell

Example 1: This sample returns the number of Config rules that are non-compliant.


Get-CFGComplianceSummaryByConfigRule -Select ComplianceSummary.NonCompliantResourceCount

Output:


CapExceeded CappedCount
----------- -----------
False       9

For API details, see GetComplianceSummaryByConfigRule in AWS Tools for PowerShell Cmdlet Reference.

anchor anchor

AWS CLI

To get the compliance summary for your AWS Config rules

The following command returns the number of rules that are compliant and the number that are noncompliant:


aws configservice get-compliance-summary-by-config-rule

In the output, the value for each CappedCount attribute indicates how many rules are compliant or noncompliant.

Output:


{
    "ComplianceSummary": {
        "NonCompliantResourceCount": {
            "CappedCount": 3,
            "CapExceeded": false
        },
        "ComplianceSummaryTimestamp": 1452204131.493,
        "CompliantResourceCount": {
            "CappedCount": 2,
            "CapExceeded": false
        }
    }
}

For API details, see GetComplianceSummaryByConfigRule in AWS CLI Command Reference.

For a complete list of AWS SDK developer guides and code examples, see Using AWS Config with an AWS SDK. This topic also includes information about getting started and details about previous SDK versions.