ConfigService / Client / describe_aggregate_compliance_by_conformance_packs

describe_aggregate_compliance_by_conformance_packs

ConfigService.Client.describe_aggregate_compliance_by_conformance_packs(**kwargs)

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

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.describe_aggregate_compliance_by_conformance_packs(
    ConfigurationAggregatorName='string',
    Filters={
        'ConformancePackName': 'string',
        'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
        'AccountId': 'string',
        'AwsRegion': 'string'
    },
    Limit=123,
    NextToken='string'
)

Parameters:

• ConfigurationAggregatorName (string) –

  [REQUIRED]

  The name of the configuration aggregator.

• Filters (dict) –

  Filters the result by AggregateConformancePackComplianceFilters object.

  • ConformancePackName (string) –

    The name of the conformance pack.

  • ComplianceType (string) –

    The compliance status of the conformance pack.

  • AccountId (string) –

    The 12-digit Amazon Web Services account ID of the source account.

  • AwsRegion (string) –

    The source Amazon Web Services Region from where the data is aggregated.

• Limit (integer) – The maximum number of conformance packs compliance details returned on each page. The default is maximum. 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

{
    'AggregateComplianceByConformancePacks': [
        {
            'ConformancePackName': 'string',
            'Compliance': {
                'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
                'CompliantRuleCount': 123,
                'NonCompliantRuleCount': 123,
                'TotalRuleCount': 123
            },
            'AccountId': 'string',
            'AwsRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • AggregateComplianceByConformancePacks (list) –

    Returns the AggregateComplianceByConformancePack object.

    • (dict) –

      Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.

      A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

      • ConformancePackName (string) –

        The name of the conformance pack.

      • Compliance (dict) –

        The compliance status of the conformance pack.

        • ComplianceType (string) –

          The compliance status of the conformance pack.

        • CompliantRuleCount (integer) –

          The number of compliant Config Rules.

        • NonCompliantRuleCount (integer) –

          The number of noncompliant Config Rules.

        • TotalRuleCount (integer) –

          Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

      • AccountId (string) –

        The 12-digit Amazon Web Services account ID of the source account.

      • AwsRegion (string) –

        The source Amazon Web Services Region from where the data is aggregated.

  • 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