AWS Config
API Reference (API Version 2014-11-12)

DescribeConfigurationAggregators

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.

Request Syntax

{ "ConfigurationAggregatorNames": [ "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.

ConfigurationAggregatorNames

The name of the configuration aggregators.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 10 items.

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

Pattern: [\w\-]+

Required: No

Limit

The maximum number of configuration aggregators 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 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

Response Syntax

{ "ConfigurationAggregators": [ { "AccountAggregationSources": [ { "AccountIds": [ "string" ], "AllAwsRegions": boolean, "AwsRegions": [ "string" ] } ], "ConfigurationAggregatorArn": "string", "ConfigurationAggregatorName": "string", "CreationTime": number, "LastUpdatedTime": number, "OrganizationAggregationSource": { "AllAwsRegions": boolean, "AwsRegions": [ "string" ], "RoleArn": "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.

ConfigurationAggregators

Returns a ConfigurationAggregators object.

Type: Array of ConfigurationAggregator 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

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 invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

HTTP Status Code: 400

InvalidParameterValueException

One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

HTTP Status Code: 400

NoSuchConfigurationAggregatorException

You have specified a configuration aggregator that does not exist.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: