NetworkFirewall / Client / list_proxy_rule_groups

list_proxy_rule_groups¶

NetworkFirewall.Client.list_proxy_rule_groups(**kwargs)¶

Retrieves the metadata for the proxy rule groups that you have defined. Depending on your setting for max results and the number of proxy rule groups, a single call might not return the full list.

Request Syntax

response = client.list_proxy_rule_groups(
    NextToken='string',
    MaxResults=123
)

Parameters:

NextToken (string) – When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
MaxResults (integer) – The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Return type:

dict

Returns:

Response Syntax

{
    'ProxyRuleGroups': [
        {
            'Name': 'string',
            'Arn': 'string'
        },
    ],
    'NextToken': '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.
- NextToken (string) –
  
  When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Exceptions

NetworkFirewall.Client.exceptions.InvalidRequestException
NetworkFirewall.Client.exceptions.InternalServerError
NetworkFirewall.Client.exceptions.ResourceNotFoundException
NetworkFirewall.Client.exceptions.ThrottlingException