Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetAggregateDiscoveredResourceCounts

Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey.

For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

Request Syntax


{
   "ConfigurationAggregatorName": "string",
   "Filters": { 
      "AccountId": "string",
      "Region": "string",
      "ResourceType": "string"
   },
   "GroupByKey": "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 based on the ResourceCountFilters object.

Type: ResourceCountFilters object

Required: No

GroupByKey

The key to group the resource counts.

Type: String

Valid Values: RESOURCE_TYPE | ACCOUNT_ID | AWS_REGION

Required: No

Limit

The maximum number of GroupedResourceCount objects 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

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


{
   "GroupByKey": "string",
   "GroupedResourceCounts": [ 
      { 
         "GroupName": "string",
         "ResourceCount": number
      }
   ],
   "NextToken": "string",
   "TotalDiscoveredResources": number
}

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.

GroupByKey

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

GroupedResourceCounts

Returns a list of GroupedResourceCount objects.

Type: Array of GroupedResourceCount objects

NextToken

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Type: String

TotalDiscoveredResources

The total number of resources that are present in an aggregator with the filters that you provide.

Type: Long

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 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 action is not valid.

For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.

For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.

HTTP Status Code: 400