Module Smaws_Client_Route53Resolver.Types

The Server Name Indication of the DoH server that you want to forward queries to. This is only used if the Protocol of the TargetAddress is DoH.

The protocols for the target address. The protocol you choose needs to be supported by the outbound endpoint of the Resolver rule.

One IPv6 address that you want to forward DNS queries to.

The port at Ip that you want to forward DNS queries to.

One IPv4 address that you want to forward DNS queries to.

DNS queries with delegation records that point to this domain name are forwarded to resolvers on your network.

The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).

The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).

Whether the rule is shared and, if so, whether the current account is sharing the rule with another account, or another account is sharing the rule with the current account.

When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.

The ID of the endpoint that the rule is associated with.

An array that contains the IP addresses and ports that an outbound endpoint forwards DNS queries to. Typically, these are the IP addresses of DNS resolvers on your network.

The name for the Resolver rule, which you specified when you created the Resolver rule.

The name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (_), and spaces. The name cannot consist of only numbers.

When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD or DELEGATE. If a query matches multiple Resolver rules (example.com and www.example.com), outbound DNS queries are routed using the Resolver rule that contains the most specific domain name (www.example.com).

When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.

For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.

Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.

A detailed description of the status of a Resolver rule.

A code that specifies the current status of the Resolver rule.

DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).

The ARN (Amazon Resource Name) for the Resolver rule specified by Id.

A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice.

The ID that Resolver assigned to the Resolver rule when you created it.

The response to an UpdateResolverRule request.

The ID of the new outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in TargetIps.

For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.

The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console.

The name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (_), and spaces. The name cannot consist of only numbers.

The new settings for the Resolver rule.

The ID of the Resolver rule that you want to update.

For a ResourceUnavailableException error, the type of resource that isn't available.

For a ResourceNotFoundException error, the type of resource that doesn't exist.

For a LimitExceededException error, the type of resource that exceeded the current limit.

For an InvalidParameterException error, the name of the parameter that's invalid.

Indicates whether IPv6 internet access is enabled for the outbound Resolver endpoint. When true, the endpoint elastic network interfaces (ENIs) can forward DNS queries to public IPv6 targets through an internet gateway.

Indicates whether DNS64 is enabled for the inbound Resolver endpoint. When true, Route 53 Resolver synthesizes AAAA (IPv6) records for IPv4-only services by prepending the 64:ff9b::/96 prefix to the IPv4 address.

Indicates whether target name server metrics are enabled for the outbound Resolver endpoint. When enabled, one-minute granular metrics are published in CloudWatch for each target name server associated with this endpoint. When disabled, these metrics are not published. This feature is not supported for inbound Resolver endpoint.

Indicates whether RNI enhanced metrics are enabled for the Resolver endpoint. When enabled, one-minute granular metrics are published in CloudWatch for each RNI associated with this endpoint. When disabled, these metrics are not published.

Protocols used for the endpoint. DoH-FIPS is applicable for a default inbound endpoints only.

For an inbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.
• Do53 and DoH-FIPS in combination.
• Do53 alone.
• DoH alone.
• DoH-FIPS alone.
• None, which is treated as Do53.

For a delegation inbound endpoint you can use Do53 only.

For an outbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.
• Do53 alone.
• DoH alone.
• None, which is treated as Do53.

The Resolver endpoint IP address type.

The Amazon EC2 instance type.

The ARN (Amazon Resource Name) for the Outpost.

The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).

The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).

A detailed description of the status of the Resolver endpoint.

A code that specifies the current status of the Resolver endpoint. Valid values include the following:

• CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
• OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
• UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
• AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.

• ACTION_NEEDED: This endpoint is unhealthy, and Resolver can't automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn't available, add another IP address and then delete the IP address that isn't available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:

  • One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
  • The network interface couldn't be created for some reason that's outside the control of Resolver.
• DELETING: Resolver is deleting this endpoint and the associated network interfaces.

The ID of the VPC that you want to create the Resolver endpoint in.

The number of IP addresses that the Resolver endpoint can use for DNS queries.

Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:

