Route53Resolver / Client / batch_update_firewall_rule

batch_update_firewall_rule

Route53Resolver.Client.batch_update_firewall_rule(**kwargs)

Updates multiple DNS Firewall rules in the specified rule group.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_firewall_rule(
    UpdateFirewallRuleEntries=[
        {
            'FirewallRuleGroupId': 'string',
            'FirewallDomainListId': 'string',
            'FirewallThreatProtectionId': 'string',
            'Priority': 123,
            'Action': 'ALLOW'|'BLOCK'|'ALERT',
            'BlockResponse': 'NODATA'|'NXDOMAIN'|'OVERRIDE',
            'BlockOverrideDomain': 'string',
            'BlockOverrideDnsType': 'CNAME',
            'BlockOverrideTtl': 123,
            'Name': 'string',
            'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN'|'TRUST_REDIRECTION_DOMAIN',
            'Qtype': 'string',
            'DnsThreatProtection': 'DGA'|'DNS_TUNNELING'|'DICTIONARY_DGA',
            'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH',
            'FirewallRuleType': {
                'FirewallAdvancedContentCategory': {
                    'Category': 'string'
                },
                'FirewallAdvancedThreatCategory': {
                    'Category': 'string'
                },
                'DnsThreatProtection': {
                    'Value': 'string',
                    'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH'
                }
            }
        },
    ]
)

Parameters:

UpdateFirewallRuleEntries (list) –

[REQUIRED]

The list of firewall rules to update.

• (dict) –

  The details for updating a single firewall rule in a batch operation.

  • FirewallRuleGroupId (string) – [REQUIRED]

    The unique identifier of the firewall rule group for the rule.

  • FirewallDomainListId (string) –

    The ID of the domain list to use in the rule. This setting is mutually exclusive with DnsThreatProtection and FirewallRuleType.

  • FirewallThreatProtectionId (string) –

    The ID of the DNS Firewall Advanced rule.

  • Priority (integer) –

    The setting that determines the processing order of the rule in 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 and send metrics and logs to CloudWatch.

    • BLOCK - Disallow the request. This option requires additional details in the rule’s BlockResponse.

  • BlockResponse (string) –

    The way that you want DNS Firewall to block the request, used with 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.

    This setting is required if the BlockResponse setting is OVERRIDE.

  • Name (string) –

    The name of the rule.

  • FirewallDomainRedirectionAction (string) –

    How you want 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 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-65534, for example, TYPE28. For more information, see List of DNS record types.

  • DnsThreatProtection (string) –

    The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

    • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains 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.

    • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

  • ConfidenceThreshold (string) –

    The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update 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.

  • FirewallRuleType (dict) –

    The rule type configuration for the firewall rule. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields.

    • FirewallAdvancedContentCategory (dict) –

      The configuration for a content category-based filtering rule.

      • Category (string) – [REQUIRED]

        The content category identifier. To retrieve the list of available content categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedContentCategory.

    • FirewallAdvancedThreatCategory (dict) –

      The configuration for a threat category-based filtering rule.

      • Category (string) – [REQUIRED]

        The threat category identifier. To retrieve the list of available threat categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedThreatCategory.

    • DnsThreatProtection (dict) –

      The configuration for a DNS threat protection rule type, such as DGA or DNS tunneling detection.

      • Value (string) – [REQUIRED]

        The type of DNS threat protection. Valid values are:

        • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains 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.

        • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

      • ConfidenceThreshold (string) – [REQUIRED]

        The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update 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.

Return type:

dict

Returns:

Response Syntax

