ConfigService / Paginator / DescribeAggregateComplianceByConfigRules

DescribeAggregateComplianceByConfigRules

class ConfigService.Paginator.DescribeAggregateComplianceByConfigRules

paginator = client.get_paginator('describe_aggregate_compliance_by_config_rules')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConfigurationAggregatorName='string',
    Filters={
        'ConfigRuleName': 'string',
        'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
        'AccountId': 'string',
        'AwsRegion': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ConfigurationAggregatorName (string) –

  [REQUIRED]

  The name of the configuration aggregator.

• Filters (dict) –

  Filters the results by ConfigRuleComplianceFilters object.

  • ConfigRuleName (string) –

    The name of the Config rule.

  • ComplianceType (string) –

    The rule compliance status.

    For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

  • AccountId (string) –

    The 12-digit account ID of the source account.

  • AwsRegion (string) –

    The source region where the data is aggregated.

• 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

{
    'AggregateComplianceByConfigRules': [
        {
            'ConfigRuleName': 'string',
            'Compliance': {
                'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
                'ComplianceContributorCount': {
                    'CappedCount': 123,
                    'CapExceeded': True|False
                }
            },
            'AccountId': 'string',
            'AwsRegion': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • AggregateComplianceByConfigRules (list) –

    Returns a list of AggregateComplianceByConfigRule object.

    • (dict) –

      Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

      A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

      • ConfigRuleName (string) –

        The name of the Config rule.

      • Compliance (dict) –

        Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

        • ComplianceType (string) –

          Indicates whether an Amazon Web Services resource or Config rule is compliant.

          A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

          A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

          Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.

          For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

        • ComplianceContributorCount (dict) –

          The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

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

      • AccountId (string) –

        The 12-digit account ID of the source account.

      • AwsRegion (string) –

        The source region from where the data is aggregated.