Route53GlobalResolver / Paginator / ListFirewallRules

ListFirewallRules¶

class Route53GlobalResolver.Paginator.ListFirewallRules¶

paginator = client.get_paginator('list_firewall_rules')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from Route53GlobalResolver.Client.list_firewall_rules().

Request Syntax

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

Parameters:

dnsViewId (string) –
[REQUIRED]

ID of the DNS view.
filters (dict) –
Values to filter the results.
- (string) –
  - (list) –
    - (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

{
    'firewallRules': [
        {
            'action': 'ALLOW'|'ALERT'|'BLOCK',
            'blockOverrideDnsType': 'CNAME',
            'blockOverrideDomain': 'string',
            'blockOverrideTtl': 123,
            'blockResponse': 'NODATA'|'NXDOMAIN'|'OVERRIDE',
            'confidenceThreshold': 'LOW'|'MEDIUM'|'HIGH',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'dnsAdvancedProtection': 'DGA'|'DNS_TUNNELING',
            'firewallDomainListId': 'string',
            'id': 'string',
            'name': 'string',
            'priority': 123,
            'dnsViewId': 'string',
            'queryType': 'string',
            'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- firewallRules (list) –
  
  List of the firewall rules and information about them.
  - (dict) –
    
    Summary information about a firewall rule.
    - action (string) –
      
      The action configured for the firewall rule.
    - blockOverrideDnsType (string) –
      
      The DNS record type configured for the firewall rule’s custom response.
    - blockOverrideDomain (string) –
      
      The custom domain name configured for the firewall rule’s BLOCK response.
    - blockOverrideTtl (integer) –
      
      The TTL value configured for the firewall rule’s custom response.
    - blockResponse (string) –
      
      The type of block response configured for the firewall rule.
    - confidenceThreshold (string) –
      
      The confidence threshold configured for the firewall rule’s advanced threat detection.
    - createdAt (datetime) –
      
      The date and time when the firewall rule was created.
    - description (string) –
      
      The description of the firewall rule.
    - dnsAdvancedProtection (string) –
      
      Whether advanced DNS threat protection is enabled for the firewall rule.
    - firewallDomainListId (string) –
      
      The ID of the firewall domain list associated with the firewall rule.
    - id (string) –
      
      The unique identifier of the firewall rule.
    - name (string) –
      
      The name of the firewall rule.
    - priority (integer) –
      
      The priority of the firewall rule.
    - dnsViewId (string) –
      
      The ID of the DNS view associated with the firewall rule.
    - queryType (string) –
      
      The DNS query type that the firewall rule matches.
    - status (string) –
      
      The current status of the firewall rule.
    - updatedAt (datetime) –
      
      The date and time when the firewall rule was last updated.
- NextToken (string) –
  
  A token to resume pagination.