# GetAggregateConfigRuleComplianceSummary
<a name="API_GetAggregateConfigRuleComplianceSummary"></a>

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

**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
<a name="API_GetAggregateConfigRuleComplianceSummary_RequestSyntax"></a>

```
{
   "ConfigurationAggregatorName": "string",
   "Filters": { 
      "AccountId": "string",
      "AwsRegion": "string"
   },
   "GroupByKey": "string",
   "Limit": number,
   "NextToken": "string"
}
```

## Request Parameters
<a name="API_GetAggregateConfigRuleComplianceSummary_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [ConfigurationAggregatorName](#API_GetAggregateConfigRuleComplianceSummary_RequestSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-request-ConfigurationAggregatorName"></a>
The name of the configuration aggregator.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `[\w\-]+`   
Required: Yes

 ** [Filters](#API_GetAggregateConfigRuleComplianceSummary_RequestSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-request-Filters"></a>
Filters the results based on the ConfigRuleComplianceSummaryFilters object.  
Type: [ConfigRuleComplianceSummaryFilters](API_ConfigRuleComplianceSummaryFilters.md) object  
Required: No

 ** [GroupByKey](#API_GetAggregateConfigRuleComplianceSummary_RequestSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-request-GroupByKey"></a>
Groups the result based on ACCOUNT\$1ID or AWS\$1REGION.  
Type: String  
Valid Values: `ACCOUNT_ID | AWS_REGION`   
Required: No

 ** [Limit](#API_GetAggregateConfigRuleComplianceSummary_RequestSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-request-Limit"></a>
The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the default.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 1000.  
Required: No

 ** [NextToken](#API_GetAggregateConfigRuleComplianceSummary_RequestSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-request-NextToken"></a>
The `nextToken` string 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
<a name="API_GetAggregateConfigRuleComplianceSummary_ResponseSyntax"></a>

```
{
   "AggregateComplianceCounts": [ 
      { 
         "ComplianceSummary": { 
            "ComplianceSummaryTimestamp": number,
            "CompliantResourceCount": { 
               "CapExceeded": boolean,
               "CappedCount": number
            },
            "NonCompliantResourceCount": { 
               "CapExceeded": boolean,
               "CappedCount": number
            }
         },
         "GroupName": "string"
      }
   ],
   "GroupByKey": "string",
   "NextToken": "string"
}
```

## Response Elements
<a name="API_GetAggregateConfigRuleComplianceSummary_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [AggregateComplianceCounts](#API_GetAggregateConfigRuleComplianceSummary_ResponseSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-response-AggregateComplianceCounts"></a>
Returns a list of AggregateComplianceCounts object.  
Type: Array of [AggregateComplianceCount](API_AggregateComplianceCount.md) objects

 ** [GroupByKey](#API_GetAggregateConfigRuleComplianceSummary_ResponseSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-response-GroupByKey"></a>
Groups the result based on ACCOUNT\$1ID or AWS\$1REGION.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.

 ** [NextToken](#API_GetAggregateConfigRuleComplianceSummary_ResponseSyntax) **   <a name="config-GetAggregateConfigRuleComplianceSummary-response-NextToken"></a>
The `nextToken` string returned on a previous page that you use to get the next page of results in a paginated response.  
Type: String

## Errors
<a name="API_GetAggregateConfigRuleComplianceSummary_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InvalidLimitException **   
The specified limit is outside the allowable range.  
HTTP Status Code: 400

 ** InvalidNextTokenException **   
The specified next token is not valid. Specify the `nextToken` string 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](https://docs.aws.amazon.com/config/latest/APIReference/API_PutStoredQuery.html), 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](https://docs.aws.amazon.com/config/latest/APIReference/API_DescribeConfigurationRecorders.html) and [DescribeConfigurationRecorderStatus](https://docs.aws.amazon.com/config/latest/APIReference/API_DescribeConfigurationRecorderStatus.html), 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](https://docs.aws.amazon.com/config/latest/APIReference/API_AssociateResourceTypes.html) and [DisassociateResourceTypes](https://docs.aws.amazon.com/config/latest/APIReference/API_DisassociateResourceTypes.html), 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
<a name="API_GetAggregateConfigRuleComplianceSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/config-2014-11-12/GetAggregateConfigRuleComplianceSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/config-2014-11-12/GetAggregateConfigRuleComplianceSummary)