Use GetComplianceSummaryByResourceType
with an Amazon SDK or CLI
The following code examples show how to use GetComplianceSummaryByResourceType
.
- CLI
-
- Amazon CLI
-
To get the compliance summary for all resource types
The following command returns the number of Amazon resources that are noncompliant and the number that are compliant:
aws configservice get-compliance-summary-by-resource-type
In the output, the value for each
CappedCount
attribute indicates how many resources are compliant or noncompliant.Output:
{ "ComplianceSummariesByResourceType": [ { "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 16, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1453237464.543, "CompliantResourceCount": { "CappedCount": 10, "CapExceeded": false } } } ] }
To get the compliance summary for a specific resource type
The following command returns the number of EC2 instances that are noncompliant and the number that are compliant:
aws configservice get-compliance-summary-by-resource-type --resource-types
AWS::EC2::Instance
In the output, the value for each
CappedCount
attribute indicates how many resources are compliant or noncompliant.Output:
{ "ComplianceSummariesByResourceType": [ { "ResourceType": "AWS::EC2::Instance", "ComplianceSummary": { "NonCompliantResourceCount": { "CappedCount": 3, "CapExceeded": false }, "ComplianceSummaryTimestamp": 1452204923.518, "CompliantResourceCount": { "CappedCount": 7, "CapExceeded": false } } } ] }
-
For API details, see GetComplianceSummaryByResourceType
in Amazon CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell
-
Example 1: This sample returns the number of resources that are compliant or noncompliant and converts the output to json.
Get-CFGComplianceSummaryByResourceType -Select ComplianceSummariesByResourceType.ComplianceSummary | ConvertTo-Json { "ComplianceSummaryTimestamp": "2019-12-14T06:14:49.778Z", "CompliantResourceCount": { "CapExceeded": false, "CappedCount": 2 }, "NonCompliantResourceCount": { "CapExceeded": true, "CappedCount": 100 } }
-
For API details, see GetComplianceSummaryByResourceType
in Amazon Tools for PowerShell Cmdlet Reference.
-
For a complete list of Amazon SDK developer guides and code examples, see Using Amazon Config with an Amazon SDK. This topic also includes information about getting started and details about previous SDK versions.