• INBOUND: allows DNS queries to your VPC from your network
• OUTBOUND: allows DNS queries from your VPC to your network
• INBOUND_DELEGATION: Resolver delegates queries to Route 53 private hosted zones from your network.

The ID of one or more security groups that control access to this VPC. The security group must include one or more inbound rules (for inbound endpoints) or outbound rules (for outbound endpoints). Inbound and outbound rules must allow TCP and UDP access. For inbound access, open port 53. For outbound access, open the port that you're using for DNS queries on your network.

The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.

The ARN (Amazon Resource Name) for the Resolver endpoint.

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

The ID of the Resolver endpoint.

The response to an UpdateResolverEndpoint request.

The IPv6 address that you want to use for DNS queries.

The ID of the IP address, specified by the ResolverEndpointId.

Specifies whether IPv6 internet access is enabled for the outbound Resolver endpoint. When set to true, the endpoint elastic network interfaces (ENIs) can forward DNS queries to public IPv6 targets through an internet gateway.

When you enable IPv6 internet access, use network controls like security groups, NACLs, or egress-only internet gateways to protect the endpoint ENIs from unsolicited ingress traffic. Be aware that some network controls can affect DNS query throughput due to connection tracking. For more information, see Amazon EC2 security group connection tracking and Resolver endpoint scaling.

Specifies whether DNS64 is enabled for the inbound Resolver endpoint. When set to true, Route 53 Resolver synthesizes AAAA (IPv6) records for IPv4-only services by prepending the 64:ff9b::/96 prefix to the IPv4 address. This enables IPv6-only clients that send queries through the inbound endpoint to reach IPv4-only services. DNS64 works with NAT64 to provide complete IPv6-to-IPv4 translation.

Updates whether target name server metrics are enabled for the outbound Resolver endpoints. When set to true, one-minute granular metrics are published in CloudWatch for each target name server associated with this endpoint. When set to false, metrics are not published. This setting is not supported for inbound Resolver endpoints.

Standard CloudWatch pricing and charges are applied for using the Route 53 Resolver endpoint target name server metrics. For more information, see Detailed metrics.

Updates whether RNI enhanced metrics are enabled for the Resolver endpoints. When set to true, one-minute granular metrics are published in CloudWatch for each RNI associated with this endpoint. When set to false, metrics are not published.

Standard CloudWatch pricing and charges are applied for using the Route 53 Resolver endpoint RNI enhanced metrics. For more information, see Detailed metrics.

The protocols you want to use for the endpoint. DoH-FIPS is applicable for default inbound endpoints only.

For a default inbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.
• Do53 and DoH-FIPS in combination.
• Do53 alone.
• DoH alone.
• DoH-FIPS alone.
• None, which is treated as Do53.

For a delegation inbound endpoint you can use Do53 only.

For an outbound endpoint you can apply the protocols as follows:

• Do53 and DoH in combination.
• Do53 alone.
• DoH alone.
• None, which is treated as Do53.

You can't change the protocol of an inbound endpoint directly from only Do53 to only DoH, or DoH-FIPS. This is to prevent a sudden disruption to incoming traffic that relies on Do53. To change the protocol from Do53 to DoH, or DoH-FIPS, you must first enable both Do53 and DoH, or Do53 and DoH-FIPS, to make sure that all incoming traffic has transferred to using the DoH protocol, or DoH-FIPS, and then remove the Do53.

Specifies the IPv6 address when you update the Resolver endpoint from IPv4 to dual-stack. If you don't specify an IPv6 address, one will be automatically chosen from your subnet.

Specifies the endpoint type for what type of IP address the endpoint uses to forward DNS queries.

Updating to IPV6 type isn't currently supported.

The name of the Resolver endpoint that you want to update.

The ID of the Resolver endpoint that you want to update.

The validation status for a DNSSEC configuration. The status can be one of the following:

• ENABLING: DNSSEC validation is being enabled but is not complete.
• ENABLED: DNSSEC validation is enabled.
• DISABLING: DNSSEC validation is being disabled but is not complete.
• DISABLED DNSSEC validation is disabled.

The ID of the virtual private cloud (VPC) that you're configuring the DNSSEC validation status for.

The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.

The ID for a configuration for DNSSEC validation.

