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
/
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ConfigurationAggregatorName": "string",
    "AccountAggregationSources": [],
    "OrganizationAggregationSource": {
        "RoleArn": "string",
        "AwsRegions": [],
        "AllAwsRegions": true
    },
    "Tags": []
}'
Response Response Example
200 - Example 1
{
    "ConfigurationAggregator": {
        "ConfigurationAggregatorName": "string",
        "ConfigurationAggregatorArn": "string",
        "AccountAggregationSources": [],
        "OrganizationAggregationSource": {
            "RoleArn": "string",
            "AwsRegions": [],
            "AllAwsRegions": true
        },
        "CreationTime": "string",
        "LastUpdatedTime": "string",
        "CreatedBy": "string"
    }
}

Request

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\-]+
AccountAggregationSources
array[object (AccountAggregationSource) {3}] 
optional
A list of AccountAggregationSource object.
>= 0 items<= 1 items
AccountIds
array[string]
required
The 12-digit account ID of the account being aggregated.
>= 1 items
AllAwsRegions
boolean 
optional
If true, aggregate existing Config regions and future regions.
AwsRegions
array[string]
optional
The source regions being aggregated.
>= 1 items
OrganizationAggregationSource
object 
optional
An OrganizationAggregationSource object.
RoleArn
string 
required
ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.
AwsRegions
array[string]
optional
The source regions being aggregated.
>= 1 items
AllAwsRegions
boolean 
optional
If true, aggregate existing Config regions and future regions.
Tags
array[object (Tag) {2}] 
optional
An array of tag object.
>= 0 items<= 50 items
Key
string 
optional
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
>= 1 characters<= 128 characters
Value
string 
optional
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
>= 0 characters<= 256 characters
Examples

Responses

🟢200Success
application/json
Body
ConfigurationAggregator
object 
optional
Returns a ConfigurationAggregator object.
ConfigurationAggregatorName
string 
optional
The name of the aggregator.
>= 1 characters<= 256 characters
Match pattern:
[\w\-]+
ConfigurationAggregatorArn
string 
optional
The Amazon Resource Name (ARN) of the aggregator.
Match pattern:
arn:aws[a-z\-]*:config:[a-z\-\d]+:\d+:config-aggregator/config-aggregator-[a-z\d]+
AccountAggregationSources
array[object (AccountAggregationSource) {3}] 
optional
Provides a list of source accounts and regions to be aggregated.
>= 0 items<= 1 items
OrganizationAggregationSource
object 
optional
Provides an organization and list of regions to be aggregated.
CreationTime
string <date-time>
optional
The time stamp when the configuration aggregator was created.
LastUpdatedTime
string <date-time>
optional
The time of the last update.
CreatedBy
string 
optional
Amazon Web Services service that created the configuration aggregator.
>= 1 characters<= 256 characters
đźź 480InvalidParameterValueException
đźź 481LimitExceededException
đźź 482InvalidRoleException
đźź 483OrganizationAccessDeniedException
đźź 484NoAvailableOrganizationException
đźź 485OrganizationAllFeaturesNotEnabledException
Modified at 2023-08-15 05:59:06
Previous
/
Next
/
Built with