{
    'UpdatedFirewallRules': [
        {
            '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'|'DICTIONARY_DGA',
            'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH',
            'FirewallRuleType': {
                'FirewallAdvancedContentCategory': {
                    'Category': 'string'
                },
                'FirewallAdvancedThreatCategory': {
                    'Category': 'string'
                },
                'DnsThreatProtection': {
                    'Value': 'string',
                    'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH'
                }
            }
        },
    ],
    'UpdateErrors': [
        {
            'FirewallRule': {
                'FirewallRuleGroupId': 'string',
                'FirewallDomainListId': 'string',
                'FirewallThreatProtectionId': 'string',
                'Priority': 123,
                'Action': 'ALLOW'|'BLOCK'|'ALERT',
                'BlockResponse': 'NODATA'|'NXDOMAIN'|'OVERRIDE',
                'BlockOverrideDomain': 'string',
                'BlockOverrideDnsType': 'CNAME',
                'BlockOverrideTtl': 123,
                'Name': 'string',
                'FirewallDomainRedirectionAction': 'INSPECT_REDIRECTION_DOMAIN'|'TRUST_REDIRECTION_DOMAIN',
                'Qtype': 'string',
                'DnsThreatProtection': 'DGA'|'DNS_TUNNELING'|'DICTIONARY_DGA',
                'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH',
                'FirewallRuleType': {
                    'FirewallAdvancedContentCategory': {
                        'Category': 'string'
                    },
                    'FirewallAdvancedThreatCategory': {
                        'Category': 'string'
                    },
                    'DnsThreatProtection': {
                        'Value': 'string',
                        'ConfidenceThreshold': 'LOW'|'MEDIUM'|'HIGH'
                    }
                }
            },
            'Code': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • UpdatedFirewallRules (list) –

    The firewall rules that were successfully updated by the request.

    • (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-65534, 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.

      • FirewallRuleType (dict) –

        The rule type configuration for the firewall rule. Exactly one member of this union should be set.

        • FirewallAdvancedContentCategory (dict) –

          The configuration for a content category-based filtering rule.

          • Category (string) –

            The content category identifier. To retrieve the list of available content categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedContentCategory.

        • FirewallAdvancedThreatCategory (dict) –

          The configuration for a threat category-based filtering rule.

          • Category (string) –

            The threat category identifier. To retrieve the list of available threat categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedThreatCategory.

        • DnsThreatProtection (dict) –

          The configuration for a DNS threat protection rule type, such as DGA or DNS tunneling detection.

          • Value (string) –

            The type of DNS threat protection. Valid values are:

            • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains 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.

            • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

          • ConfidenceThreshold (string) –

            The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update 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.

  • UpdateErrors (list) –

    A list of errors that occurred while updating the firewall rules.

    • (dict) –

      An error that occurred while updating a firewall rule in a batch operation.

      • FirewallRule (dict) –

        The firewall rule entry that caused the error.

        • FirewallRuleGroupId (string) –

          The unique identifier of the firewall rule group for the rule.

        • FirewallDomainListId (string) –

          The ID of the domain list to use in the rule. This setting is mutually exclusive with DnsThreatProtection and FirewallRuleType.

        • FirewallThreatProtectionId (string) –

          The ID of the DNS Firewall Advanced rule.

        • Priority (integer) –

          The setting that determines the processing order of the rule in 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 and send metrics and logs to CloudWatch.

          • BLOCK - Disallow the request. This option requires additional details in the rule’s BlockResponse.

        • BlockResponse (string) –

          The way that you want DNS Firewall to block the request, used with 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.

          This setting is required if the BlockResponse setting is OVERRIDE.

        • Name (string) –

          The name of the rule.

        • FirewallDomainRedirectionAction (string) –

          How you want 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 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-65534, for example, TYPE28. For more information, see List of DNS record types.

        • DnsThreatProtection (string) –

          The type of the DNS Firewall Advanced rule. This setting is mutually exclusive with FirewallDomainListId and FirewallRuleType. Valid values are:

          • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains 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.

          • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

        • ConfidenceThreshold (string) –

          The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update 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.

        • FirewallRuleType (dict) –

          The rule type configuration for the firewall rule. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields.

          • FirewallAdvancedContentCategory (dict) –

            The configuration for a content category-based filtering rule.

            • Category (string) –

              The content category identifier. To retrieve the list of available content categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedContentCategory.

          • FirewallAdvancedThreatCategory (dict) –

            The configuration for a threat category-based filtering rule.

            • Category (string) –

              The threat category identifier. To retrieve the list of available threat categories, call ListFirewallRuleTypes with RuleType set to FirewallAdvancedThreatCategory.

          • DnsThreatProtection (dict) –

            The configuration for a DNS threat protection rule type, such as DGA or DNS tunneling detection.

            • Value (string) –

              The type of DNS threat protection. Valid values are:

              • DGA: Domain generation algorithms detection. DGAs are used by attackers to generate a large number of domains 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.

              • DICT_DGA: Dictionary-based domain generation algorithms detection. Dictionary DGAs use wordlists to generate domains that appear more legitimate, making them harder to detect than traditional DGAs.

            • ConfidenceThreshold (string) –

              The confidence threshold for DNS Firewall Advanced. You must provide this value when you create or update 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.

      • Code (string) –

        The error code for the failure.

      • Message (string) –

        A message that provides details about the error.

Exceptions

• Route53Resolver.Client.exceptions.ValidationException

• Route53Resolver.Client.exceptions.LimitExceededException

• Route53Resolver.Client.exceptions.AccessDeniedException

• Route53Resolver.Client.exceptions.InternalServiceErrorException

• Route53Resolver.Client.exceptions.ThrottlingException