A complex type that contains settings for the specified DNSSEC configuration.

The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status change to be completed.

The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for.

The status of whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. The status can be one of following:

• ENABLING: Autodefined rules for reverse DNS lookups are being enabled but are not complete.
• ENABLED: Autodefined rules for reverse DNS lookups are enabled.
• DISABLING: Autodefined rules for reverse DNS lookups are being disabled but are not complete.
• DISABLED: Autodefined rules for reverse DNS lookups are disabled.

The owner account ID of the Amazon Virtual Private Cloud VPC.

The ID of the Amazon Virtual Private Cloud VPC or a Route 53 Profile that you're configuring Resolver for.

ID for the Resolver configuration.

An array that contains settings for the specified Resolver configuration.

Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.

It can take some time for the status change to be completed.

The ID of the Amazon Virtual Private Cloud VPC or a Route 53 Profile that you're configuring Resolver for.

The ARN (Amazon Resource Name) for the Outpost.

A detailed description of the Resolver.

Status of the Resolver.

Name of the Resolver.

The Amazon EC2 instance type.

Amazon EC2 instance count for the Resolver on the Outpost.

The ID of the Resolver on Outpost.

A unique string that identifies the request that created the Resolver endpoint. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

The date and time that the Outpost Resolver was modified, in Unix time format and Coordinated Universal Time (UTC).

The date and time that the Outpost Resolver was created, in Unix time format and Coordinated Universal Time (UTC).

The ARN (Amazon Resource Name) for the Resolver on an Outpost.

The response to an UpdateOutpostResolver request.

Amazon EC2 instance type.

The Amazon EC2 instance count for a Resolver on the Outpost.

Name of the Resolver on the Outpost.

A unique string that identifies Resolver on an Outpost.

The identifier of the partner threat-protection product, exactly as returned in the Value field of a FirewallRuleTypeDefinition with RuleType set to PartnerThreatProtection. The calling account must hold an active AWS Marketplace subscription to this product.

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

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

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.

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

Configures the rule to match a built-in DNS Firewall Advanced threat detector — DGA, DNS_TUNNELING, or DICTIONARY_DGA. See DnsThreatProtectionRuleTypeConfig.

Configures the rule to match an AWS-managed advanced threat category (for example, PHISHING). See FirewallAdvancedThreatCategoryConfig.

Configures the rule to match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH). See FirewallAdvancedContentCategoryConfig.

Configures the rule to match a third-party threat feed delivered through AWS Marketplace. The calling account must hold an active subscription to the partner product named in Partner; if the subscription is missing or revoked, the rule is created with Status CREATION_FAILED and cannot be modified — only deleted. See PartnerThreatProtectionConfig.

An additional message about the rule's lifecycle state. Populated when Status is CREATION_FAILED to describe why provisioning failed.

The lifecycle state of the firewall rule. Possible values:

• CREATING — DNS Firewall is provisioning the rule. Rules created with the PartnerThreatProtection rule type begin in this state while DNS Firewall verifies the calling account's AWS Marketplace entitlement.
• COMPLETE — The rule is provisioned and enforcing matches.
• CREATION_FAILED — Provisioning failed. StatusMessage contains a human-readable reason. A rule in this state is immutable: UpdateFirewallRule rejects the request, and the rule must be removed with DeleteFirewallRule.

For rules that do not require asynchronous provisioning, this field may be absent.

The rule type configuration for the firewall rule. This is a tagged union — exactly one of its members will be populated. Possible members are:

• FirewallAdvancedContentCategory — an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).
• FirewallAdvancedThreatCategory — an AWS-managed advanced threat category (for example, PHISHING).
• DnsThreatProtection — a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).
• PartnerThreatProtection — a third-party threat feed delivered through AWS Marketplace.

To enumerate the values supported in your account, call ListFirewallRuleTypes.

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.

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

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.

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.

The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).

The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC).

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.

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.

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.

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

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.

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.

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.

The name of the rule.

ID of the DNS Firewall Advanced rule.

The ID of the domain list that's used in the rule.

The unique identifier of the Firewall rule group of the rule.

The firewall rule that you just updated.

The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of:

• FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).
• FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING).
• DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).
• PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account.

To enumerate the values supported in your account, call ListFirewallRuleTypes.

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.

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

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.

  If you set up a firewall BLOCK rule with action NXDOMAIN on query type equals AAAA, this action will not be applied to synthetic IPv6 addresses generated when DNS64 is enabled.

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.

The name of the rule.

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.

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.

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

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.

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. This option requires additional details in the rule's BlockResponse.

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.

You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.

The DNS Firewall Advanced rule ID.

The ID of the domain list to use in the rule.

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

The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).

The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC).

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

Additional information about the status of the response, if available.

The current status of the association.

The owner of the association, used only for associations that are not managed by you. If you use Firewall Manager to manage your DNS Firewalls, then this reports Firewall Manager as the managed owner.

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from rule group with the lowest numeric priority setting.

The name of the association.

The unique identifier of the VPC that is associated with the rule group.

The unique identifier of the firewall rule group.

The Amazon Resource Name (ARN) of the firewall rule group association.

The identifier for the association.

The association that you just updated.

The name of the rule group association.

If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections.

The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.

The identifier of the FirewallRuleGroupAssociation.

The rule type configuration for the firewall rule. This is a tagged union — set exactly one of its members. This setting is mutually exclusive with the top-level FirewallDomainListId and DnsThreatProtection fields. Use one of:

• FirewallAdvancedContentCategory — match an AWS-managed content category (for example, VIOLENCE_AND_HATE_SPEECH).
• FirewallAdvancedThreatCategory — match an AWS-managed advanced threat category (for example, PHISHING).
• DnsThreatProtection — match a built-in DNS Firewall Advanced threat detector (DGA, DNS_TUNNELING, or DICTIONARY_DGA).
• PartnerThreatProtection — match a third-party threat feed delivered through AWS Marketplace. The selected partner must be an active subscription on the calling account.

To enumerate the values supported in your account, call ListFirewallRuleTypes.

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.

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

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.

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.

The name of the rule.

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.

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.

The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.

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.

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.

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.

The ID of the DNS Firewall Advanced rule.

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

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

Additional information about the status of the list, if available.

Status of the UpdateFirewallDomains request.

The name of the domain list.

The ID of the firewall domain list that DNS Firewall just updated.

A list of domains to use in the update operation.

There is a limit of 1000 domains per request.

Each domain specification in your domain list must satisfy the following requirements:

• It can optionally start with * (asterisk).
• With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).
• It must be from 1-255 characters in length.

What you want DNS Firewall to do with the domains that you are providing:

• ADD - Add the domains to the ones that are already in the domain list.
• REMOVE - Search the domain list for the domains and remove them from the list.
• REPLACE - Update the domain list to exactly match the list that you are providing.

The ID of the domain list whose domains you want to update.

Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

• By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query.
• If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.

The ID of the VPC that this firewall configuration applies to.

The ID of the firewall configuration.

Configuration of the firewall behavior provided by DNS Firewall for a single VPC.

Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.

• By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly.
• If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.

This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.

The ID of the VPC that the configuration is for.

The tags that you want to remove to the specified resource.

The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:

• GetResolverEndpoint
• GetResolverRule
• GetResolverRuleAssociation
• ListResolverEndpoints
• ListResolverRuleAssociations
• ListResolverRules

The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.

The name for the tag. For example, if you want to associate Resolver resources with the account IDs of your customers for billing purposes, the value of Key might be account-id.

The tags that you want to add to the specified resource.

The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:

• GetResolverEndpoint
• GetResolverRule
• GetResolverRuleAssociation
• ListResolverEndpoints
• ListResolverRuleAssociations
• ListResolverRules

The AWS Marketplace product identifier of the partner threat-protection product. Use this value to verify or manage the calling account's subscription in AWS Marketplace.

The name of the AWS Marketplace seller (vendor) that publishes the partner threat-protection product (for example, Palo Alto Networks).

Whether the PutResolverRulePolicy request was successful.

An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:

• route53resolver:GetResolverRule
• route53resolver:AssociateResolverRule
• route53resolver:DisassociateResolverRule
• route53resolver:ListResolverRules
• route53resolver:ListResolverRuleAssociations

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.

