NetworkFirewall / Paginator / ListFirewalls

ListFirewalls

class NetworkFirewall.Paginator.ListFirewalls

paginator = client.get_paginator('list_firewalls')

paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkFirewall.Client.list_firewalls().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• VpcIds (list) –

  The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls for. Leave this blank to retrieve all firewalls that you have defined.

  • (string) –

• 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

{
    'Firewalls': [
        {
            'FirewallName': 'string',
            'FirewallArn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Firewalls (list) –

    The firewall metadata objects for the VPCs that you specified. Depending on your setting for max results and the number of firewalls you have, a single call might not be the full list.

    • (dict) –

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

      • FirewallName (string) –

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

      • FirewallArn (string) –

        The Amazon Resource Name (ARN) of the firewall.