FMS / Paginator / ListComplianceStatus

ListComplianceStatus

class FMS.Paginator.ListComplianceStatus

paginator = client.get_paginator('list_compliance_status')

paginate(**kwargs)

Creates an iterator that will paginate through responses from FMS.Client.list_compliance_status().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PolicyId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• PolicyId (string) –

  [REQUIRED]

  The ID of the Firewall Manager policy that you want the details for.

• 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

{
    'PolicyComplianceStatusList': [
        {
            'PolicyOwner': 'string',
            'PolicyId': 'string',
            'PolicyName': 'string',
            'MemberAccount': 'string',
            'EvaluationResults': [
                {
                    'ComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT',
                    'ViolatorCount': 123,
                    'EvaluationLimitExceeded': True|False
                },
            ],
            'LastUpdated': datetime(2015, 1, 1),
            'IssueInfoMap': {
                'string': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  • PolicyComplianceStatusList (list) –

    An array of PolicyComplianceStatus objects.

    • (dict) –

      Indicates whether the account is compliant with the specified policy. An account is considered noncompliant if it includes resources that are not protected by the policy, for WAF and Shield Advanced policies, or that are noncompliant with the policy, for security group policies.

      • PolicyOwner (string) –

        The Amazon Web Services account that created the Firewall Manager policy.

      • PolicyId (string) –

        The ID of the Firewall Manager policy.

      • PolicyName (string) –

        The name of the Firewall Manager policy.

      • MemberAccount (string) –

        The member account ID.

      • EvaluationResults (list) –

        An array of EvaluationResult objects.

        • (dict) –

          Describes the compliance status for the account. An account is considered noncompliant if it includes resources that are not protected by the specified policy or that don’t comply with the policy.

          • ComplianceStatus (string) –

            Describes an Amazon Web Services account’s compliance with the Firewall Manager policy.

          • ViolatorCount (integer) –

            The number of resources that are noncompliant with the specified policy. For WAF and Shield Advanced policies, a resource is considered noncompliant if it is not associated with the policy. For security group policies, a resource is considered noncompliant if it doesn’t comply with the rules of the policy and remediation is disabled or not possible.

          • EvaluationLimitExceeded (boolean) –

            Indicates that over 100 resources are noncompliant with the Firewall Manager policy.

      • LastUpdated (datetime) –

        Timestamp of the last update to the EvaluationResult objects.

      • IssueInfoMap (dict) –

        Details about problems with dependent services, such as WAF or Config, and the error message received that indicates the problem with the service.

        • (string) –

          • (string) –