NetworkFirewall / Paginator / ListProxyRuleGroups

ListProxyRuleGroups¶

class NetworkFirewall.Paginator.ListProxyRuleGroups¶

paginator = client.get_paginator('list_proxy_rule_groups')

paginate(**kwargs)¶

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

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

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

}

Response Structure

(dict) –
- ProxyRuleGroups (list) –
  
  The metadata for the proxy rule groups. Depending on your setting for max results and the number of proxy rule groups that you have, this might not be the full list.
  - (dict) –
    
    High-level information about a proxy rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a proxy rule group. You can retrieve all objects for a proxy rule group by calling DescribeProxyRuleGroup.
    - Name (string) –
      
      The descriptive name of the proxy rule group. You can’t change the name of a proxy rule group after you create it.
    - Arn (string) –
      
      The Amazon Resource Name (ARN) of a proxy rule group.