DescribeAggregateComplianceByConfigRules
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.
Note
The results can return an empty result page, but if you
have a nextToken, the results are displayed on the next
page.
Request Syntax
{
"ConfigurationAggregatorName": "string",
"Filters": {
"AccountId": "string",
"AwsRegion": "string",
"ComplianceType": "string",
"ConfigRuleName": "string"
},
"Limit": number,
"NextToken": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ConfigurationAggregatorName
-
The name of the configuration aggregator.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w\-]+Required: Yes
- Filters
-
Filters the results by ConfigRuleComplianceFilters object.
Type: ConfigRuleComplianceFilters object
Required: No
- Limit
-
The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1000.
Required: No
- NextToken
-
The
nextTokenstring returned on a previous page that you use to get the next page of results in a paginated response.Type: String
Required: No
Response Syntax
{
"AggregateComplianceByConfigRules": [
{
"AccountId": "string",
"AwsRegion": "string",
"Compliance": {
"ComplianceContributorCount": {
"CapExceeded": boolean,
"CappedCount": number
},
"ComplianceType": "string"
},
"ConfigRuleName": "string"
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AggregateComplianceByConfigRules
-
Returns a list of AggregateComplianceByConfigRule object.
Type: Array of AggregateComplianceByConfigRule objects
- NextToken
-
The
nextTokenstring returned on a previous page that you use to get the next page of results in a paginated response.Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidLimitException
-
The specified limit is outside the allowable range.
HTTP Status Code: 400
- InvalidNextTokenException
-
The specified next token is not valid. Specify the
nextTokenstring that was returned in the previous response to get the next page of results.HTTP Status Code: 400
- NoSuchConfigurationAggregatorException
-
You have specified a configuration aggregator that does not exist.
HTTP Status Code: 400
- ValidationException
-
The requested operation is not valid. You will see this exception if there are missing required fields or if the input value fails the validation.
For PutStoredQuery, one of the following errors:
-
There are missing required fields.
-
The input value fails the validation.
-
You are trying to create more than 300 queries.
For DescribeConfigurationRecorders and DescribeConfigurationRecorderStatus, one of the following errors:
-
You have specified more than one configuration recorder.
-
You have provided a service principal for service-linked configuration recorder that is not valid.
For AssociateResourceTypes and DisassociateResourceTypes, one of the following errors:
-
Your configuraiton recorder has a recording strategy that does not allow the association or disassociation of resource types.
-
One or more of the specified resource types are already associated or disassociated with the configuration recorder.
-
For service-linked configuration recorders, the configuration recorder does not record one or more of the specified resource types.
HTTP Status Code: 400
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
