describe_conformance_pack_compliance

ConfigService.Client.describe_conformance_pack_compliance(**kwargs)

Returns compliance details for each rule in that conformance pack.

Note

You must provide exact rule names.

See also: AWS API Documentation

Request Syntax

response = client.describe_conformance_pack_compliance(
    ConformancePackName='string',
    Filters={
        'ConfigRuleNames': [
            'string',
        ],
        'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
    },
    Limit=123,
    NextToken='string'
)

Parameters

• ConformancePackName (string) --

  [REQUIRED]

  Name of the conformance pack.

• Filters (dict) --

  A ConformancePackComplianceFilters object.

  • ConfigRuleNames (list) --

    Filters the results by Config rule names.

    • (string) --
  • ComplianceType (string) --

    Filters the results by compliance.

    The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not supported.

• Limit (integer) -- The maximum number of Config rules within a conformance pack are returned on each page.
• NextToken (string) -- The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Return type

dict

Returns

Response Syntax

{
    'ConformancePackName': 'string',
    'ConformancePackRuleComplianceList': [
        {
            'ConfigRuleName': 'string',
            'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
            'Controls': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • ConformancePackName (string) --

    Name of the conformance pack.

  • ConformancePackRuleComplianceList (list) --

    Returns a list of ConformancePackRuleCompliance objects.

    • (dict) --

      Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

      • ConfigRuleName (string) --

        Name of the Config rule.

      • ComplianceType (string) --

        Compliance of the Config rule.

        The allowed values are COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA .

      • Controls (list) --

        Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

        • (string) --

  • NextToken (string) --

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Exceptions

• ConfigService.Client.exceptions.InvalidLimitException
• ConfigService.Client.exceptions.InvalidNextTokenException
• ConfigService.Client.exceptions.InvalidParameterValueException
• ConfigService.Client.exceptions.NoSuchConfigRuleInConformancePackException
• ConfigService.Client.exceptions.NoSuchConformancePackException