ConfigService / Client / describe_configuration_aggregators

describe_configuration_aggregators

ConfigService.Client.describe_configuration_aggregators(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_configuration_aggregators(
    ConfigurationAggregatorNames=[
        'string',
    ],
    NextToken='string',
    Limit=123
)

Parameters:

• ConfigurationAggregatorNames (list) –

  The name of the configuration aggregators.

  • (string) –

• NextToken (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, Config uses the default.

Return type:

dict

Returns:

Response Syntax

{
    'ConfigurationAggregators': [
        {
            'ConfigurationAggregatorName': 'string',
            'ConfigurationAggregatorArn': 'string',
            'AccountAggregationSources': [
                {
                    'AccountIds': [
                        'string',
                    ],
                    'AllAwsRegions': True|False,
                    'AwsRegions': [
                        'string',
                    ]
                },
            ],
            'OrganizationAggregationSource': {
                'RoleArn': 'string',
                'AwsRegions': [
                    'string',
                ],
                'AllAwsRegions': True|False
            },
            'CreationTime': datetime(2015, 1, 1),
            'LastUpdatedTime': datetime(2015, 1, 1),
            'CreatedBy': 'string',
            'AggregatorFilters': {
                'ResourceType': {
                    'Type': 'INCLUDE',
                    'Value': [
                        'string',
                    ]
                },
                'ServicePrincipal': {
                    'Type': 'INCLUDE',
                    'Value': [
                        'string',
                    ]
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • ConfigurationAggregators (list) –

    Returns a ConfigurationAggregators object.

    • (dict) –

      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.

        • (dict) –

          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 Config regions and future regions.

          • AwsRegions (list) –

            The source regions being aggregated.

            • (string) –

      • OrganizationAggregationSource (dict) –

        Provides an organization and list of regions to be aggregated.

        • RoleArn (string) –

          ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

        • AwsRegions (list) –

          The source regions being aggregated.

          • (string) –

        • AllAwsRegions (boolean) –

          If true, aggregate existing Config regions and future regions.

      • CreationTime (datetime) –

        The time stamp when the configuration aggregator was created.

      • LastUpdatedTime (datetime) –

        The time of the last update.

      • CreatedBy (string) –

        Amazon Web Services service that created the configuration aggregator.

      • AggregatorFilters (dict) –

        An object to filter the data you specify for an aggregator.

        • ResourceType (dict) –

          An object to filter the configuration recorders based on the resource types in scope for recording.

          • Type (string) –

            The type of resource type filter to apply. INCLUDE specifies that the list of resource types in the Value field will be aggregated and no other resource types will be filtered.

          • Value (list) –

            Comma-separate list of resource types to filter your aggregated configuration recorders.

            • (string) –

        • ServicePrincipal (dict) –

          An object to filter service-linked configuration recorders in an aggregator based on the linked Amazon Web Services service.

          • Type (string) –

            The type of service principal filter to apply. INCLUDE specifies that the list of service principals in the Value field will be aggregated and no other service principals will be filtered.

          • Value (list) –

            Comma-separated list of service principals for the linked Amazon Web Services services to filter your aggregated service-linked configuration recorders.

            • (string) –

  • NextToken (string) –

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

Exceptions

• ConfigService.Client.exceptions.InvalidParameterValueException

• ConfigService.Client.exceptions.NoSuchConfigurationAggregatorException

• ConfigService.Client.exceptions.InvalidNextTokenException

• ConfigService.Client.exceptions.InvalidLimitException