AWS Config
  1. Root
AWS Config
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ConfigurationAggregatorName": "string",
    "Filters": {
        "AccountId": "string",
        "AwsRegion": "string"
    },
    "GroupByKey": "ACCOUNT_ID",
    "Limit": 0,
    "NextToken": "string"
}'
Response Response Example
200 - Example 1
{
  "GroupByKey": "string",
  "AggregateComplianceCounts": [],
  "NextToken": "string"
}

Request

Query Params
Limit
string 
optional
Pagination limit
NextToken
string 
optional
Pagination token
Header Params
X-Amz-Target
string 
required
Body Params application/json
ConfigurationAggregatorName
string 
required
The name of the configuration aggregator.
>= 1 characters<= 256 characters
Match pattern:
[\w\-]+
Filters
object 
optional
Filters the results based on the ConfigRuleComplianceSummaryFilters object.
AccountId
string 
optional
The 12-digit account ID of the source account.
Match pattern:
\d{12}
AwsRegion
string 
optional
The source region where the data is aggregated.
>= 1 characters<= 64 characters
GroupByKey
enum<string> 
optional
Groups the result based on ACCOUNT_ID or AWS_REGION.
Allowed values:
ACCOUNT_IDAWS_REGION
Limit
integer 
optional
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, Config uses the default.
>= 0<= 1000
NextToken
string 
optional
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Examples

Responses

🟢200Success
application/json
Body
GroupByKey
string 
optional
Groups the result based on ACCOUNT_ID or AWS_REGION.
>= 1 characters<= 256 characters
AggregateComplianceCounts
array[object (AggregateComplianceCount) {2}] 
optional
Returns a list of AggregateComplianceCounts object.
GroupName
string 
optional
The 12-digit account ID or region based on the GroupByKey value.
>= 1 characters<= 256 characters
ComplianceSummary
object 
optional
The number of compliant and noncompliant Config rules.
NextToken
string 
optional
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
🟠480ValidationException
🟠481InvalidLimitException
🟠482InvalidNextTokenException
🟠483NoSuchConfigurationAggregatorException
Modified at 2023-08-15 05:59:06
Previous
/
Next
/
Built with