GetDiscoveredResourceCounts
Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account.
Example
-
AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify that you want all resource types. -
AWS Config returns the following:
-
The resource types (EC2 instances, IAM users, and S3 buckets).
-
The number of each resource type (25, 20, and 15).
-
The total number of all resources (60).
-
The response is paginated. By default, AWS Config lists 100
ResourceCount objects on each page. You can
customize this number with the limit
parameter. The
response includes a nextToken
string. To get the next
page of results, run the request again and specify the string for
the nextToken
parameter.
Note
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
-
You are a new AWS Config customer.
-
You just enabled resource recording.
It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
Request Syntax
{
"limit": number
,
"nextToken": "string
",
"resourceTypes": [ "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.
- limit
-
The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
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
- resourceTypes
-
The comma-separated list that specifies the resource types that you want AWS Config to return (for example,
"AWS::EC2::Instance"
,"AWS::IAM::User"
).If a value for
resourceTypes
is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account.Note
If the configuration recorder is turned off, AWS Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
Response Syntax
{
"nextToken": "string",
"resourceCounts": [
{
"count": number,
"resourceType": "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.
- nextToken
-
The string that you use in a subsequent request to get the next page of results in a paginated response.
Type: String
- resourceCounts
-
The list of
ResourceCount
objects. Each object is listed in descending order by the number of resources.Type: Array of ResourceCount objects
- totalDiscoveredResources
-
The total number of resources that AWS Config is recording in the region for your account. If you specify resource types in the request, AWS Config returns only the total number of resources for those resource types.
Example
-
AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
-
You make a call to the
GetDiscoveredResourceCounts
action and specify the resource type,"AWS::EC2::Instances"
, in the request. -
AWS Config returns 25 for
totalDiscoveredResources
.
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
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: