FMS / Paginator / ListPolicies

ListPolicies#

class FMS.Paginator.ListPolicies#
paginator = client.get_paginator('list_policies')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

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

{
    'PolicyList': [
        {
            'PolicyArn': 'string',
            'PolicyId': 'string',
            'PolicyName': 'string',
            'ResourceType': 'string',
            'SecurityServiceType': 'WAF'|'WAFV2'|'SHIELD_ADVANCED'|'SECURITY_GROUPS_COMMON'|'SECURITY_GROUPS_CONTENT_AUDIT'|'SECURITY_GROUPS_USAGE_AUDIT'|'NETWORK_FIREWALL'|'DNS_FIREWALL'|'THIRD_PARTY_FIREWALL'|'IMPORT_NETWORK_FIREWALL',
            'RemediationEnabled': True|False,
            'DeleteUnusedFMManagedResources': True|False,
            'PolicyStatus': 'ACTIVE'|'OUT_OF_ADMIN_SCOPE'
        },
    ],

}

Response Structure

  • (dict) –

    • PolicyList (list) –

      An array of PolicySummary objects.

      • (dict) –

        Details of the Firewall Manager policy.

        • PolicyArn (string) –

          The Amazon Resource Name (ARN) of the specified policy.

        • PolicyId (string) –

          The ID of the specified policy.

        • PolicyName (string) –

          The name of the specified policy.

        • ResourceType (string) –

          The type of resource protected by or in scope of the policy. This is in the format shown in the Amazon Web Services Resource Types Reference. For WAF and Shield Advanced, examples include AWS::ElasticLoadBalancingV2::LoadBalancer and AWS::CloudFront::Distribution. For a security group common policy, valid values are AWS::EC2::NetworkInterface and AWS::EC2::Instance. For a security group content audit policy, valid values are AWS::EC2::SecurityGroup, AWS::EC2::NetworkInterface, and AWS::EC2::Instance. For a security group usage audit policy, the value is AWS::EC2::SecurityGroup. For an Network Firewall policy or DNS Firewall policy, the value is AWS::EC2::VPC.

        • SecurityServiceType (string) –

          The service that the policy is using to protect the resources. This specifies the type of policy that is created, either an WAF policy, a Shield Advanced policy, or a security group policy.

        • RemediationEnabled (boolean) –

          Indicates if the policy should be automatically applied to new resources.

        • DeleteUnusedFMManagedResources (boolean) –

          Indicates whether Firewall Manager should automatically remove protections from resources that leave the policy scope and clean up resources that Firewall Manager is managing for accounts when those accounts leave policy scope. For example, Firewall Manager will disassociate a Firewall Manager managed web ACL from a protected customer resource when the customer resource leaves policy scope.

          By default, Firewall Manager doesn’t remove protections or delete Firewall Manager managed resources.

          This option is not available for Shield Advanced or WAF Classic policies.

        • PolicyStatus (string) –

          Indicates whether the policy is in or out of an admin’s policy or Region scope.

          • ACTIVE - The administrator can manage and delete the policy.

          • OUT_OF_ADMIN_SCOPE - The administrator can view the policy, but they can’t edit or delete the policy. Existing policy protections stay in place. Any new resources that come into scope of the policy won’t be protected.