Route53Resolver / Client / list_firewall_rules

list_firewall_rules#

Route53Resolver.Client.list_firewall_rules(**kwargs)#

Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.

A single call might return only a partial list of the rules. For information, see MaxResults.

Request Syntax

response = client.list_firewall_rules(
    FirewallRuleGroupId='string',
    Priority=123,
    Action='ALLOW'|'BLOCK'|'ALERT',
    MaxResults=123,
    NextToken='string'
)

Parameters:

FirewallRuleGroupId (string) –
[REQUIRED]

The unique identifier of the firewall rule group that you want to retrieve the rules for.
Priority (integer) –
Optional additional filter for the rules to retrieve.

The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
Action (string) –
Optional additional filter for the rules to retrieve.

The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list:
- ALLOW - Permit the request to go through.
- ALERT - Permit the request to go through but send an alert to the logs.
- BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule’s BlockResponse setting.
MaxResults (integer) –
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

If you don’t specify a value for MaxResults, Resolver returns up to 100 objects.
NextToken (string) –
For the first call to this list request, omit this value.

When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'FirewallRules': [
        {
            'FirewallRuleGroupId': 'string',
            'FirewallDomainListId': 'string',
            'Name': 'string',
            'Priority': 123,
            'Action': 'ALLOW'|'BLOCK'|'ALERT',
            'BlockResponse': 'NODATA'|'NXDOMAIN'|'OVERRIDE',
            'BlockOverrideDomain': 'string',
            'BlockOverrideDnsType': 'CNAME',
            'BlockOverrideTtl': 123,
            'CreatorRequestId': 'string',
            'CreationTime': 'string',
            'ModificationTime': 'string',
            'Qtype': 'string'
        },
    ]
}

Response Structure

(dict) –
- NextToken (string) –
  
  If objects are still available for retrieval, Resolver returns this token in the response. To retrieve the next batch of objects, provide this token in your next request.
- FirewallRules (list) –
  
  A list of the rules that you have defined.
  
  This might be a partial list of the firewall rules that you’ve defined. For information, see MaxResults.
  - (dict) –
    
    A single firewall rule in a rule group.
    - FirewallRuleGroupId (string) –
      
      The unique identifier of the firewall rule group of the rule.
    - FirewallDomainListId (string) –
      
      The ID of the domain list that’s used in the rule.
    - Name (string) –
      
      The name of the rule.
    - Priority (integer) –
      
      The priority of the rule in the rule group. This value must be unique within the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
    - Action (string) –
      
      The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule’s domain list:
      - ALLOW - Permit the request to go through.
      - ALERT - Permit the request to go through but send an alert to the logs.
      - BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule’s BlockResponse setting.
    - BlockResponse (string) –
      
      The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
      - NODATA - Respond indicating that the query was successful, but no response is available for it.
      - NXDOMAIN - Respond indicating that the domain name that’s in the query doesn’t exist.
      - OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule’s BlockOverride* settings.
    - BlockOverrideDomain (string) –
      
      The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
    - BlockOverrideDnsType (string) –
      
      The DNS record’s type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
    - BlockOverrideTtl (integer) –
      
      The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
    - CreatorRequestId (string) –
      
      A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp.
    - CreationTime (string) –
      
      The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).
    - ModificationTime (string) –
      
      The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
    - Qtype (string) –
      
      The DNS query type you want the rule to evaluate. Allowed values are;
      - A: Returns an IPv4 address.
      - AAAA: Returns an Ipv6 address.
      - CAA: Restricts CAs that can create SSL/TLS certifications for the domain.
      - CNAME: Returns another domain name.
      - DS: Record that identifies the DNSSEC signing key of a delegated zone.
      - MX: Specifies mail servers.
      - NAPTR: Regular-expression-based rewriting of domain names.
      - NS: Authoritative name servers.
      - PTR: Maps an IP address to a domain name.
      - SOA: Start of authority record for the zone.
      - SPF: Lists the servers authorized to send emails from a domain.
      - SRV: Application specific values that identify servers.
      - TXT: Verifies email senders and application-specific values.

Exceptions

Route53Resolver.Client.exceptions.ResourceNotFoundException
Route53Resolver.Client.exceptions.ValidationException
Route53Resolver.Client.exceptions.AccessDeniedException
Route53Resolver.Client.exceptions.InternalServiceErrorException
Route53Resolver.Client.exceptions.ThrottlingException