ConfigService / Client / get_conformance_pack_compliance_summary

get_conformance_pack_compliance_summary#

ConfigService.Client.get_conformance_pack_compliance_summary(**kwargs)#

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

See also: AWS API Documentation

Request Syntax

response = client.get_conformance_pack_compliance_summary(
    ConformancePackNames=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)
Parameters:

  • ConformancePackNames (list) –

    [REQUIRED]

    Names of conformance packs.

    • (string) –

  • Limit (integer) – The maximum number of conformance packs returned on each page.

  • 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

{
    'ConformancePackComplianceSummaryList': [
        {
            'ConformancePackName': 'string',
            'ConformancePackComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • ConformancePackComplianceSummaryList (list) –

      A list of ConformancePackComplianceSummary objects.

      • (dict) –

        Summary includes the name and status of the conformance pack.

        • ConformancePackName (string) –

          The name of the conformance pack name.

        • ConformancePackComplianceStatus (string) –

          The status of the conformance pack.

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

  • ConfigService.Client.exceptions.InvalidLimitException

  • ConfigService.Client.exceptions.InvalidNextTokenException