ConfigService / Paginator / DescribeConfigurationAggregators

DescribeConfigurationAggregators#

class ConfigService.Paginator.DescribeConfigurationAggregators#
paginator = client.get_paginator('describe_configuration_aggregators')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ConfigService.Client.describe_configuration_aggregators().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationAggregatorNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ConfigurationAggregatorNames (list) –

    The name of the configuration aggregators.

    • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

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'
        },
    ],

}

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.