The Amazon Resource Name (ARN) of the rule that you want to share with another account.

Whether the PutResolverQueryLogConfigPolicy request was successful.

An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:

• route53resolver:AssociateResolverQueryLogConfig
• route53resolver:DisassociateResolverQueryLogConfig
• route53resolver:ListResolverQueryLogConfigs

In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.

The Amazon Resource Name (ARN) of the account that you want to share rules with.

The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.

The ARN (Amazon Resource Name) for the rule group that you want to share.

If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

The tags that are associated with the resource that you specified in the ListTagsForResource request.

For the first ListTagsForResource request, omit this value.

If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.

The maximum number of tags that you want to return in the response to a ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags.

The Amazon Resource Name (ARN) for the resource that you want to list tags for.

The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.

The value that you specified for MaxResults in the request.

If more than MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

When you're using a List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.

The name of the parameter that you want to use to filter objects.

The valid values for Name depend on the action that you're including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.

In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.

ListResolverEndpoints

Valid values for Name include the following:

• CreatorRequestId: The value that you specified when you created the Resolver endpoint.
• Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for Values.
• HostVPCId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId element.
• IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.
• Name: The name of the Resolver endpoint.
• SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.
• Status: The status of the Resolver endpoint. If you specify Status for Name, specify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in ResolverEndpoint.

ListResolverRules

Valid values for Name include the following:

• CreatorRequestId: The value that you specified when you created the Resolver rule.

• DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com:

  example.com.

• Name: The name of the Resolver rule.

• ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.

  You can filter on the Resolver endpoint only for rules that have a value of FORWARD for RuleType.

• Status: The status of the Resolver rule. If you specify Status for Name, specify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, or FAILED.
• Type: The type of the Resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for Values.

ListResolverRuleAssociations

Valid values for Name include the following:

• Name: The name of the Resolver rule association.
• ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.
• Status: The status of the Resolver rule association. If you specify Status for Name, specify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or FAILED.
• VPCId: The ID of the VPC that the Resolver rule is associated with.

ListResolverQueryLogConfigs

Valid values for Name include the following:

• Arn: The ARN for the query logging configuration.
• AssociationCount: The number of VPCs that are associated with the query logging configuration.
• CreationTime: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
• CreatorRequestId: A unique string that identifies the request that created the query logging configuration.

• Destination: The Amazon Web Services service that you want to forward query logs to. Valid values include the following:

  • S3
  • CloudWatchLogs
  • KinesisFirehose
• DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
• Id: The ID of the query logging configuration
• Name: The name of the query logging configuration
• OwnerId: The Amazon Web Services account ID for the account that created the query logging configuration.
• ShareStatus: An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Valid values include: NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
• Status: The status of the query logging configuration. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.

ListResolverQueryLogConfigAssociations

Valid values for Name include the following:

• CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
• Error: If the value of Status is FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED.
• Id: The ID of the query logging association.
• ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
• ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.
• Status: The status of the query logging association. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.

An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.

If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

For the first ListResolverRules request, omit this value.

If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.

The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver rules.

A detailed description of the status of the association between a Resolver rule and a VPC.

A code that specifies the current status of the association between a Resolver rule and a VPC.

The ID of the VPC that you associated the Resolver rule with.

The name of an association between a Resolver rule and a VPC.

The name can be up to 64 characters long and can contain letters (a-z, A-Z), numbers (0-9), hyphens (-), underscores (_), and spaces. The name cannot consist of only numbers.

The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.

The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.

The associations that were created between Resolver rules and VPCs using the current Amazon Web Services account, and that match the specified filters, if any.

The value that you specified for MaxResults in the request.

If more than MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.

If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

For the first ListResolverRuleAssociation request, omit this value.

If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.

The maximum number of rule associations that you want to return in the response to a ListResolverRuleAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 rule associations.

The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).

A unique string that identifies the request that created the query logging configuration. The CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.

The ARN of the resource that you want Resolver to send query logs: an Amazon S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.

The name of the query logging configuration.

The ARN for the query logging configuration.

The number of VPCs that are associated with the query logging configuration.

