Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions,
see Getting Started with Amazon Web Services in China
(PDF).
Use DescribeComplianceByResource
with an Amazon SDK or CLI
The following code examples show how to use DescribeComplianceByResource
.
- CLI
-
- Amazon CLI
-
To get compliance information for your Amazon resources
The following command returns compliance information for each EC2 instance that is recorded by Amazon Config and that violates one or more rules:
aws configservice describe-compliance-by-resource --resource-type AWS::EC2::Instance
--compliance-types NON_COMPLIANT
In the output, the value for each CappedCount
attribute indicates how many rules the resource violates. For example, the following output indicates that instance i-1a2b3c4d
violates 2 rules.
Output:
{
"ComplianceByResources": [
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-1a2b3c4d",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 2,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
},
{
"ResourceType": "AWS::EC2::Instance",
"ResourceId": "i-2a2b3c4d ",
"Compliance": {
"ComplianceContributorCount": {
"CappedCount": 3,
"CapExceeded": false
},
"ComplianceType": "NON_COMPLIANT"
}
}
]
}
- PowerShell
-
- Tools for PowerShell
-
Example 1: This example checks the AWS::SSM::ManagedInstanceInventory
resource type for 'COMPLIANT' compliance type.
Get-CFGComplianceByResource -ComplianceType COMPLIANT -ResourceType AWS::SSM::ManagedInstanceInventory
Output:
Compliance ResourceId ResourceType
---------- ---------- ------------
Amazon.ConfigService.Model.Compliance i-0123bcf4b567890e3 AWS::SSM::ManagedInstanceInventory
Amazon.ConfigService.Model.Compliance i-0a1234f6f5d6b78f7 AWS::SSM::ManagedInstanceInventory
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.