NetworkFirewall / Paginator / ListFirewallPolicies

ListFirewallPolicies

class NetworkFirewall.Paginator.ListFirewallPolicies

paginator = client.get_paginator('list_firewall_policies')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkFirewall.Client.list_firewall_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

{
    'FirewallPolicies': [
        {
            'Name': 'string',
            'Arn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • FirewallPolicies (list) –

    The metadata for the firewall policies. Depending on your setting for max results and the number of firewall policies that you have, this might not be the full list.

    • (dict) –

      High-level information about a firewall policy, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a firewall policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

      • Name (string) –

        The descriptive name of the firewall policy. You can’t change the name of a firewall policy after you create it.

      • Arn (string) –

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