Sign In to the Console
AWS Config
API Reference (API Version 2014-11-12)

AWS Documentation » AWS Config » API Reference » Actions » PutConfigurationAggregator

PutConfigurationAggregator

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

Note

AWS Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the master account and all features must be enabled in your organization. AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations.

Request Syntax

{
   "AccountAggregationSources": [ 
      { 
         "AccountIds": [ "string" ],
         "AllAwsRegions": boolean,
         "AwsRegions": [ "string" ]
      }
   ],
   "ConfigurationAggregatorName": "string",
   "OrganizationAggregationSource": { 
      "AllAwsRegions": boolean,
      "AwsRegions": [ "string" ],
      "RoleArn": "string"
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

AccountAggregationSources

A list of AccountAggregationSource object.

Type: Array of AccountAggregationSource objects

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Required: No

ConfigurationAggregatorName

The name of the configuration aggregator.

Type: String

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

Pattern: [\w\-]+

Required: Yes

OrganizationAggregationSource

An OrganizationAggregationSource object.

Type: OrganizationAggregationSource object

Required: No

Tags

An array of tag object.

Type: Array of Tag objects

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

Required: No

Response Syntax

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

ConfigurationAggregator

Returns a ConfigurationAggregator object.

Type: ConfigurationAggregator object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterValueException

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

HTTP Status Code: 400

InvalidRoleException

You have provided a null or empty role ARN.

HTTP Status Code: 400

LimitExceededException

For StartConfigRulesEvaluation API, this exception is thrown if an evaluation is in progress or if you call the StartConfigRulesEvaluation API more than once per minute.

For PutConfigurationAggregator API, this exception is thrown if the number of accounts and aggregators exceeds the limit.

HTTP Status Code: 400

NoAvailableOrganizationException

Organization does is no longer available.

HTTP Status Code: 400

OrganizationAccessDeniedException

No permission to call the EnableAWSServiceAccess API.

HTTP Status Code: 400

OrganizationAllFeaturesNotEnabledException

The configuration aggregator cannot be created because organization does not have all features enabled.

HTTP Status Code: 400

See Also

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