ConfigService / Client / get_aggregate_conformance_pack_compliance_summary

get_aggregate_conformance_pack_compliance_summary#

ConfigService.Client.get_aggregate_conformance_pack_compliance_summary(**kwargs)#

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

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_conformance_pack_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 AggregateConformancePackComplianceSummaryFilters object.

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

  • GroupByKey (string) – Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

  • Limit (integer) – The maximum number of results 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

{
    'AggregateConformancePackComplianceSummaries': [
        {
            'ComplianceSummary': {
                'CompliantConformancePackCount': 123,
                'NonCompliantConformancePackCount': 123
            },
            'GroupName': 'string'
        },
    ],
    'GroupByKey': 'string',
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • AggregateConformancePackComplianceSummaries (list) –

      Returns a list of AggregateConformancePackComplianceSummary object.

      • (dict) –

        Provides a summary of compliance based on either account ID or region.

        • ComplianceSummary (dict) –

          Returns an AggregateConformancePackComplianceCount object.

          • CompliantConformancePackCount (integer) –

            Number of compliant conformance packs.

          • NonCompliantConformancePackCount (integer) –

            Number of noncompliant conformance packs.

        • GroupName (string) –

          Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

    • GroupByKey (string) –

      Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

    • 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