ConfigService / Paginator / DescribeConformancePackCompliance

DescribeConformancePackCompliance

class ConfigService.Paginator.DescribeConformancePackCompliance

paginator = client.get_paginator('describe_conformance_pack_compliance')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ConformancePackName='string',
    Filters={
        'ConfigRuleNames': [
            'string',
        ],
        'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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.

• 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

{
    'ConformancePackName': 'string',
    'ConformancePackRuleComplianceList': [
        {
            'ConfigRuleName': 'string',
            'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
            'Controls': [
                '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.

      • 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) –