Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . configservice ]

describe-configuration-aggregators

Description

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.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-configuration-aggregators
[--configuration-aggregator-names <value>]
[--next-token <value>]
[--limit <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--configuration-aggregator-names (list)

The name of the configuration aggregators.

Syntax:

"string" "string" ...

--next-token (string)

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

--limit (integer)

The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

ConfigurationAggregators -> (list)

Returns a ConfigurationAggregators object.

(structure)

The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.

ConfigurationAggregatorName -> (string)

The name of the aggregator.

ConfigurationAggregatorArn -> (string)

The Amazon Resource Name (ARN) of the aggregator.

AccountAggregationSources -> (list)

Provides a list of source accounts and regions to be aggregated.

(structure)

A collection of accounts and regions.

AccountIds -> (list)

The 12-digit account ID of the account being aggregated.

(string)

AllAwsRegions -> (boolean)

If true, aggregate existing AWS Config regions and future regions.

AwsRegions -> (list)

The source regions being aggregated.

(string)

OrganizationAggregationSource -> (structure)

Provides an organization and list of regions to be aggregated.

RoleArn -> (string)

ARN of the IAM role used to retreive AWS Organization details associated with the aggregator account.

AwsRegions -> (list)

The source regions being aggregated.

(string)

AllAwsRegions -> (boolean)

If true, aggregate existing AWS Config regions and future regions.

CreationTime -> (timestamp)

The time stamp when the configuration aggregator was created.

LastUpdatedTime -> (timestamp)

The time of the last update.

NextToken -> (string)

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