Route53Resolver / Paginator / ListFirewallRules

ListFirewallRules#

class Route53Resolver.Paginator.ListFirewallRules#
paginator = client.get_paginator('list_firewall_rules')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FirewallRuleGroupId='string',
    Priority=123,
    Action='ALLOW'|'BLOCK'|'ALERT',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': '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, or a threat in a DNS Firewall Advanced rule:

    • ALLOW - Permit the request to go through. Not availabe for DNS Firewall Advanced rules.

    • 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.

  • 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': [
        {
            'FirewallRuleGroupId': 'string',
            'FirewallDomainListId': 'string',
            'FirewallThreatProtectionId': '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',
            'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN'|'TRUST_REDIRECTION_DOMAIN',
            'Qtype': 'string',
            'DnsThreatProtection': 'DGA'|'DNS_TUNNELING',
            'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH'
        },
    ]
}

Response Structure

  • (dict) –

    • 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.

        • FirewallThreatProtectionId (string) –

          ID of the DNS Firewall Advanced 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, or a threat in a DNS Firewall Advanced rule:

          • ALLOW - Permit the request to go through. Not available for DNS Firewall Advanced rules.

          • 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).

        • FirewallDomainRedirectionAction (string) –

          How you want the the rule to evaluate DNS redirection in the DNS redirection chain, such as CNAME or DNAME.

          INSPECT_REDIRECTION_DOMAIN: (Default) inspects all domains in the redirection chain. The individual domains in the redirection chain must be added to the domain list.

          TRUST_REDIRECTION_DOMAIN: Inspects only the first domain in the redirection chain. You don’t need to add the subsequent domains in the domain in the redirection list to the domain list.

        • 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.

          • A query type you define by using the DNS type ID, for example 28 for AAAA. The values must be defined as TYPENUMBER, where the NUMBER can be 1-65334, for example, TYPE28. For more information, see List of DNS record types.

        • DnsThreatProtection (string) –

          The type of the DNS Firewall Advanced rule. Valid values are:

          • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains to to launch malware attacks.

          • DNS_TUNNELING: DNS tunneling detection. DNS tunneling is used by attackers to exfiltrate data from the client by using the DNS tunnel without making a network connection to the client.

        • ConfidenceThreshold (string) –

          The confidence threshold for DNS Firewall Advanced. You must provide this value when you create a DNS Firewall Advanced rule. The confidence level values mean:

          • LOW: Provides the highest detection rate for threats, but also increases false positives.

          • MEDIUM: Provides a balance between detecting threats and false positives.

          • HIGH: Detects only the most well corroborated threats with a low rate of false positives.