An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

The status of the specified query logging configuration. Valid values include the following:

• CREATING: Resolver is creating the query logging configuration.
• CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
• DELETING: Resolver is deleting this query logging configuration.

• FAILED: Resolver can't deliver logs to the location that is specified in the query logging configuration. Here are two common causes:

  • The specified destination (for example, an Amazon S3 bucket) was deleted.
  • Permissions don't allow sending logs to the destination.

The Amazon Web Services account ID for the account that created the query logging configuration.

The ID for the query logging configuration.

A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.

The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see TotalCount.

The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.

If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

The element that you want Resolver to sort query logging configurations by.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

• Arn: The ARN of the query logging configuration
• AssociationCount: The number of VPCs that are associated with the specified configuration
• CreationTime: The date and time that Resolver returned when the configuration was created
• CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created
• DestinationArn: The location that logs are sent to
• Id: The ID of the configuration
• Name: The name of the configuration
• OwnerId: The Amazon Web Services account number of the account that created the configuration
• ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

• Status: The current status of the configuration. Valid values include the following:

  • CREATING: Resolver is creating the query logging configuration.
  • CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
  • DELETING: Resolver is deleting this query logging configuration.

  • FAILED: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:

    • The specified destination (for example, an Amazon S3 bucket) was deleted.
    • Permissions don't allow sending logs to the destination.

An optional specification to return a subset of query logging configurations.

If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

For the first ListResolverQueryLogConfigs request, omit this value.

If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.

The maximum number of query logging configurations that you want to return in the response to a ListResolverQueryLogConfigs request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging configurations.

The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).

Contains additional information about the error. If the value or Error is null, the value of ErrorMessage also is null.

If the value of Status is FAILED, the value of Error indicates the cause:

• DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
• ACCESS_DENIED: Permissions don't allow sending logs to the destination.

If the value of Status is a value other than FAILED, Error is null.

The status of the specified query logging association. Valid values include the following:

• CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
• ACTIVE: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
• DELETING: Resolver is deleting this query logging association.
• FAILED: Resolver either couldn't create or couldn't delete the query logging association.

The ID of the Amazon VPC that is associated with the query logging configuration.

The ID of the query logging configuration that a VPC is associated with.

The ID of the query logging association.

A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for Filter.

The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.

The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.

If there are more than MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.

The element that you want Resolver to sort query logging associations by.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.

Valid values include the following elements:

• CreationTime: The ID of the query logging association.

• Error: If the value of Status is FAILED, the value of Error indicates the cause:

  • DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
  • ACCESS_DENIED: Permissions don't allow sending logs to the destination.

  If Status is a value other than FAILED, ERROR is null.

• Id: The ID of the query logging association
• ResolverQueryLogConfigId: The ID of the query logging configuration
• ResourceId: The ID of the VPC that is associated with the query logging configuration

• Status: The current status of the configuration. Valid values include the following:

  • CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
  • CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
  • DELETING: Resolver is deleting this query logging association.

  • FAILED: Resolver either couldn't create or couldn't delete the query logging association. Here are two common causes:

    • The specified destination (for example, an Amazon S3 bucket) was deleted.
    • Permissions don't allow sending logs to the destination.

An optional specification to return a subset of query logging associations.

If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

For the first ListResolverQueryLogConfigAssociations request, omit this value.

If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.

The maximum number of query logging associations that you want to return in the response to a ListResolverQueryLogConfigAssociations request. If you don't specify a value for MaxResults, Resolver returns up to 100 query logging associations.

The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

The value that you specified for MaxResults in the request.

If more than MaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.

If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.

For the first ListResolverEndpoints request, omit this value.

If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.

The maximum number of Resolver endpoints that you want to return in the response to a ListResolverEndpoints request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints.

The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).

The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).

A message that provides additional information about the status of the request.

A status code that gives the current status of the request.

One IPv6 address that the Resolver endpoint uses for DNS queries.

One IPv4 address that the Resolver endpoint uses for DNS queries.

The ID of one subnet.

The ID of one IP address.

Information about the IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints).

The value that you specified for MaxResults in the request.

If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

For the first ListResolverEndpointIpAddresses request, omit this value.

