ConfigService / Client / get_aggregate_config_rule_compliance_summary

get_aggregate_config_rule_compliance_summary#

ConfigService.Client.get_aggregate_config_rule_compliance_summary(**kwargs)#

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

Note

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

See also: AWS API Documentation

Request Syntax

response = client.get_aggregate_config_rule_compliance_summary(
    ConfigurationAggregatorName='string',
    Filters={
        'AccountId': 'string',
        'AwsRegion': 'string'
    },
    GroupByKey='ACCOUNT_ID'|'AWS_REGION',
    Limit=123,
    NextToken='string'
)
Parameters:

  • ConfigurationAggregatorName (string) –

    [REQUIRED]

    The name of the configuration aggregator.

  • Filters (dict) –

    Filters the results based on the ConfigRuleComplianceSummaryFilters object.

    • AccountId (string) –

      The 12-digit account ID of the source account.

    • AwsRegion (string) –

      The source region where the data is aggregated.

  • GroupByKey (string) – Groups the result based on ACCOUNT_ID or AWS_REGION.

  • Limit (integer) – The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

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

Return type:

dict

Returns:

Response Syntax

{
    'GroupByKey': 'string',
    'AggregateComplianceCounts': [
        {
            'GroupName': 'string',
            'ComplianceSummary': {
                'CompliantResourceCount': {
                    'CappedCount': 123,
                    'CapExceeded': True|False
                },
                'NonCompliantResourceCount': {
                    'CappedCount': 123,
                    'CapExceeded': True|False
                },
                'ComplianceSummaryTimestamp': datetime(2015, 1, 1)
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • GroupByKey (string) –

      Groups the result based on ACCOUNT_ID or AWS_REGION.

    • AggregateComplianceCounts (list) –

      Returns a list of AggregateComplianceCounts object.

      • (dict) –

        Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

        • GroupName (string) –

          The 12-digit account ID or region based on the GroupByKey value.

        • ComplianceSummary (dict) –

          The number of compliant and noncompliant Config rules.

          • CompliantResourceCount (dict) –

            The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

            • CappedCount (integer) –

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded (boolean) –

              Indicates whether the maximum count is reached.

          • NonCompliantResourceCount (dict) –

            The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

            • CappedCount (integer) –

              The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

            • CapExceeded (boolean) –

              Indicates whether the maximum count is reached.

          • ComplianceSummaryTimestamp (datetime) –

            The time that Config created the compliance summary.

    • 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.ValidationException

  • ConfigService.Client.exceptions.InvalidLimitException

  • ConfigService.Client.exceptions.InvalidNextTokenException

  • ConfigService.Client.exceptions.NoSuchConfigurationAggregatorException