Route53GlobalResolver / Client / list_firewall_rules

list_firewall_rules¶

Route53GlobalResolver.Client.list_firewall_rules(**kwargs)¶

Lists all DNS firewall rules for a DNS view with pagination support.

Warning

Route 53 Global Resolver is a global service that supports resolvers in multiple Amazon Web Services Regions but you must specify the US East (Ohio) Region to create, update, or otherwise work with Route 53 Global Resolver resources. That is, for example, specify --region us-east-2 on Amazon Web Services CLI commands.

Request Syntax

response = client.list_firewall_rules(
    maxResults=123,
    nextToken='string',
    dnsViewId='string',
    filters={
        'string': [
            'string',
        ]
    }
)

Parameters:

maxResults (integer) – The maximum number of results to retrieve in a single call.
nextToken (string) – A pagination token used for large sets of results that can’t be returned in a single response.
dnsViewId (string) –
[REQUIRED]

ID of the DNS view.
filters (dict) –
Values to filter the results.
- (string) –
  - (list) –
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'|'DICTIONARY_DGA',
            'firewallDomainListId': 'string',
            'id': 'string',
            'name': 'string',
            'priority': 123,
            'dnsViewId': 'string',
            'queryType': 'string',
            'status': 'CREATING'|'OPERATIONAL'|'UPDATING'|'DELETING',
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A pagination token used for large sets of results that can’t be returned in a single response. Provide this token in the next call to get the results not returned in this call.
- 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.

Exceptions

Route53GlobalResolver.Client.exceptions.InternalServerException
Route53GlobalResolver.Client.exceptions.ValidationException
Route53GlobalResolver.Client.exceptions.AccessDeniedException
Route53GlobalResolver.Client.exceptions.ThrottlingException
Route53GlobalResolver.Client.exceptions.ResourceNotFoundException