If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.

The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don't specify a value for MaxResults, Resolver returns up to 100 IP addresses.

The ID of the Resolver endpoint that you want to get IP addresses for.

An array that contains one ResolverDnssecConfig element for each configuration for DNSSEC validation that is associated with the current Amazon Web Services account. It doesn't contain disabled DNSSEC configurations for the resource.

If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the response.

If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverDnssecConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

An optional specification to return a subset of objects.

(Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverDnssecConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 100 configuration per page.

An array that contains one ResolverConfigs element for each Resolver configuration that is associated with the current Amazon Web Services account.

If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the response.

If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

(Optional) If the current Amazon Web Services account has more than MaxResults Resolver configurations, use NextToken to get the second and subsequent pages of results.

For the first ListResolverConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

The maximum number of Resolver configurations that you want to return in the response to a ListResolverConfigs request. If you don't specify a value for MaxResults, up to 100 Resolver configurations are returned.

If more than MaxResults Resolvers match the specified criteria, you can submit another ListOutpostResolver request to get the next group of results. In the next request, specify the value of NextToken from the previous response.

The Resolvers on Outposts that were created by using the current Amazon Web Services account, and that match the specified filters, if any.

For the first ListOutpostResolver request, omit this value.

The maximum number of Resolvers on the Outpost that you want to return in the response to a ListOutpostResolver request. If you don't specify a value for MaxResults, the request returns up to 100 Resolvers.

The Amazon Resource Name (ARN) of the Outpost.

For rule types that require an external subscription (today, only the PartnerThreatProtection variant), describes the AWS Marketplace product that backs the rule type. Absent for rule types that are managed by AWS and do not require a separate subscription. See SubscriptionInfo.

A description of the rule type.

The display name of the rule type.

The specific identifier within the rule type category, such as VIOLENCE_AND_HATE_SPEECH or PHISHING.

The category or class of the rule type, such as FirewallAdvancedContentCategory or FirewallAdvancedThreatCategory.

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.

A list of the available rule type definitions.

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

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.

An optional filter that restricts the response to a single FirewallRuleType variant. Supported values: FirewallAdvancedContentCategory, FirewallAdvancedThreatCategory, DnsThreatProtection, and PartnerThreatProtection. If omitted, definitions across all variants are returned.

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.

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.

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.

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.

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.

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.

The unique identifier of the firewall rule group that you want to retrieve the rules for.

Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

The name of the rule group.

The ARN (Amazon Resource Name) of the rule group.

The ID of the rule group.

A list of your firewall rule groups.

This might be a partial list of the rule groups that you have defined. For information, see MaxResults.

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.

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.

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.

A list of your firewall rule group associations.

This might be a partial list of the associations that you have defined. For information, see MaxResults.

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.

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.

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.

The association Status setting that you want DNS Firewall to filter on for the list. If you don't specify this, then DNS Firewall returns all associations, regardless of status.

The setting that determines the processing order of the rule group among the rule groups that are associated with a single VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.

The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC.

The unique identifier of the firewall rule group that you want to retrieve the associations for. Leave this blank to retrieve associations for any rule group.

A list of the domains in the firewall domain list.

This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.

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.

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.

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.

The ID of the domain list whose domains you want to retrieve.

The category of the domain list.

The type of the managed domain list, for example THREAT.

The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.

A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

The name of the domain list.

The Amazon Resource Name (ARN) of the firewall domain list metadata.

The ID of the domain list.

A list of the domain lists that you have defined.

This might be a partial list of the domain lists that you've defined. For information, see MaxResults.

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.

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.

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.

The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC).

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.

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.

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.

Additional information about the status of the list, if available.

Status of the import request.

The name of the domain list.

The Id of the firewall domain list that DNS Firewall just updated.

The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.

The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.

What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list in the file.

The ID of the domain list that you want to modify with the import operation.

The Resolver rule policy for the rule that you specified in a GetResolverRulePolicy request.

The ID of the Resolver rule that you want to get the Resolver rule policy for.

Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.

The ID of the Resolver rule association that you want to get information about.

Information about the Resolver rule that you specified in a GetResolverRule request.