python-botocore/botocore/data/route53resolver/2018-04-01/service-2.json
2021-11-03 10:14:15 -07:00

4282 lines
218 KiB
JSON

{
"version":"2.0",
"metadata":{
"apiVersion":"2018-04-01",
"endpointPrefix":"route53resolver",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"Route53Resolver",
"serviceFullName":"Amazon Route 53 Resolver",
"serviceId":"Route53Resolver",
"signatureVersion":"v4",
"targetPrefix":"Route53Resolver",
"uid":"route53resolver-2018-04-01"
},
"operations":{
"AssociateFirewallRuleGroup":{
"name":"AssociateFirewallRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateFirewallRuleGroupRequest"},
"output":{"shape":"AssociateFirewallRuleGroupResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ConflictException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Associates a <a>FirewallRuleGroup</a> with a VPC, to provide DNS filtering for the VPC. </p>"
},
"AssociateResolverEndpointIpAddress":{
"name":"AssociateResolverEndpointIpAddress",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateResolverEndpointIpAddressRequest"},
"output":{"shape":"AssociateResolverEndpointIpAddressResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"},
{"shape":"InternalServiceErrorException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one <code>AssociateResolverEndpointIpAddress</code> request for each IP address.</p> <p>To remove an IP address from an endpoint, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverEndpointIpAddress.html\">DisassociateResolverEndpointIpAddress</a>. </p>"
},
"AssociateResolverQueryLogConfig":{
"name":"AssociateResolverQueryLogConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateResolverQueryLogConfigRequest"},
"output":{"shape":"AssociateResolverQueryLogConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Associates an Amazon VPC with a specified query logging configuration. Route 53 Resolver logs DNS queries that originate in all of the Amazon VPCs that are associated with a specified query logging configuration. To associate more than one VPC with a configuration, submit one <code>AssociateResolverQueryLogConfig</code> request for each VPC.</p> <note> <p>The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.</p> </note> <p>To remove a VPC from a query logging configuration, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html\">DisassociateResolverQueryLogConfig</a>. </p>"
},
"AssociateResolverRule":{
"name":"AssociateResolverRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AssociateResolverRuleRequest"},
"output":{"shape":"AssociateResolverRuleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceUnavailableException"},
{"shape":"ResourceExistsException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Associates a Resolver rule with a VPC. When you associate a rule with a VPC, Resolver forwards all DNS queries for the domain name that is specified in the rule and that originate in the VPC. The queries are forwarded to the IP addresses for the DNS resolvers that are specified in the rule. For more information about rules, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html\">CreateResolverRule</a>. </p>"
},
"CreateFirewallDomainList":{
"name":"CreateFirewallDomainList",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateFirewallDomainListRequest"},
"output":{"shape":"CreateFirewallDomainListResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Creates an empty firewall domain list for use in DNS Firewall rules. You can populate the domains for the new list with a file, using <a>ImportFirewallDomains</a>, or with domain strings, using <a>UpdateFirewallDomains</a>. </p>"
},
"CreateFirewallRule":{
"name":"CreateFirewallRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateFirewallRuleRequest"},
"output":{"shape":"CreateFirewallRuleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.</p>"
},
"CreateFirewallRuleGroup":{
"name":"CreateFirewallRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateFirewallRuleGroupRequest"},
"output":{"shape":"CreateFirewallRuleGroupResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC. You can add rules to the new rule group by calling <a>CreateFirewallRule</a>. </p>"
},
"CreateResolverEndpoint":{
"name":"CreateResolverEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateResolverEndpointRequest"},
"output":{"shape":"CreateResolverEndpointResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:</p> <ul> <li> <p>An <i>inbound Resolver endpoint</i> forwards DNS queries to the DNS service for a VPC from your network.</p> </li> <li> <p>An <i>outbound Resolver endpoint</i> forwards DNS queries from the DNS service for a VPC to your network.</p> </li> </ul>"
},
"CreateResolverQueryLogConfig":{
"name":"CreateResolverQueryLogConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateResolverQueryLogConfigRequest"},
"output":{"shape":"CreateResolverQueryLogConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs. Resolver can log queries only for VPCs that are in the same Region as the query logging configuration.</p> <p>To specify which VPCs you want to log queries for, you use <code>AssociateResolverQueryLogConfig</code>. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html\">AssociateResolverQueryLogConfig</a>. </p> <p>You can optionally use Resource Access Manager (RAM) to share a query logging configuration with other Amazon Web Services accounts. The other accounts can then associate VPCs with the configuration. The query logs that Resolver creates for a configuration include all DNS queries that originate in all VPCs that are associated with the configuration.</p>"
},
"CreateResolverRule":{
"name":"CreateResolverRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateResolverRuleRequest"},
"output":{"shape":"CreateResolverRuleResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceUnavailableException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>For DNS queries that originate in your VPCs, specifies which Resolver endpoint the queries pass through, one domain name that you want to forward to your network, and the IP addresses of the DNS resolvers in your network.</p>"
},
"DeleteFirewallDomainList":{
"name":"DeleteFirewallDomainList",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFirewallDomainListRequest"},
"output":{"shape":"DeleteFirewallDomainListResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes the specified domain list. </p>"
},
"DeleteFirewallRule":{
"name":"DeleteFirewallRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFirewallRuleRequest"},
"output":{"shape":"DeleteFirewallRuleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes the specified firewall rule.</p>"
},
"DeleteFirewallRuleGroup":{
"name":"DeleteFirewallRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteFirewallRuleGroupRequest"},
"output":{"shape":"DeleteFirewallRuleGroupResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes the specified firewall rule group. </p>"
},
"DeleteResolverEndpoint":{
"name":"DeleteResolverEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResolverEndpointRequest"},
"output":{"shape":"DeleteResolverEndpointResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it's an inbound or an outbound Resolver endpoint:</p> <ul> <li> <p> <b>Inbound</b>: DNS queries from your network are no longer routed to the DNS service for the specified VPC.</p> </li> <li> <p> <b>Outbound</b>: DNS queries from a VPC are no longer routed to your network.</p> </li> </ul>"
},
"DeleteResolverQueryLogConfig":{
"name":"DeleteResolverQueryLogConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResolverQueryLogConfigRequest"},
"output":{"shape":"DeleteResolverQueryLogConfigResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Deletes a query logging configuration. When you delete a configuration, Resolver stops logging DNS queries for all of the Amazon VPCs that are associated with the configuration. This also applies if the query logging configuration is shared with other Amazon Web Services accounts, and the other accounts have associated VPCs with the shared configuration.</p> <p>Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html\">DisassociateResolverQueryLogConfig</a>.</p> <p>If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, you must stop sharing the configuration before you can delete a configuration. The accounts that you shared the configuration with can first disassociate VPCs that they associated with the configuration, but that's not necessary. If you stop sharing the configuration, those VPCs are automatically disassociated from the configuration.</p>"
},
"DeleteResolverRule":{
"name":"DeleteResolverRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteResolverRuleRequest"},
"output":{"shape":"DeleteResolverRuleResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes a Resolver rule. Before you can delete a Resolver rule, you must disassociate it from all the VPCs that you associated the Resolver rule with. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html\">DisassociateResolverRule</a>.</p>"
},
"DisassociateFirewallRuleGroup":{
"name":"DisassociateFirewallRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateFirewallRuleGroupRequest"},
"output":{"shape":"DisassociateFirewallRuleGroupResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Disassociates a <a>FirewallRuleGroup</a> from a VPC, to remove DNS filtering from the VPC. </p>"
},
"DisassociateResolverEndpointIpAddress":{
"name":"DisassociateResolverEndpointIpAddress",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateResolverEndpointIpAddressRequest"},
"output":{"shape":"DisassociateResolverEndpointIpAddressResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceExistsException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one <code>DisassociateResolverEndpointIpAddress</code> request for each IP address.</p> <p>To add an IP address to an endpoint, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverEndpointIpAddress.html\">AssociateResolverEndpointIpAddress</a>. </p>"
},
"DisassociateResolverQueryLogConfig":{
"name":"DisassociateResolverQueryLogConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateResolverQueryLogConfigRequest"},
"output":{"shape":"DisassociateResolverQueryLogConfigResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Disassociates a VPC from a query logging configuration.</p> <note> <p>Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. If you used Resource Access Manager (RAM) to share a query logging configuration with other accounts, VPCs can be disassociated from the configuration in the following ways:</p> <ul> <li> <p>The accounts that you shared the configuration with can disassociate VPCs from the configuration.</p> </li> <li> <p>You can stop sharing the configuration.</p> </li> </ul> </note>"
},
"DisassociateResolverRule":{
"name":"DisassociateResolverRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DisassociateResolverRuleRequest"},
"output":{"shape":"DisassociateResolverRuleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Removes the association between a specified Resolver rule and a specified VPC.</p> <important> <p>If you disassociate a Resolver rule from a VPC, Resolver stops forwarding DNS queries for the domain name that you specified in the Resolver rule. </p> </important>"
},
"GetFirewallConfig":{
"name":"GetFirewallConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetFirewallConfigRequest"},
"output":{"shape":"GetFirewallConfigResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). </p>"
},
"GetFirewallDomainList":{
"name":"GetFirewallDomainList",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetFirewallDomainListRequest"},
"output":{"shape":"GetFirewallDomainListResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the specified firewall domain list.</p>"
},
"GetFirewallRuleGroup":{
"name":"GetFirewallRuleGroup",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetFirewallRuleGroupRequest"},
"output":{"shape":"GetFirewallRuleGroupResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the specified firewall rule group. </p>"
},
"GetFirewallRuleGroupAssociation":{
"name":"GetFirewallRuleGroupAssociation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetFirewallRuleGroupAssociationRequest"},
"output":{"shape":"GetFirewallRuleGroupAssociationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves a firewall rule group association, which enables DNS filtering for a VPC with one rule group. A VPC can have more than one firewall rule group association, and a rule group can be associated with more than one VPC.</p>"
},
"GetFirewallRuleGroupPolicy":{
"name":"GetFirewallRuleGroupPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetFirewallRuleGroupPolicyRequest"},
"output":{"shape":"GetFirewallRuleGroupPolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Returns the Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM). </p>"
},
"GetResolverConfig":{
"name":"GetResolverConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverConfigRequest"},
"output":{"shape":"GetResolverConfigResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.</p>"
},
"GetResolverDnssecConfig":{
"name":"GetResolverDnssecConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverDnssecConfigRequest"},
"output":{"shape":"GetResolverDnssecConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Gets DNSSEC validation information for a specified resource.</p>"
},
"GetResolverEndpoint":{
"name":"GetResolverEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverEndpointRequest"},
"output":{"shape":"GetResolverEndpointResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Gets information about a specified Resolver endpoint, such as whether it's an inbound or an outbound Resolver endpoint, and the current status of the endpoint.</p>"
},
"GetResolverQueryLogConfig":{
"name":"GetResolverQueryLogConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverQueryLogConfigRequest"},
"output":{"shape":"GetResolverQueryLogConfigResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Gets information about a specified Resolver query logging configuration, such as the number of VPCs that the configuration is logging queries for and the location that logs are sent to. </p>"
},
"GetResolverQueryLogConfigAssociation":{
"name":"GetResolverQueryLogConfigAssociation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverQueryLogConfigAssociationRequest"},
"output":{"shape":"GetResolverQueryLogConfigAssociationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Gets information about a specified association between a Resolver query logging configuration and an Amazon VPC. When you associate a VPC with a query logging configuration, Resolver logs DNS queries that originate in that VPC.</p>"
},
"GetResolverQueryLogConfigPolicy":{
"name":"GetResolverQueryLogConfigPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverQueryLogConfigPolicyRequest"},
"output":{"shape":"GetResolverQueryLogConfigPolicyResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"UnknownResourceException"},
{"shape":"InternalServiceErrorException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Gets information about a query logging policy. A query logging policy specifies the Resolver query logging operations and resources that you want to allow another Amazon Web Services account to be able to use.</p>"
},
"GetResolverRule":{
"name":"GetResolverRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverRuleRequest"},
"output":{"shape":"GetResolverRuleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Gets information about a specified Resolver rule, such as the domain name that the rule forwards DNS queries for and the ID of the outbound Resolver endpoint that the rule is associated with.</p>"
},
"GetResolverRuleAssociation":{
"name":"GetResolverRuleAssociation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverRuleAssociationRequest"},
"output":{"shape":"GetResolverRuleAssociationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html\">AssociateResolverRule</a>. </p>"
},
"GetResolverRulePolicy":{
"name":"GetResolverRulePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetResolverRulePolicyRequest"},
"output":{"shape":"GetResolverRulePolicyResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"UnknownResourceException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Gets information about the Resolver rule policy for a specified rule. A Resolver rule policy includes the rule that you want to share with another account, the account that you want to share the rule with, and the Resolver operations that you want to allow the account to use. </p>"
},
"ImportFirewallDomains":{
"name":"ImportFirewallDomains",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportFirewallDomainsRequest"},
"output":{"shape":"ImportFirewallDomainsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ConflictException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Imports domain names from a file into a domain list, for use in a DNS firewall rule group. </p> <p>Each domain specification in your domain list must satisfy the following requirements: </p> <ul> <li> <p>It can optionally start with <code>*</code> (asterisk).</p> </li> <li> <p>With the exception of the optional starting asterisk, it must only contain the following characters: <code>A-Z</code>, <code>a-z</code>, <code>0-9</code>, <code>-</code> (hyphen).</p> </li> <li> <p>It must be from 1-255 characters in length. </p> </li> </ul>"
},
"ListFirewallConfigs":{
"name":"ListFirewallConfigs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallConfigsRequest"},
"output":{"shape":"ListFirewallConfigsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs. </p> <p>A single call might return only a partial list of the configurations. For information, see <code>MaxResults</code>. </p>"
},
"ListFirewallDomainLists":{
"name":"ListFirewallDomainLists",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallDomainListsRequest"},
"output":{"shape":"ListFirewallDomainListsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the firewall domain lists that you have defined. For each firewall domain list, you can retrieve the domains that are defined for a list by calling <a>ListFirewallDomains</a>. </p> <p>A single call to this list operation might return only a partial list of the domain lists. For information, see <code>MaxResults</code>. </p>"
},
"ListFirewallDomains":{
"name":"ListFirewallDomains",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallDomainsRequest"},
"output":{"shape":"ListFirewallDomainsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the domains that you have defined for the specified firewall domain list. </p> <p>A single call might return only a partial list of the domains. For information, see <code>MaxResults</code>. </p>"
},
"ListFirewallRuleGroupAssociations":{
"name":"ListFirewallRuleGroupAssociations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallRuleGroupAssociationsRequest"},
"output":{"shape":"ListFirewallRuleGroupAssociationsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group. </p> <p>A single call might return only a partial list of the associations. For information, see <code>MaxResults</code>. </p>"
},
"ListFirewallRuleGroups":{
"name":"ListFirewallRuleGroups",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallRuleGroupsRequest"},
"output":{"shape":"ListFirewallRuleGroupsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the minimal high-level information for the rule groups that you have defined. </p> <p>A single call might return only a partial list of the rule groups. For information, see <code>MaxResults</code>. </p>"
},
"ListFirewallRules":{
"name":"ListFirewallRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListFirewallRulesRequest"},
"output":{"shape":"ListFirewallRulesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC. </p> <p>A single call might return only a partial list of the rules. For information, see <code>MaxResults</code>. </p>"
},
"ListResolverConfigs":{
"name":"ListResolverConfigs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverConfigsRequest"},
"output":{"shape":"ListResolverConfigsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.</p>"
},
"ListResolverDnssecConfigs":{
"name":"ListResolverDnssecConfigs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverDnssecConfigsRequest"},
"output":{"shape":"ListResolverDnssecConfigsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.</p>"
},
"ListResolverEndpointIpAddresses":{
"name":"ListResolverEndpointIpAddresses",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverEndpointIpAddressesRequest"},
"output":{"shape":"ListResolverEndpointIpAddressesResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Gets the IP addresses for a specified Resolver endpoint.</p>"
},
"ListResolverEndpoints":{
"name":"ListResolverEndpoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverEndpointsRequest"},
"output":{"shape":"ListResolverEndpointsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Lists all the Resolver endpoints that were created using the current Amazon Web Services account.</p>"
},
"ListResolverQueryLogConfigAssociations":{
"name":"ListResolverQueryLogConfigAssociations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverQueryLogConfigAssociationsRequest"},
"output":{"shape":"ListResolverQueryLogConfigAssociationsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists information about associations between Amazon VPCs and query logging configurations.</p>"
},
"ListResolverQueryLogConfigs":{
"name":"ListResolverQueryLogConfigs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverQueryLogConfigsRequest"},
"output":{"shape":"ListResolverQueryLogConfigsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Lists information about the specified query logging configurations. Each configuration defines where you want Resolver to save DNS query logs and specifies the VPCs that you want to log queries for.</p>"
},
"ListResolverRuleAssociations":{
"name":"ListResolverRuleAssociations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverRuleAssociationsRequest"},
"output":{"shape":"ListResolverRuleAssociationsResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.</p>"
},
"ListResolverRules":{
"name":"ListResolverRules",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListResolverRulesRequest"},
"output":{"shape":"ListResolverRulesResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Lists the Resolver rules that were created using the current Amazon Web Services account.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Lists the tags that you associated with the specified resource.</p>"
},
"PutFirewallRuleGroupPolicy":{
"name":"PutFirewallRuleGroupPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutFirewallRuleGroupPolicyRequest"},
"output":{"shape":"PutFirewallRuleGroupPolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Attaches an Identity and Access Management (Amazon Web Services IAM) policy for sharing the rule group. You can use the policy to share the rule group using Resource Access Manager (RAM). </p>"
},
"PutResolverQueryLogConfigPolicy":{
"name":"PutResolverQueryLogConfigPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutResolverQueryLogConfigPolicyRequest"},
"output":{"shape":"PutResolverQueryLogConfigPolicyResponse"},
"errors":[
{"shape":"InvalidPolicyDocument"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"UnknownResourceException"},
{"shape":"InternalServiceErrorException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Specifies an Amazon Web Services account that you want to share a query logging configuration with, the query logging configuration that you want to share, and the operations that you want the account to be able to perform on the configuration.</p>"
},
"PutResolverRulePolicy":{
"name":"PutResolverRulePolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutResolverRulePolicyRequest"},
"output":{"shape":"PutResolverRulePolicyResponse"},
"errors":[
{"shape":"InvalidPolicyDocument"},
{"shape":"InvalidParameterException"},
{"shape":"UnknownResourceException"},
{"shape":"InternalServiceErrorException"}
],
"documentation":"<p>Specifies an Amazon Web Services rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidTagException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Adds one or more tags to a specified resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Removes one or more tags from a specified resource.</p>"
},
"UpdateFirewallConfig":{
"name":"UpdateFirewallConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallConfigRequest"},
"output":{"shape":"UpdateFirewallConfigResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). </p>"
},
"UpdateFirewallDomains":{
"name":"UpdateFirewallDomains",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallDomainsRequest"},
"output":{"shape":"UpdateFirewallDomainsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"ConflictException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates the firewall domain list from an array of domain specifications. </p>"
},
"UpdateFirewallRule":{
"name":"UpdateFirewallRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallRuleRequest"},
"output":{"shape":"UpdateFirewallRuleResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates the specified firewall rule. </p>"
},
"UpdateFirewallRuleGroupAssociation":{
"name":"UpdateFirewallRuleGroupAssociation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateFirewallRuleGroupAssociationRequest"},
"output":{"shape":"UpdateFirewallRuleGroupAssociationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"},
{"shape":"AccessDeniedException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Changes the association of a <a>FirewallRuleGroup</a> with a VPC. The association enables DNS filtering for the VPC. </p>"
},
"UpdateResolverConfig":{
"name":"UpdateResolverConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateResolverConfigRequest"},
"output":{"shape":"UpdateResolverConfigResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceUnavailableException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.</p>"
},
"UpdateResolverDnssecConfig":{
"name":"UpdateResolverDnssecConfig",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateResolverDnssecConfigRequest"},
"output":{"shape":"UpdateResolverDnssecConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.</p>"
},
"UpdateResolverEndpoint":{
"name":"UpdateResolverEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateResolverEndpointRequest"},
"output":{"shape":"UpdateResolverEndpointResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates the name of an inbound or an outbound Resolver endpoint. </p>"
},
"UpdateResolverRule":{
"name":"UpdateResolverRule",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateResolverRuleRequest"},
"output":{"shape":"UpdateResolverRuleResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceUnavailableException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServiceErrorException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates settings for a specified Resolver rule. <code>ResolverRuleId</code> is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The current account doesn't have the IAM permissions required to perform the specified Resolver operation.</p>",
"exception":true
},
"AccountId":{
"type":"string",
"max":32,
"min":12
},
"Action":{
"type":"string",
"enum":[
"ALLOW",
"BLOCK",
"ALERT"
]
},
"Arn":{
"type":"string",
"max":255,
"min":1
},
"AssociateFirewallRuleGroupRequest":{
"type":"structure",
"required":[
"CreatorRequestId",
"FirewallRuleGroupId",
"VpcId",
"Priority",
"Name"
],
"members":{
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>",
"idempotencyToken":true
},
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group. </p>"
},
"VpcId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the VPC that you want to associate with the rule group. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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. </p> <p>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 101, 200, and so on. You can change the priority setting for a rule group association after you create it.</p> <p>The allowed values for <code>Priority</code> are between 100 and 9900.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>A name that lets you identify the association, to manage and use it.</p>"
},
"MutationProtection":{
"shape":"MutationProtectionStatus",
"documentation":"<p>If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. When you create the association, the default setting is <code>DISABLED</code>. </p>",
"box":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tag keys and values that you want to associate with the rule group association. </p>",
"box":true
}
}
},
"AssociateFirewallRuleGroupResponse":{
"type":"structure",
"members":{
"FirewallRuleGroupAssociation":{
"shape":"FirewallRuleGroupAssociation",
"documentation":"<p>The association that you just created. The association has an ID that you can use to identify it in other requests, like update and delete.</p>"
}
}
},
"AssociateResolverEndpointIpAddressRequest":{
"type":"structure",
"required":[
"ResolverEndpointId",
"IpAddress"
],
"members":{
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint that you want to associate IP addresses with.</p>"
},
"IpAddress":{
"shape":"IpAddressUpdate",
"documentation":"<p>Either the IPv4 address that you want to add to a Resolver endpoint or a subnet ID. If you specify a subnet ID, Resolver chooses an IP address for you from the available IPs in the specified subnet.</p>"
}
}
},
"AssociateResolverEndpointIpAddressResponse":{
"type":"structure",
"members":{
"ResolverEndpoint":{
"shape":"ResolverEndpoint",
"documentation":"<p>The response to an <code>AssociateResolverEndpointIpAddress</code> request.</p>"
}
}
},
"AssociateResolverQueryLogConfigRequest":{
"type":"structure",
"required":[
"ResolverQueryLogConfigId",
"ResourceId"
],
"members":{
"ResolverQueryLogConfigId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the query logging configuration that you want to associate a VPC with.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of an Amazon VPC that you want this query logging configuration to log queries for.</p> <note> <p>The VPCs and the query logging configuration must be in the same Region.</p> </note>"
}
}
},
"AssociateResolverQueryLogConfigResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfigAssociation":{
"shape":"ResolverQueryLogConfigAssociation",
"documentation":"<p>A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.</p>"
}
}
},
"AssociateResolverRuleRequest":{
"type":"structure",
"required":[
"ResolverRuleId",
"VPCId"
],
"members":{
"ResolverRuleId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule that you want to associate with the VPC. To list the existing Resolver rules, use <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html\">ListResolverRules</a>.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>A name for the association that you're creating between a Resolver rule and a VPC.</p>"
},
"VPCId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC that you want to associate the Resolver rule with.</p>"
}
}
},
"AssociateResolverRuleResponse":{
"type":"structure",
"members":{
"ResolverRuleAssociation":{
"shape":"ResolverRuleAssociation",
"documentation":"<p>Information about the <code>AssociateResolverRule</code> request, including the status of the request.</p>"
}
}
},
"AutodefinedReverseFlag":{
"type":"string",
"enum":[
"ENABLE",
"DISABLE"
]
},
"BlockOverrideDnsType":{
"type":"string",
"enum":["CNAME"]
},
"BlockOverrideDomain":{
"type":"string",
"max":255,
"min":1
},
"BlockOverrideTtl":{
"type":"integer",
"max":604800,
"min":0
},
"BlockResponse":{
"type":"string",
"enum":[
"NODATA",
"NXDOMAIN",
"OVERRIDE"
]
},
"Boolean":{"type":"boolean"},
"ConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
},
"Count":{"type":"integer"},
"CreateFirewallDomainListRequest":{
"type":"structure",
"required":[
"CreatorRequestId",
"Name"
],
"members":{
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>",
"idempotencyToken":true
},
"Name":{
"shape":"Name",
"documentation":"<p>A name that lets you identify the domain list to manage and use it.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tag keys and values that you want to associate with the domain list. </p>",
"box":true
}
}
},
"CreateFirewallDomainListResponse":{
"type":"structure",
"members":{
"FirewallDomainList":{
"shape":"FirewallDomainList",
"documentation":"<p>The domain list that you just created.</p>"
}
}
},
"CreateFirewallRuleGroupRequest":{
"type":"structure",
"required":[
"CreatorRequestId",
"Name"
],
"members":{
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>",
"idempotencyToken":true
},
"Name":{
"shape":"Name",
"documentation":"<p>A name that lets you identify the rule group, to manage and use it.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tag keys and values that you want to associate with the rule group. </p>",
"box":true
}
}
},
"CreateFirewallRuleGroupResponse":{
"type":"structure",
"members":{
"FirewallRuleGroup":{
"shape":"FirewallRuleGroup",
"documentation":"<p>A collection of rules used to filter DNS network traffic. </p>"
}
}
},
"CreateFirewallRuleRequest":{
"type":"structure",
"required":[
"CreatorRequestId",
"FirewallRuleGroupId",
"FirewallDomainListId",
"Priority",
"Action",
"Name"
],
"members":{
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>",
"idempotencyToken":true
},
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group where you want to create the rule. </p>"
},
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list that you want to use in the rule. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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.</p> <p>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.</p>"
},
"Action":{
"shape":"Action",
"documentation":"<p>The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:</p> <ul> <li> <p> <code>ALLOW</code> - Permit the request to go through.</p> </li> <li> <p> <code>ALERT</code> - Permit the request and send metrics and logs to Cloud Watch.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. This option requires additional details in the rule's <code>BlockResponse</code>. </p> </li> </ul>"
},
"BlockResponse":{
"shape":"BlockResponse",
"documentation":"<p>The way that you want DNS Firewall to block the request, used with the rule action setting <code>BLOCK</code>. </p> <ul> <li> <p> <code>NODATA</code> - Respond indicating that the query was successful, but no response is available for it.</p> </li> <li> <p> <code>NXDOMAIN</code> - Respond indicating that the domain name that's in the query doesn't exist.</p> </li> <li> <p> <code>OVERRIDE</code> - Provide a custom override in the response. This option requires custom handling details in the rule's <code>BlockOverride*</code> settings. </p> </li> </ul> <p>This setting is required if the rule action setting is <code>BLOCK</code>.</p>",
"box":true
},
"BlockOverrideDomain":{
"shape":"BlockOverrideDomain",
"documentation":"<p>The custom DNS record to send back in response to the query. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p> <p>This setting is required if the <code>BlockResponse</code> setting is <code>OVERRIDE</code>.</p>",
"box":true
},
"BlockOverrideDnsType":{
"shape":"BlockOverrideDnsType",
"documentation":"<p>The DNS record's type. This determines the format of the record value that you provided in <code>BlockOverrideDomain</code>. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p> <p>This setting is required if the <code>BlockResponse</code> setting is <code>OVERRIDE</code>.</p>",
"box":true
},
"BlockOverrideTtl":{
"shape":"BlockOverrideTtl",
"documentation":"<p>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 <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p> <p>This setting is required if the <code>BlockResponse</code> setting is <code>OVERRIDE</code>.</p>",
"box":true
},
"Name":{
"shape":"Name",
"documentation":"<p>A name that lets you identify the rule in the rule group.</p>"
}
}
},
"CreateFirewallRuleResponse":{
"type":"structure",
"members":{
"FirewallRule":{
"shape":"FirewallRule",
"documentation":"<p>The firewall rule that you just created. </p>"
}
}
},
"CreateResolverEndpointRequest":{
"type":"structure",
"required":[
"CreatorRequestId",
"SecurityGroupIds",
"Direction",
"IpAddresses"
],
"members":{
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p>The ID of one or more security groups that you want to use to control access to this VPC. The security group that you specify must include one or more inbound rules (for inbound Resolver endpoints) or outbound rules (for outbound Resolver 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.</p>",
"box":true
},
"Direction":{
"shape":"ResolverEndpointDirection",
"documentation":"<p>Specify the applicable value:</p> <ul> <li> <p> <code>INBOUND</code>: Resolver forwards DNS queries to the DNS service for a VPC from your network</p> </li> <li> <p> <code>OUTBOUND</code>: Resolver forwards DNS queries from the DNS service for a VPC to your network</p> </li> </ul>"
},
"IpAddresses":{
"shape":"IpAddressesRequest",
"documentation":"<p>The subnets and IP addresses in your VPC that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). The subnet ID uniquely identifies a VPC. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tag keys and values that you want to associate with the endpoint.</p>",
"box":true
}
}
},
"CreateResolverEndpointResponse":{
"type":"structure",
"members":{
"ResolverEndpoint":{
"shape":"ResolverEndpoint",
"documentation":"<p>Information about the <code>CreateResolverEndpoint</code> request, including the status of the request.</p>"
}
}
},
"CreateResolverQueryLogConfigRequest":{
"type":"structure",
"required":[
"Name",
"DestinationArn",
"CreatorRequestId"
],
"members":{
"Name":{
"shape":"ResolverQueryLogConfigName",
"documentation":"<p>The name that you want to give the query logging configuration.</p>"
},
"DestinationArn":{
"shape":"DestinationArn",
"documentation":"<p>The ARN of the resource that you want Resolver to send query logs. You can send query logs to an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream. Examples of valid values include the following:</p> <ul> <li> <p> <b>S3 bucket</b>: </p> <p> <code>arn:aws:s3:::examplebucket</code> </p> <p>You can optionally append a file prefix to the end of the ARN.</p> <p> <code>arn:aws:s3:::examplebucket/development/</code> </p> </li> <li> <p> <b>CloudWatch Logs log group</b>: </p> <p> <code>arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*</code> </p> </li> <li> <p> <b>Kinesis Data Firehose delivery stream</b>:</p> <p> <code>arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name</code> </p> </li> </ul>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tag keys and values that you want to associate with the query logging configuration.</p>",
"box":true
}
}
},
"CreateResolverQueryLogConfigResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfig":{
"shape":"ResolverQueryLogConfig",
"documentation":"<p>Information about the <code>CreateResolverQueryLogConfig</code> request, including the status of the request.</p>"
}
}
},
"CreateResolverRuleRequest":{
"type":"structure",
"required":[
"CreatorRequestId",
"RuleType",
"DomainName"
],
"members":{
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp. </p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.</p>"
},
"RuleType":{
"shape":"RuleTypeOption",
"documentation":"<p>When you want to forward DNS queries for specified domain name to resolvers on your network, specify <code>FORWARD</code>.</p> <p>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 <code>SYSTEM</code>.</p> <p>For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify <code>FORWARD</code> for <code>RuleType</code>. To then have Resolver process queries for apex.example.com, you create a rule and specify <code>SYSTEM</code> for <code>RuleType</code>.</p> <p>Currently, only Resolver can create rules that have a value of <code>RECURSIVE</code> for <code>RuleType</code>.</p>"
},
"DomainName":{
"shape":"DomainName",
"documentation":"<p>DNS queries for this domain name are forwarded to the IP addresses that you specify in <code>TargetIps</code>. 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).</p>"
},
"TargetIps":{
"shape":"TargetList",
"documentation":"<p>The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a space.</p> <p> <code>TargetIps</code> is available only when the value of <code>Rule type</code> is <code>FORWARD</code>.</p>",
"box":true
},
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the outbound Resolver endpoint that you want to use to route DNS queries to the IP addresses that you specify in <code>TargetIps</code>.</p>",
"box":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tag keys and values that you want to associate with the endpoint.</p>",
"box":true
}
}
},
"CreateResolverRuleResponse":{
"type":"structure",
"members":{
"ResolverRule":{
"shape":"ResolverRule",
"documentation":"<p>Information about the <code>CreateResolverRule</code> request, including the status of the request.</p>"
}
}
},
"CreatorRequestId":{
"type":"string",
"max":255,
"min":1
},
"DeleteFirewallDomainListRequest":{
"type":"structure",
"required":["FirewallDomainListId"],
"members":{
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list that you want to delete. </p>"
}
}
},
"DeleteFirewallDomainListResponse":{
"type":"structure",
"members":{
"FirewallDomainList":{
"shape":"FirewallDomainList",
"documentation":"<p>The domain list that you just deleted. </p>"
}
}
},
"DeleteFirewallRuleGroupRequest":{
"type":"structure",
"required":["FirewallRuleGroupId"],
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group that you want to delete. </p>"
}
}
},
"DeleteFirewallRuleGroupResponse":{
"type":"structure",
"members":{
"FirewallRuleGroup":{
"shape":"FirewallRuleGroup",
"documentation":"<p>A collection of rules used to filter DNS network traffic. </p>"
}
}
},
"DeleteFirewallRuleRequest":{
"type":"structure",
"required":[
"FirewallRuleGroupId",
"FirewallDomainListId"
],
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group that you want to delete the rule from. </p>"
},
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list that's used in the rule. </p>"
}
}
},
"DeleteFirewallRuleResponse":{
"type":"structure",
"members":{
"FirewallRule":{
"shape":"FirewallRule",
"documentation":"<p>The specification for the firewall rule that you just deleted.</p>"
}
}
},
"DeleteResolverEndpointRequest":{
"type":"structure",
"required":["ResolverEndpointId"],
"members":{
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint that you want to delete.</p>"
}
}
},
"DeleteResolverEndpointResponse":{
"type":"structure",
"members":{
"ResolverEndpoint":{
"shape":"ResolverEndpoint",
"documentation":"<p>Information about the <code>DeleteResolverEndpoint</code> request, including the status of the request.</p>"
}
}
},
"DeleteResolverQueryLogConfigRequest":{
"type":"structure",
"required":["ResolverQueryLogConfigId"],
"members":{
"ResolverQueryLogConfigId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the query logging configuration that you want to delete.</p>"
}
}
},
"DeleteResolverQueryLogConfigResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfig":{
"shape":"ResolverQueryLogConfig",
"documentation":"<p>Information about the query logging configuration that you deleted, including the status of the request.</p>"
}
}
},
"DeleteResolverRuleRequest":{
"type":"structure",
"required":["ResolverRuleId"],
"members":{
"ResolverRuleId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule that you want to delete.</p>"
}
}
},
"DeleteResolverRuleResponse":{
"type":"structure",
"members":{
"ResolverRule":{
"shape":"ResolverRule",
"documentation":"<p>Information about the <code>DeleteResolverRule</code> request, including the status of the request.</p>"
}
}
},
"DestinationArn":{
"type":"string",
"max":600,
"min":1
},
"DisassociateFirewallRuleGroupRequest":{
"type":"structure",
"required":["FirewallRuleGroupAssociationId"],
"members":{
"FirewallRuleGroupAssociationId":{
"shape":"ResourceId",
"documentation":"<p>The identifier of the <a>FirewallRuleGroupAssociation</a>. </p>"
}
}
},
"DisassociateFirewallRuleGroupResponse":{
"type":"structure",
"members":{
"FirewallRuleGroupAssociation":{
"shape":"FirewallRuleGroupAssociation",
"documentation":"<p>The firewall rule group association that you just removed. </p>"
}
}
},
"DisassociateResolverEndpointIpAddressRequest":{
"type":"structure",
"required":[
"ResolverEndpointId",
"IpAddress"
],
"members":{
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint that you want to disassociate an IP address from.</p>"
},
"IpAddress":{
"shape":"IpAddressUpdate",
"documentation":"<p>The IPv4 address that you want to remove from a Resolver endpoint.</p>"
}
}
},
"DisassociateResolverEndpointIpAddressResponse":{
"type":"structure",
"members":{
"ResolverEndpoint":{
"shape":"ResolverEndpoint",
"documentation":"<p>The response to an <code>DisassociateResolverEndpointIpAddress</code> request.</p>"
}
}
},
"DisassociateResolverQueryLogConfigRequest":{
"type":"structure",
"required":[
"ResolverQueryLogConfigId",
"ResourceId"
],
"members":{
"ResolverQueryLogConfigId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the query logging configuration that you want to disassociate a specified VPC from.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.</p>"
}
}
},
"DisassociateResolverQueryLogConfigResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfigAssociation":{
"shape":"ResolverQueryLogConfigAssociation",
"documentation":"<p>A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.</p>"
}
}
},
"DisassociateResolverRuleRequest":{
"type":"structure",
"required":[
"VPCId",
"ResolverRuleId"
],
"members":{
"VPCId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC that you want to disassociate the Resolver rule from.</p>"
},
"ResolverRuleId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule that you want to disassociate from the specified VPC.</p>"
}
}
},
"DisassociateResolverRuleResponse":{
"type":"structure",
"members":{
"ResolverRuleAssociation":{
"shape":"ResolverRuleAssociation",
"documentation":"<p>Information about the <code>DisassociateResolverRule</code> request, including the status of the request.</p>"
}
}
},
"DomainListFileUrl":{
"type":"string",
"max":1024,
"min":1
},
"DomainName":{
"type":"string",
"max":256,
"min":1
},
"ExceptionMessage":{"type":"string"},
"Filter":{
"type":"structure",
"members":{
"Name":{
"shape":"FilterName",
"documentation":"<p>The name of the parameter that you want to use to filter objects.</p> <p>The valid values for <code>Name</code> depend on the action that you're including the filter in, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html\">ListResolverEndpoints</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html\">ListResolverRules</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html\">ListResolverRuleAssociations</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html\">ListResolverQueryLogConfigs</a>, or <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html\">ListResolverQueryLogConfigAssociations</a>.</p> <note> <p>In early versions of Resolver, values for <code>Name</code> were listed as uppercase, with underscore (_) delimiters. For example, <code>CreatorRequestId</code> was originally listed as <code>CREATOR_REQUEST_ID</code>. Uppercase values for <code>Name</code> are still supported.</p> </note> <p> <b>ListResolverEndpoints</b> </p> <p>Valid values for <code>Name</code> include the following:</p> <ul> <li> <p> <code>CreatorRequestId</code>: The value that you specified when you created the Resolver endpoint.</p> </li> <li> <p> <code>Direction</code>: Whether you want to return inbound or outbound Resolver endpoints. If you specify <code>DIRECTION</code> for <code>Name</code>, specify <code>INBOUND</code> or <code>OUTBOUND</code> for <code>Values</code>.</p> </li> <li> <p> <code>HostVPCId</code>: 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 <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html\">CreateResolverEndpoint</a> request, <code>SubnetId</code> indirectly identifies the VPC. In a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a> request, the VPC ID for a Resolver endpoint is returned in the <code>HostVPCId</code> element. </p> </li> <li> <p> <code>IpAddressCount</code>: The number of IP addresses that you have associated with the Resolver endpoint.</p> </li> <li> <p> <code>Name</code>: The name of the Resolver endpoint.</p> </li> <li> <p> <code>SecurityGroupIds</code>: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.</p> </li> <li> <p> <code>Status</code>: The status of the Resolver endpoint. If you specify <code>Status</code> for <code>Name</code>, specify one of the following status codes for <code>Values</code>: <code>CREATING</code>, <code>OPERATIONAL</code>, <code>UPDATING</code>, <code>AUTO_RECOVERING</code>, <code>ACTION_NEEDED</code>, or <code>DELETING</code>. For more information, see <code>Status</code> in <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverEndpoint.html\">ResolverEndpoint</a>.</p> </li> </ul> <p> <b>ListResolverRules</b> </p> <p>Valid values for <code>Name</code> include the following:</p> <ul> <li> <p> <code>CreatorRequestId</code>: The value that you specified when you created the Resolver rule.</p> </li> <li> <p> <code>DomainName</code>: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify for <code>Values</code>, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the \".\" after <code>com</code>:</p> <p> <code>example.com.</code> </p> </li> <li> <p> <code>Name</code>: The name of the Resolver rule.</p> </li> <li> <p> <code>ResolverEndpointId</code>: The ID of the Resolver endpoint that the Resolver rule is associated with.</p> <note> <p>You can filter on the Resolver endpoint only for rules that have a value of <code>FORWARD</code> for <code>RuleType</code>.</p> </note> </li> <li> <p> <code>Status</code>: The status of the Resolver rule. If you specify <code>Status</code> for <code>Name</code>, specify one of the following status codes for <code>Values</code>: <code>COMPLETE</code>, <code>DELETING</code>, <code>UPDATING</code>, or <code>FAILED</code>.</p> </li> <li> <p> <code>Type</code>: The type of the Resolver rule. If you specify <code>TYPE</code> for <code>Name</code>, specify <code>FORWARD</code> or <code>SYSTEM</code> for <code>Values</code>.</p> </li> </ul> <p> <b>ListResolverRuleAssociations</b> </p> <p>Valid values for <code>Name</code> include the following:</p> <ul> <li> <p> <code>Name</code>: The name of the Resolver rule association.</p> </li> <li> <p> <code>ResolverRuleId</code>: The ID of the Resolver rule that is associated with one or more VPCs.</p> </li> <li> <p> <code>Status</code>: The status of the Resolver rule association. If you specify <code>Status</code> for <code>Name</code>, specify one of the following status codes for <code>Values</code>: <code>CREATING</code>, <code>COMPLETE</code>, <code>DELETING</code>, or <code>FAILED</code>.</p> </li> <li> <p> <code>VPCId</code>: The ID of the VPC that the Resolver rule is associated with.</p> </li> </ul> <p> <b>ListResolverQueryLogConfigs</b> </p> <p>Valid values for <code>Name</code> include the following:</p> <ul> <li> <p> <code>Arn</code>: The ARN for the query logging configuration.</p> </li> <li> <p> <code>AssociationCount</code>: The number of VPCs that are associated with the query logging configuration.</p> </li> <li> <p> <code>CreationTime</code>: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC). </p> </li> <li> <p> <code>CreatorRequestId</code>: A unique string that identifies the request that created the query logging configuration.</p> </li> <li> <p> <code>Destination</code>: The Amazon Web Services service that you want to forward query logs to. Valid values include the following:</p> <ul> <li> <p> <code>S3</code> </p> </li> <li> <p> <code>CloudWatchLogs</code> </p> </li> <li> <p> <code>KinesisFirehose</code> </p> </li> </ul> </li> <li> <p> <code>DestinationArn</code>: 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.</p> </li> <li> <p> <code>Id</code>: The ID of the query logging configuration</p> </li> <li> <p> <code>Name</code>: The name of the query logging configuration</p> </li> <li> <p> <code>OwnerId</code>: The Amazon Web Services account ID for the account that created the query logging configuration.</p> </li> <li> <p> <code>ShareStatus</code>: 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: <code>NOT_SHARED</code>, <code>SHARED_WITH_ME</code>, or <code>SHARED_BY_ME</code>.</p> </li> <li> <p> <code>Status</code>: The status of the query logging configuration. If you specify <code>Status</code> for <code>Name</code>, specify the applicable status code for <code>Values</code>: <code>CREATING</code>, <code>CREATED</code>, <code>DELETING</code>, or <code>FAILED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfig.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfig-Status\">Status</a>. </p> </li> </ul> <p> <b>ListResolverQueryLogConfigAssociations</b> </p> <p>Valid values for <code>Name</code> include the following:</p> <ul> <li> <p> <code>CreationTime</code>: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).</p> </li> <li> <p> <code>Error</code>: If the value of <code>Status</code> is <code>FAILED</code>, specify the cause: <code>DESTINATION_NOT_FOUND</code> or <code>ACCESS_DENIED</code>.</p> </li> <li> <p> <code>Id</code>: The ID of the query logging association.</p> </li> <li> <p> <code>ResolverQueryLogConfigId</code>: The ID of the query logging configuration that a VPC is associated with.</p> </li> <li> <p> <code>ResourceId</code>: The ID of the Amazon VPC that is associated with the query logging configuration.</p> </li> <li> <p> <code>Status</code>: The status of the query logging association. If you specify <code>Status</code> for <code>Name</code>, specify the applicable status code for <code>Values</code>: <code>CREATING</code>, <code>CREATED</code>, <code>DELETING</code>, or <code>FAILED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ResolverQueryLogConfigAssociation.html#Route53Resolver-Type-route53resolver_ResolverQueryLogConfigAssociation-Status\">Status</a>. </p> </li> </ul>"
},
"Values":{
"shape":"FilterValues",
"documentation":"<p>When you're using a <code>List</code> 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 <code>Direction</code> for <code>Name</code> and specify <code>INBOUND</code> for <code>Values</code>.</p>"
}
},
"documentation":"<p>For Resolver list operations (<a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html\">ListResolverEndpoints</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html\">ListResolverRules</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html\">ListResolverRuleAssociations</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html\">ListResolverQueryLogConfigs</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html\">ListResolverQueryLogConfigAssociations</a>), and <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverDnssecConfigs.html\">ListResolverDnssecConfigs</a>), an optional specification to return a subset of objects.</p> <p>To filter objects, such as Resolver endpoints or Resolver rules, you specify <code>Name</code> and <code>Values</code>. For example, to list only inbound Resolver endpoints, specify <code>Direction</code> for <code>Name</code> and specify <code>INBOUND</code> for <code>Values</code>. </p>"
},
"FilterName":{
"type":"string",
"max":64,
"min":1
},
"FilterValue":{
"type":"string",
"max":600,
"min":1
},
"FilterValues":{
"type":"list",
"member":{"shape":"FilterValue"}
},
"Filters":{
"type":"list",
"member":{"shape":"Filter"}
},
"FirewallConfig":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the firewall configuration.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC that this firewall configuration applies to.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.</p>"
},
"FirewallFailOpen":{
"shape":"FirewallFailOpenStatus",
"documentation":"<p>Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply. </p> <ul> <li> <p>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. </p> </li> <li> <p>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. </p> </li> </ul> <p>This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association. </p>"
}
},
"documentation":"<p>Configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). </p>"
},
"FirewallConfigList":{
"type":"list",
"member":{"shape":"FirewallConfig"}
},
"FirewallDomainImportOperation":{
"type":"string",
"enum":["REPLACE"]
},
"FirewallDomainList":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list. </p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall domain list.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the domain list. </p>"
},
"DomainCount":{
"shape":"Unsigned",
"documentation":"<p>The number of domain names that are specified in the domain list.</p>"
},
"Status":{
"shape":"FirewallDomainListStatus",
"documentation":"<p>The status of the domain list. </p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>Additional information about the status of the list, if available.</p>"
},
"ManagedOwnerName":{
"shape":"ServicePrinciple",
"documentation":"<p>The owner of the list, used only for lists that are not managed by you. For example, the managed domain list <code>AWSManagedDomainsMalwareDomainList</code> has the managed owner name <code>Route 53 Resolver DNS Firewall</code>.</p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC). </p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC). </p>"
}
},
"documentation":"<p>High-level information about a list of firewall domains for use in a <a>FirewallRule</a>. This is returned by <a>GetFirewallDomainList</a>.</p> <p>To retrieve the domains that are defined for this domain list, call <a>ListFirewallDomains</a>.</p>"
},
"FirewallDomainListMetadata":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list. </p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall domain list metadata.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the domain list. </p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>"
},
"ManagedOwnerName":{
"shape":"ServicePrinciple",
"documentation":"<p>The owner of the list, used only for lists that are not managed by you. For example, the managed domain list <code>AWSManagedDomainsMalwareDomainList</code> has the managed owner name <code>Route 53 Resolver DNS Firewall</code>.</p>"
}
},
"documentation":"<p>Minimal high-level information for a firewall domain list. The action <a>ListFirewallDomainLists</a> returns an array of these objects. </p> <p>To retrieve full information for a firewall domain list, call <a>GetFirewallDomainList</a> and <a>ListFirewallDomains</a>.</p>"
},
"FirewallDomainListMetadataList":{
"type":"list",
"member":{"shape":"FirewallDomainListMetadata"}
},
"FirewallDomainListStatus":{
"type":"string",
"enum":[
"COMPLETE",
"COMPLETE_IMPORT_FAILED",
"IMPORTING",
"DELETING",
"UPDATING"
]
},
"FirewallDomainName":{
"type":"string",
"max":255,
"min":1
},
"FirewallDomainUpdateOperation":{
"type":"string",
"enum":[
"ADD",
"REMOVE",
"REPLACE"
]
},
"FirewallDomains":{
"type":"list",
"member":{"shape":"FirewallDomainName"}
},
"FirewallFailOpenStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"FirewallRule":{
"type":"structure",
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group of the rule. </p>"
},
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list that's used in the rule. </p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the rule. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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.</p>"
},
"Action":{
"shape":"Action",
"documentation":"<p>The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:</p> <ul> <li> <p> <code>ALLOW</code> - Permit the request to go through.</p> </li> <li> <p> <code>ALERT</code> - Permit the request to go through but send an alert to the logs.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. If this is specified, additional handling details are provided in the rule's <code>BlockResponse</code> setting. </p> </li> </ul>"
},
"BlockResponse":{
"shape":"BlockResponse",
"documentation":"<p>The way that you want DNS Firewall to block the request. Used for the rule action setting <code>BLOCK</code>.</p> <ul> <li> <p> <code>NODATA</code> - Respond indicating that the query was successful, but no response is available for it.</p> </li> <li> <p> <code>NXDOMAIN</code> - Respond indicating that the domain name that's in the query doesn't exist.</p> </li> <li> <p> <code>OVERRIDE</code> - Provide a custom override in the response. This option requires custom handling details in the rule's <code>BlockOverride*</code> settings. </p> </li> </ul>"
},
"BlockOverrideDomain":{
"shape":"BlockOverrideDomain",
"documentation":"<p>The custom DNS record to send back in response to the query. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>"
},
"BlockOverrideDnsType":{
"shape":"BlockOverrideDnsType",
"documentation":"<p>The DNS record's type. This determines the format of the record value that you provided in <code>BlockOverrideDomain</code>. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>"
},
"BlockOverrideTtl":{
"shape":"Unsigned",
"documentation":"<p>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 <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC). </p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>A single firewall rule in a rule group.</p>"
},
"FirewallRuleGroup":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the rule group. </p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN (Amazon Resource Name) of the rule group.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the rule group.</p>"
},
"RuleCount":{
"shape":"Unsigned",
"documentation":"<p>The number of rules in the rule group.</p>"
},
"Status":{
"shape":"FirewallRuleGroupStatus",
"documentation":"<p>The status of the domain list. </p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>Additional information about the status of the rule group, if available.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>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. </p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>"
},
"ShareStatus":{
"shape":"ShareStatus",
"documentation":"<p>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).</p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC). </p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>High-level information for a firewall rule group. A firewall rule group is a collection of rules that DNS Firewall uses to filter DNS network traffic for a VPC. To retrieve the rules for the rule group, call <a>ListFirewallRules</a>.</p>"
},
"FirewallRuleGroupAssociation":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The identifier for the association.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the firewall rule group association.</p>"
},
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group. </p>"
},
"VpcId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the VPC that is associated with the rule group. </p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the association.</p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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. </p>"
},
"MutationProtection":{
"shape":"MutationProtectionStatus",
"documentation":"<p>If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. </p>"
},
"ManagedOwnerName":{
"shape":"ServicePrinciple",
"documentation":"<p>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.</p>"
},
"Status":{
"shape":"FirewallRuleGroupAssociationStatus",
"documentation":"<p>The current status of the association.</p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>Additional information about the status of the response, if available.</p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC). </p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>An association between a firewall rule group and a VPC, which enables DNS filtering for the VPC. </p>"
},
"FirewallRuleGroupAssociationStatus":{
"type":"string",
"enum":[
"COMPLETE",
"DELETING",
"UPDATING"
]
},
"FirewallRuleGroupAssociations":{
"type":"list",
"member":{"shape":"FirewallRuleGroupAssociation"}
},
"FirewallRuleGroupMetadata":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the rule group. </p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN (Amazon Resource Name) of the rule group.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the rule group.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>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. </p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>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. </p>"
},
"ShareStatus":{
"shape":"ShareStatus",
"documentation":"<p>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).</p>"
}
},
"documentation":"<p>Minimal high-level information for a firewall rule group. The action <a>ListFirewallRuleGroups</a> returns an array of these objects. </p> <p>To retrieve full information for a firewall rule group, call <a>GetFirewallRuleGroup</a> and <a>ListFirewallRules</a>.</p>"
},
"FirewallRuleGroupMetadataList":{
"type":"list",
"member":{"shape":"FirewallRuleGroupMetadata"}
},
"FirewallRuleGroupPolicy":{
"type":"string",
"max":30000
},
"FirewallRuleGroupStatus":{
"type":"string",
"enum":[
"COMPLETE",
"DELETING",
"UPDATING"
]
},
"FirewallRules":{
"type":"list",
"member":{"shape":"FirewallRule"}
},
"GetFirewallConfigRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC from Amazon VPC that the configuration is for.</p>"
}
}
},
"GetFirewallConfigResponse":{
"type":"structure",
"members":{
"FirewallConfig":{
"shape":"FirewallConfig",
"documentation":"<p>Configuration of the firewall behavior provided by DNS Firewall for a single VPC from AmazonVPC. </p>"
}
}
},
"GetFirewallDomainListRequest":{
"type":"structure",
"required":["FirewallDomainListId"],
"members":{
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list. </p>"
}
}
},
"GetFirewallDomainListResponse":{
"type":"structure",
"members":{
"FirewallDomainList":{
"shape":"FirewallDomainList",
"documentation":"<p>The domain list that you requested. </p>"
}
}
},
"GetFirewallRuleGroupAssociationRequest":{
"type":"structure",
"required":["FirewallRuleGroupAssociationId"],
"members":{
"FirewallRuleGroupAssociationId":{
"shape":"ResourceId",
"documentation":"<p>The identifier of the <a>FirewallRuleGroupAssociation</a>. </p>"
}
}
},
"GetFirewallRuleGroupAssociationResponse":{
"type":"structure",
"members":{
"FirewallRuleGroupAssociation":{
"shape":"FirewallRuleGroupAssociation",
"documentation":"<p>The association that you requested. </p>"
}
}
},
"GetFirewallRuleGroupPolicyRequest":{
"type":"structure",
"required":["Arn"],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN (Amazon Resource Name) for the rule group.</p>"
}
}
},
"GetFirewallRuleGroupPolicyResponse":{
"type":"structure",
"members":{
"FirewallRuleGroupPolicy":{
"shape":"FirewallRuleGroupPolicy",
"documentation":"<p>The Identity and Access Management (Amazon Web Services IAM) policy for sharing the specified rule group. You can use the policy to share the rule group using Resource Access Manager (RAM). </p>"
}
}
},
"GetFirewallRuleGroupRequest":{
"type":"structure",
"required":["FirewallRuleGroupId"],
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group. </p>"
}
}
},
"GetFirewallRuleGroupResponse":{
"type":"structure",
"members":{
"FirewallRuleGroup":{
"shape":"FirewallRuleGroup",
"documentation":"<p>A collection of rules used to filter DNS network traffic. </p>"
}
}
},
"GetResolverConfigRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>Resource ID of the Amazon VPC that you want to get information about.</p>"
}
}
},
"GetResolverConfigResponse":{
"type":"structure",
"members":{
"ResolverConfig":{
"shape":"ResolverConfig",
"documentation":"<p>Information about the behavior configuration of Route 53 Resolver behavior for the VPC you specified in the <code>GetResolverConfig</code> request.</p>"
}
}
},
"GetResolverDnssecConfigRequest":{
"type":"structure",
"required":["ResourceId"],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the virtual private cloud (VPC) for the DNSSEC validation status.</p>"
}
}
},
"GetResolverDnssecConfigResponse":{
"type":"structure",
"members":{
"ResolverDNSSECConfig":{
"shape":"ResolverDnssecConfig",
"documentation":"<p>The information about a configuration for DNSSEC validation.</p>"
}
}
},
"GetResolverEndpointRequest":{
"type":"structure",
"required":["ResolverEndpointId"],
"members":{
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint that you want to get information about.</p>"
}
}
},
"GetResolverEndpointResponse":{
"type":"structure",
"members":{
"ResolverEndpoint":{
"shape":"ResolverEndpoint",
"documentation":"<p>Information about the Resolver endpoint that you specified in a <code>GetResolverEndpoint</code> request.</p>"
}
}
},
"GetResolverQueryLogConfigAssociationRequest":{
"type":"structure",
"required":["ResolverQueryLogConfigAssociationId"],
"members":{
"ResolverQueryLogConfigAssociationId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver query logging configuration association that you want to get information about.</p>"
}
}
},
"GetResolverQueryLogConfigAssociationResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfigAssociation":{
"shape":"ResolverQueryLogConfigAssociation",
"documentation":"<p>Information about the Resolver query logging configuration association that you specified in a <code>GetQueryLogConfigAssociation</code> request.</p>"
}
}
},
"GetResolverQueryLogConfigPolicyRequest":{
"type":"structure",
"required":["Arn"],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the query logging configuration that you want to get the query logging policy for.</p>"
}
}
},
"GetResolverQueryLogConfigPolicyResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfigPolicy":{
"shape":"ResolverQueryLogConfigPolicy",
"documentation":"<p>Information about the query logging policy for the query logging configuration that you specified in a <code>GetResolverQueryLogConfigPolicy</code> request.</p>"
}
}
},
"GetResolverQueryLogConfigRequest":{
"type":"structure",
"required":["ResolverQueryLogConfigId"],
"members":{
"ResolverQueryLogConfigId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver query logging configuration that you want to get information about.</p>"
}
}
},
"GetResolverQueryLogConfigResponse":{
"type":"structure",
"members":{
"ResolverQueryLogConfig":{
"shape":"ResolverQueryLogConfig",
"documentation":"<p>Information about the Resolver query logging configuration that you specified in a <code>GetQueryLogConfig</code> request.</p>"
}
}
},
"GetResolverRuleAssociationRequest":{
"type":"structure",
"required":["ResolverRuleAssociationId"],
"members":{
"ResolverRuleAssociationId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule association that you want to get information about.</p>"
}
}
},
"GetResolverRuleAssociationResponse":{
"type":"structure",
"members":{
"ResolverRuleAssociation":{
"shape":"ResolverRuleAssociation",
"documentation":"<p>Information about the Resolver rule association that you specified in a <code>GetResolverRuleAssociation</code> request.</p>"
}
}
},
"GetResolverRulePolicyRequest":{
"type":"structure",
"required":["Arn"],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ID of the Resolver rule that you want to get the Resolver rule policy for.</p>"
}
}
},
"GetResolverRulePolicyResponse":{
"type":"structure",
"members":{
"ResolverRulePolicy":{
"shape":"ResolverRulePolicy",
"documentation":"<p>The Resolver rule policy for the rule that you specified in a <code>GetResolverRulePolicy</code> request.</p>"
}
}
},
"GetResolverRuleRequest":{
"type":"structure",
"required":["ResolverRuleId"],
"members":{
"ResolverRuleId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule that you want to get information about.</p>"
}
}
},
"GetResolverRuleResponse":{
"type":"structure",
"members":{
"ResolverRule":{
"shape":"ResolverRule",
"documentation":"<p>Information about the Resolver rule that you specified in a <code>GetResolverRule</code> request.</p>"
}
}
},
"ImportFirewallDomainsRequest":{
"type":"structure",
"required":[
"FirewallDomainListId",
"Operation",
"DomainFileUrl"
],
"members":{
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list that you want to modify with the import operation.</p>"
},
"Operation":{
"shape":"FirewallDomainImportOperation",
"documentation":"<p>What you want DNS Firewall to do with the domains that are listed in the file. This must be set to <code>REPLACE</code>, which updates the domain list to exactly match the list in the file. </p>"
},
"DomainFileUrl":{
"shape":"DomainListFileUrl",
"documentation":"<p>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.</p> <p>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.</p>"
}
}
},
"ImportFirewallDomainsResponse":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The Id of the firewall domain list that DNS Firewall just updated.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the domain list. </p>"
},
"Status":{
"shape":"FirewallDomainListStatus",
"documentation":"<p> </p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>Additional information about the status of the list, if available.</p>"
}
}
},
"InternalServiceErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>We encountered an unknown error. Try again in a few minutes.</p>",
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The value that you specified for <code>NextToken</code> in a <code>List</code> request isn't valid.</p>",
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"required":["Message"],
"members":{
"Message":{"shape":"ExceptionMessage"},
"FieldName":{
"shape":"String",
"documentation":"<p>For an <code>InvalidParameterException</code> error, the name of the parameter that's invalid.</p>"
}
},
"documentation":"<p>One or more parameters in this request are not valid.</p>",
"exception":true
},
"InvalidPolicyDocument":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified Resolver rule policy is invalid.</p>",
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The request is invalid.</p>",
"exception":true
},
"InvalidTagException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified tag is invalid.</p>",
"exception":true
},
"Ip":{
"type":"string",
"max":36,
"min":7
},
"IpAddressCount":{"type":"integer"},
"IpAddressRequest":{
"type":"structure",
"required":["SubnetId"],
"members":{
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>The ID of the subnet that contains the IP address. </p>"
},
"Ip":{
"shape":"Ip",
"documentation":"<p>The IP address that you want to use for DNS queries.</p>",
"box":true
}
},
"documentation":"<p>In a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html\">CreateResolverEndpoint</a> request, the IP address that DNS queries originate from (for outbound endpoints) or that you forward DNS queries to (for inbound endpoints). <code>IpAddressRequest</code> also includes the ID of the subnet that contains the IP address.</p>"
},
"IpAddressResponse":{
"type":"structure",
"members":{
"IpId":{
"shape":"ResourceId",
"documentation":"<p>The ID of one IP address.</p>"
},
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>The ID of one subnet.</p>"
},
"Ip":{
"shape":"Ip",
"documentation":"<p>One IP address that the Resolver endpoint uses for DNS queries.</p>"
},
"Status":{
"shape":"IpAddressStatus",
"documentation":"<p>A status code that gives the current status of the request.</p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>A message that provides additional information about the status of the request.</p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).</p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>In the response to a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a> request, information about the IP addresses that the Resolver endpoint uses for DNS queries.</p>"
},
"IpAddressStatus":{
"type":"string",
"enum":[
"CREATING",
"FAILED_CREATION",
"ATTACHING",
"ATTACHED",
"REMAP_DETACHING",
"REMAP_ATTACHING",
"DETACHING",
"FAILED_RESOURCE_GONE",
"DELETING",
"DELETE_FAILED_FAS_EXPIRED"
]
},
"IpAddressUpdate":{
"type":"structure",
"members":{
"IpId":{
"shape":"ResourceId",
"documentation":"<p> <i>Only when removing an IP address from a Resolver endpoint</i>: The ID of the IP address that you want to remove. To get this ID, use <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a>.</p>",
"box":true
},
"SubnetId":{
"shape":"SubnetId",
"documentation":"<p>The ID of the subnet that includes the IP address that you want to update. To get this ID, use <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a>.</p>",
"box":true
},
"Ip":{
"shape":"Ip",
"documentation":"<p>The new IP address.</p>",
"box":true
}
},
"documentation":"<p>In an <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html\">UpdateResolverEndpoint</a> request, information about an IP address to update.</p>"
},
"IpAddressesRequest":{
"type":"list",
"member":{"shape":"IpAddressRequest"},
"max":10,
"min":1
},
"IpAddressesResponse":{
"type":"list",
"member":{"shape":"IpAddressResponse"}
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"String",
"documentation":"<p>For a <code>LimitExceededException</code> error, the type of resource that exceeded the current limit.</p>"
}
},
"documentation":"<p>The request caused one or more limits to be exceeded.</p>",
"exception":true
},
"ListDomainMaxResults":{
"type":"integer",
"max":5000,
"min":1
},
"ListFirewallConfigsMaxResult":{
"type":"integer",
"max":10,
"min":5
},
"ListFirewallConfigsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"ListFirewallConfigsMaxResult",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> 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.</p>",
"box":true
}
}
},
"ListFirewallConfigsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"FirewallConfigs":{
"shape":"FirewallConfigList",
"documentation":"<p>The configurations for the firewall behavior provided by DNS Firewall for VPCs from Amazon Virtual Private Cloud (Amazon VPC). </p>"
}
}
},
"ListFirewallDomainListsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> 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.</p>",
"box":true
}
}
},
"ListFirewallDomainListsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"FirewallDomainLists":{
"shape":"FirewallDomainListMetadataList",
"documentation":"<p>A list of the domain lists that you have defined. </p> <p>This might be a partial list of the domain lists that you've defined. For information, see <code>MaxResults</code>. </p>"
}
}
},
"ListFirewallDomainsRequest":{
"type":"structure",
"required":["FirewallDomainListId"],
"members":{
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list whose domains you want to retrieve. </p>"
},
"MaxResults":{
"shape":"ListDomainMaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> 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.</p>",
"box":true
}
}
},
"ListFirewallDomainsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"Domains":{
"shape":"FirewallDomains",
"documentation":"<p>A list of the domains in the firewall domain list. </p> <p>This might be a partial list of the domains that you've defined in the domain list. For information, see <code>MaxResults</code>. </p>"
}
}
},
"ListFirewallRuleGroupAssociationsRequest":{
"type":"structure",
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>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. </p>",
"box":true
},
"VpcId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the VPC that you want to retrieve the associations for. Leave this blank to retrieve associations for any VPC. </p>",
"box":true
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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. </p>",
"box":true
},
"Status":{
"shape":"FirewallRuleGroupAssociationStatus",
"documentation":"<p>The association <code>Status</code> 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.</p>",
"box":true
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> 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.</p>",
"box":true
}
}
},
"ListFirewallRuleGroupAssociationsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"FirewallRuleGroupAssociations":{
"shape":"FirewallRuleGroupAssociations",
"documentation":"<p>A list of your firewall rule group associations.</p> <p>This might be a partial list of the associations that you have defined. For information, see <code>MaxResults</code>. </p>"
}
}
},
"ListFirewallRuleGroupsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> 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.</p>",
"box":true
}
}
},
"ListFirewallRuleGroupsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"FirewallRuleGroups":{
"shape":"FirewallRuleGroupMetadataList",
"documentation":"<p>A list of your firewall rule groups.</p> <p>This might be a partial list of the rule groups that you have defined. For information, see <code>MaxResults</code>. </p>"
}
}
},
"ListFirewallRulesRequest":{
"type":"structure",
"required":["FirewallRuleGroupId"],
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group that you want to retrieve the rules for. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>Optional additional filter for the rules to retrieve.</p> <p>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.</p>",
"box":true
},
"Action":{
"shape":"Action",
"documentation":"<p>Optional additional filter for the rules to retrieve.</p> <p>The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:</p> <ul> <li> <p> <code>ALLOW</code> - Permit the request to go through.</p> </li> <li> <p> <code>ALERT</code> - Permit the request to go through but send an alert to the logs.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. If this is specified, additional handling details are provided in the rule's <code>BlockResponse</code> setting. </p> </li> </ul>",
"box":true
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>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 <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p> <p>If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 objects. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first call to this list request, omit this value.</p> <p>When you request a list of objects, Resolver returns at most the number of objects specified in <code>MaxResults</code>. If more objects are available for retrieval, Resolver returns a <code>NextToken</code> 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.</p>",
"box":true
}
}
},
"ListFirewallRulesResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>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.</p>"
},
"FirewallRules":{
"shape":"FirewallRules",
"documentation":"<p>A list of the rules that you have defined. </p> <p>This might be a partial list of the firewall rules that you've defined. For information, see <code>MaxResults</code>. </p>"
}
}
},
"ListResolverConfigsMaxResult":{
"type":"integer",
"max":100,
"min":5
},
"ListResolverConfigsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"ListResolverConfigsMaxResult",
"documentation":"<p>The maximum number of Resolver configurations that you want to return in the response to a <code>ListResolverConfigs</code> request. If you don't specify a value for <code>MaxResults</code>, up to 100 Resolver configurations are returned.</p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>(Optional) If the current Amazon Web Services account has more than <code>MaxResults</code> Resolver configurations, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p>For the first <code>ListResolverConfigs</code> request, omit this value.</p> <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p>",
"box":true
}
}
},
"ListResolverConfigsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, <code>NextToken</code> doesn't appear in the response.</p> <p>If a response doesn't include the last of the configurations, you can get more configurations by submitting another <code>ListResolverConfigs</code> request. Get the value of <code>NextToken</code> that Amazon Route 53 returned in the previous response and include it in <code>NextToken</code> in the next request.</p>"
},
"ResolverConfigs":{
"shape":"ResolverConfigList",
"documentation":"<p>An array that contains one <code>ResolverConfigs</code> element for each Resolver configuration that is associated with the current Amazon Web Services account.</p>"
}
}
},
"ListResolverDnssecConfigsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p> <i>Optional</i>: 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 <code>MaxResults</code>, Route 53 returns up to 100 configuration per page.</p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>(Optional) If the current Amazon Web Services account has more than <code>MaxResults</code> DNSSEC configurations, use <code>NextToken</code> to get the second and subsequent pages of results.</p> <p>For the first <code>ListResolverDnssecConfigs</code> request, omit this value.</p> <p>For the second and subsequent requests, get the value of <code>NextToken</code> from the previous response and specify that value for <code>NextToken</code> in the request.</p>",
"box":true
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An optional specification to return a subset of objects.</p>",
"box":true
}
}
},
"ListResolverDnssecConfigsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, <code>NextToken</code> doesn't appear in the response.</p> <p>If a response doesn't include the last of the configurations, you can get more configurations by submitting another <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_ListResolverDnssecConfigs.html\">ListResolverDnssecConfigs</a> request. Get the value of <code>NextToken</code> that Amazon Route 53 returned in the previous response and include it in <code>NextToken</code> in the next request.</p>"
},
"ResolverDnssecConfigs":{
"shape":"ResolverDnssecConfigList",
"documentation":"<p>An array that contains one <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_ResolverDnssecConfig.html\">ResolverDnssecConfig</a> element for each configuration for DNSSEC validation that is associated with the current Amazon Web Services account.</p>"
}
}
},
"ListResolverEndpointIpAddressesRequest":{
"type":"structure",
"required":["ResolverEndpointId"],
"members":{
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint that you want to get IP addresses for.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of IP addresses that you want to return in the response to a <code>ListResolverEndpointIpAddresses</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 IP addresses. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListResolverEndpointIpAddresses</code> request, omit this value.</p> <p>If the specified Resolver endpoint has more than <code>MaxResults</code> IP addresses, you can submit another <code>ListResolverEndpointIpAddresses</code> request to get the next group of IP addresses. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>",
"box":true
}
}
},
"ListResolverEndpointIpAddressesResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If the specified endpoint has more than <code>MaxResults</code> IP addresses, you can submit another <code>ListResolverEndpointIpAddresses</code> request to get the next group of IP addresses. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The value that you specified for <code>MaxResults</code> in the request.</p>"
},
"IpAddresses":{
"shape":"IpAddressesResponse",
"documentation":"<p>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).</p>"
}
}
},
"ListResolverEndpointsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of Resolver endpoints that you want to return in the response to a <code>ListResolverEndpoints</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 Resolver endpoints. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListResolverEndpoints</code> request, omit this value.</p> <p>If you have more than <code>MaxResults</code> Resolver endpoints, you can submit another <code>ListResolverEndpoints</code> request to get the next group of Resolver endpoints. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>",
"box":true
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.</p> <note> <p>If you submit a second or subsequent <code>ListResolverEndpoints</code> request and specify the <code>NextToken</code> parameter, you must use the same values for <code>Filters</code>, if any, as in the previous request.</p> </note>",
"box":true
}
}
},
"ListResolverEndpointsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> IP addresses match the specified criteria, you can submit another <code>ListResolverEndpoint</code> request to get the next group of results. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The value that you specified for <code>MaxResults</code> in the request.</p>"
},
"ResolverEndpoints":{
"shape":"ResolverEndpoints",
"documentation":"<p>The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.</p>"
}
}
},
"ListResolverQueryLogConfigAssociationsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of query logging associations that you want to return in the response to a <code>ListResolverQueryLogConfigAssociations</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 query logging associations. </p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListResolverQueryLogConfigAssociations</code> request, omit this value.</p> <p>If there are more than <code>MaxResults</code> query logging associations that match the values that you specify for <code>Filters</code>, you can submit another <code>ListResolverQueryLogConfigAssociations</code> request to get the next group of associations. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An optional specification to return a subset of query logging associations.</p> <note> <p>If you submit a second or subsequent <code>ListResolverQueryLogConfigAssociations</code> request and specify the <code>NextToken</code> parameter, you must use the same values for <code>Filters</code>, if any, as in the previous request.</p> </note>"
},
"SortBy":{
"shape":"SortByKey",
"documentation":"<p>The element that you want Resolver to sort query logging associations by. </p> <note> <p>If you submit a second or subsequent <code>ListResolverQueryLogConfigAssociations</code> request and specify the <code>NextToken</code> parameter, you must use the same value for <code>SortBy</code>, if any, as in the previous request.</p> </note> <p>Valid values include the following elements:</p> <ul> <li> <p> <code>CreationTime</code>: The ID of the query logging association.</p> </li> <li> <p> <code>Error</code>: If the value of <code>Status</code> is <code>FAILED</code>, the value of <code>Error</code> indicates the cause: </p> <ul> <li> <p> <code>DESTINATION_NOT_FOUND</code>: The specified destination (for example, an Amazon S3 bucket) was deleted.</p> </li> <li> <p> <code>ACCESS_DENIED</code>: Permissions don't allow sending logs to the destination.</p> </li> </ul> <p>If <code>Status</code> is a value other than <code>FAILED</code>, <code>ERROR</code> is null.</p> </li> <li> <p> <code>Id</code>: The ID of the query logging association</p> </li> <li> <p> <code>ResolverQueryLogConfigId</code>: The ID of the query logging configuration</p> </li> <li> <p> <code>ResourceId</code>: The ID of the VPC that is associated with the query logging configuration</p> </li> <li> <p> <code>Status</code>: The current status of the configuration. Valid values include the following:</p> <ul> <li> <p> <code>CREATING</code>: Resolver is creating an association between an Amazon VPC and a query logging configuration.</p> </li> <li> <p> <code>CREATED</code>: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.</p> </li> <li> <p> <code>DELETING</code>: Resolver is deleting this query logging association.</p> </li> <li> <p> <code>FAILED</code>: Resolver either couldn't create or couldn't delete the query logging association. Here are two common causes:</p> <ul> <li> <p>The specified destination (for example, an Amazon S3 bucket) was deleted.</p> </li> <li> <p>Permissions don't allow sending logs to the destination.</p> </li> </ul> </li> </ul> </li> </ul>"
},
"SortOrder":{
"shape":"SortOrder",
"documentation":"<p>If you specified a value for <code>SortBy</code>, the order that you want query logging associations to be listed in, <code>ASCENDING</code> or <code>DESCENDING</code>.</p> <note> <p>If you submit a second or subsequent <code>ListResolverQueryLogConfigAssociations</code> request and specify the <code>NextToken</code> parameter, you must use the same value for <code>SortOrder</code>, if any, as in the previous request.</p> </note>"
}
}
},
"ListResolverQueryLogConfigAssociationsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If there are more than <code>MaxResults</code> query logging associations, you can submit another <code>ListResolverQueryLogConfigAssociations</code> request to get the next group of associations. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"TotalCount":{
"shape":"Count",
"documentation":"<p>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 <code>ListResolverQueryLogConfigAssociations</code> response, depending on the values that you specify in the request.</p>"
},
"TotalFilteredCount":{
"shape":"Count",
"documentation":"<p>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 <code>ListResolverQueryLogConfigAssociations</code> request. For the total number of associations that were created by the current account in the specified Region, see <code>TotalCount</code>.</p>"
},
"ResolverQueryLogConfigAssociations":{
"shape":"ResolverQueryLogConfigAssociationList",
"documentation":"<p>A list that contains one <code>ResolverQueryLogConfigAssociations</code> element for each query logging association that matches the values that you specified for <code>Filter</code>.</p>"
}
}
},
"ListResolverQueryLogConfigsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of query logging configurations that you want to return in the response to a <code>ListResolverQueryLogConfigs</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 query logging configurations. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListResolverQueryLogConfigs</code> request, omit this value.</p> <p>If there are more than <code>MaxResults</code> query logging configurations that match the values that you specify for <code>Filters</code>, you can submit another <code>ListResolverQueryLogConfigs</code> request to get the next group of configurations. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>",
"box":true
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An optional specification to return a subset of query logging configurations.</p> <note> <p>If you submit a second or subsequent <code>ListResolverQueryLogConfigs</code> request and specify the <code>NextToken</code> parameter, you must use the same values for <code>Filters</code>, if any, as in the previous request.</p> </note>",
"box":true
},
"SortBy":{
"shape":"SortByKey",
"documentation":"<p>The element that you want Resolver to sort query logging configurations by. </p> <note> <p>If you submit a second or subsequent <code>ListResolverQueryLogConfigs</code> request and specify the <code>NextToken</code> parameter, you must use the same value for <code>SortBy</code>, if any, as in the previous request.</p> </note> <p>Valid values include the following elements:</p> <ul> <li> <p> <code>Arn</code>: The ARN of the query logging configuration</p> </li> <li> <p> <code>AssociationCount</code>: The number of VPCs that are associated with the specified configuration </p> </li> <li> <p> <code>CreationTime</code>: The date and time that Resolver returned when the configuration was created</p> </li> <li> <p> <code>CreatorRequestId</code>: The value that was specified for <code>CreatorRequestId</code> when the configuration was created</p> </li> <li> <p> <code>DestinationArn</code>: The location that logs are sent to</p> </li> <li> <p> <code>Id</code>: The ID of the configuration</p> </li> <li> <p> <code>Name</code>: The name of the configuration</p> </li> <li> <p> <code>OwnerId</code>: The Amazon Web Services account number of the account that created the configuration</p> </li> <li> <p> <code>ShareStatus</code>: 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).</p> </li> <li> <p> <code>Status</code>: The current status of the configuration. Valid values include the following:</p> <ul> <li> <p> <code>CREATING</code>: Resolver is creating the query logging configuration.</p> </li> <li> <p> <code>CREATED</code>: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.</p> </li> <li> <p> <code>DELETING</code>: Resolver is deleting this query logging configuration.</p> </li> <li> <p> <code>FAILED</code>: Resolver either couldn't create or couldn't delete the query logging configuration. Here are two common causes:</p> <ul> <li> <p>The specified destination (for example, an Amazon S3 bucket) was deleted.</p> </li> <li> <p>Permissions don't allow sending logs to the destination.</p> </li> </ul> </li> </ul> </li> </ul>"
},
"SortOrder":{
"shape":"SortOrder",
"documentation":"<p>If you specified a value for <code>SortBy</code>, the order that you want query logging configurations to be listed in, <code>ASCENDING</code> or <code>DESCENDING</code>.</p> <note> <p>If you submit a second or subsequent <code>ListResolverQueryLogConfigs</code> request and specify the <code>NextToken</code> parameter, you must use the same value for <code>SortOrder</code>, if any, as in the previous request.</p> </note>"
}
}
},
"ListResolverQueryLogConfigsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If there are more than <code>MaxResults</code> query logging configurations, you can submit another <code>ListResolverQueryLogConfigs</code> request to get the next group of configurations. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"TotalCount":{
"shape":"Count",
"documentation":"<p>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 <code>ListResolverQueryLogConfigs</code> response, depending on the values that you specify in the request.</p>"
},
"TotalFilteredCount":{
"shape":"Count",
"documentation":"<p>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 <code>ListResolverQueryLogConfigs</code> request. For the total number of query logging configurations that were created by the current account in the specified Region, see <code>TotalCount</code>.</p>"
},
"ResolverQueryLogConfigs":{
"shape":"ResolverQueryLogConfigList",
"documentation":"<p>A list that contains one <code>ResolverQueryLogConfig</code> element for each query logging configuration that matches the values that you specified for <code>Filter</code>.</p>"
}
}
},
"ListResolverRuleAssociationsRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of rule associations that you want to return in the response to a <code>ListResolverRuleAssociations</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 rule associations. </p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListResolverRuleAssociation</code> request, omit this value.</p> <p>If you have more than <code>MaxResults</code> rule associations, you can submit another <code>ListResolverRuleAssociation</code> request to get the next group of rule associations. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>",
"box":true
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.</p> <note> <p>If you submit a second or subsequent <code>ListResolverRuleAssociations</code> request and specify the <code>NextToken</code> parameter, you must use the same values for <code>Filters</code>, if any, as in the previous request.</p> </note>",
"box":true
}
}
},
"ListResolverRuleAssociationsResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> rule associations match the specified criteria, you can submit another <code>ListResolverRuleAssociation</code> request to get the next group of results. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The value that you specified for <code>MaxResults</code> in the request.</p>"
},
"ResolverRuleAssociations":{
"shape":"ResolverRuleAssociations",
"documentation":"<p>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.</p>"
}
}
},
"ListResolverRulesRequest":{
"type":"structure",
"members":{
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of Resolver rules that you want to return in the response to a <code>ListResolverRules</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 Resolver rules.</p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListResolverRules</code> request, omit this value.</p> <p>If you have more than <code>MaxResults</code> Resolver rules, you can submit another <code>ListResolverRules</code> request to get the next group of Resolver rules. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>",
"box":true
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.</p> <note> <p>If you submit a second or subsequent <code>ListResolverRules</code> request and specify the <code>NextToken</code> parameter, you must use the same values for <code>Filters</code>, if any, as in the previous request.</p> </note>",
"box":true
}
}
},
"ListResolverRulesResponse":{
"type":"structure",
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> Resolver rules match the specified criteria, you can submit another <code>ListResolverRules</code> request to get the next group of results. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The value that you specified for <code>MaxResults</code> in the request.</p>"
},
"ResolverRules":{
"shape":"ResolverRules",
"documentation":"<p>The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the resource that you want to list tags for.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of tags that you want to return in the response to a <code>ListTagsForResource</code> request. If you don't specify a value for <code>MaxResults</code>, Resolver returns up to 100 tags.</p>",
"box":true
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListTagsForResource</code> request, omit this value.</p> <p>If you have more than <code>MaxResults</code> tags, you can submit another <code>ListTagsForResource</code> request to get the next group of tags for the resource. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>",
"box":true
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that are associated with the resource that you specified in the <code>ListTagsForResource</code> request.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> tags match the specified criteria, you can submit another <code>ListTagsForResource</code> request to get the next group of results. In the next request, specify the value of <code>NextToken</code> from the previous response. </p>"
}
}
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"MutationProtectionStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"Name":{
"type":"string",
"max":64,
"pattern":"(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)"
},
"NextToken":{"type":"string"},
"Port":{
"type":"integer",
"max":65535,
"min":0
},
"Priority":{"type":"integer"},
"PutFirewallRuleGroupPolicyRequest":{
"type":"structure",
"required":[
"Arn",
"FirewallRuleGroupPolicy"
],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN (Amazon Resource Name) for the rule group that you want to share.</p>"
},
"FirewallRuleGroupPolicy":{
"shape":"FirewallRuleGroupPolicy",
"documentation":"<p>The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.</p>"
}
}
},
"PutFirewallRuleGroupPolicyResponse":{
"type":"structure",
"members":{
"ReturnValue":{
"shape":"Boolean",
"documentation":"<p/>"
}
}
},
"PutResolverQueryLogConfigPolicyRequest":{
"type":"structure",
"required":[
"Arn",
"ResolverQueryLogConfigPolicy"
],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the account that you want to share rules with.</p>"
},
"ResolverQueryLogConfigPolicy":{
"shape":"ResolverQueryLogConfigPolicy",
"documentation":"<p>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 <code>Actions</code> section of the statement:</p> <ul> <li> <p> <code>route53resolver:AssociateResolverQueryLogConfig</code> </p> </li> <li> <p> <code>route53resolver:DisassociateResolverQueryLogConfig</code> </p> </li> <li> <p> <code>route53resolver:ListResolverQueryLogConfigAssociations</code> </p> </li> <li> <p> <code>route53resolver:ListResolverQueryLogConfigs</code> </p> </li> </ul> <p>In the <code>Resource</code> 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 <code>Arn</code>. </p>"
}
}
},
"PutResolverQueryLogConfigPolicyResponse":{
"type":"structure",
"members":{
"ReturnValue":{
"shape":"Boolean",
"documentation":"<p>Whether the <code>PutResolverQueryLogConfigPolicy</code> request was successful.</p>"
}
},
"documentation":"<p>The response to a <code>PutResolverQueryLogConfigPolicy</code> request.</p>"
},
"PutResolverRulePolicyRequest":{
"type":"structure",
"required":[
"Arn",
"ResolverRulePolicy"
],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the rule that you want to share with another account.</p>"
},
"ResolverRulePolicy":{
"shape":"ResolverRulePolicy",
"documentation":"<p>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 <code>Action</code> section of the statement:</p> <ul> <li> <p> <code>route53resolver:GetResolverRule</code> </p> </li> <li> <p> <code>route53resolver:AssociateResolverRule</code> </p> </li> <li> <p> <code>route53resolver:DisassociateResolverRule</code> </p> </li> <li> <p> <code>route53resolver:ListResolverRules</code> </p> </li> <li> <p> <code>route53resolver:ListResolverRuleAssociations</code> </p> </li> </ul> <p>In the <code>Resource</code> 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 <code>Arn</code>.</p>"
}
}
},
"PutResolverRulePolicyResponse":{
"type":"structure",
"members":{
"ReturnValue":{
"shape":"Boolean",
"documentation":"<p>Whether the <code>PutResolverRulePolicy</code> request was successful.</p>"
}
},
"documentation":"<p>The response to a <code>PutResolverRulePolicy</code> request.</p>"
},
"ResolverAutodefinedReverseStatus":{
"type":"string",
"enum":[
"ENABLING",
"ENABLED",
"DISABLING",
"DISABLED"
]
},
"ResolverConfig":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>ID for the Resolver configuration.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Amazon Virtual Private Cloud VPC that you're configuring Resolver for.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>The owner account ID of the Amazon Virtual Private Cloud VPC.</p>"
},
"AutodefinedReverse":{
"shape":"ResolverAutodefinedReverseStatus",
"documentation":"<p> 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:</p> <p> Status of the rules generated by VPCs based on CIDR/Region for reverse DNS resolution. The status can be one of following:</p> <ul> <li> <p> <b>ENABLING:</b> Autodefined rules for reverse DNS lookups are being enabled but are not complete.</p> </li> <li> <p> <b>ENABLED:</b> Autodefined rules for reverse DNS lookups are enabled.</p> </li> <li> <p> <b>DISABLING:</b> Autodefined rules for reverse DNS lookups are being disabled but are not complete.</p> </li> <li> <p> <b>DISABLED:</b> Autodefined rules for reverse DNS lookups are disabled.</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that contains information about a Resolver configuration for a VPC.</p>"
},
"ResolverConfigList":{
"type":"list",
"member":{"shape":"ResolverConfig"}
},
"ResolverDNSSECValidationStatus":{
"type":"string",
"enum":[
"ENABLING",
"ENABLED",
"DISABLING",
"DISABLED"
]
},
"ResolverDnssecConfig":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID for a configuration for DNSSEC validation.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the virtual private cloud (VPC) that you're configuring the DNSSEC validation status for.</p>"
},
"ValidationStatus":{
"shape":"ResolverDNSSECValidationStatus",
"documentation":"<p>The validation status for a DNSSEC configuration. The status can be one of the following:</p> <ul> <li> <p> <b>ENABLING:</b> DNSSEC validation is being enabled but is not complete.</p> </li> <li> <p> <b>ENABLED:</b> DNSSEC validation is enabled.</p> </li> <li> <p> <b>DISABLING:</b> DNSSEC validation is being disabled but is not complete.</p> </li> <li> <p> <b>DISABLED</b> DNSSEC validation is disabled.</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that contains information about a configuration for DNSSEC validation.</p>"
},
"ResolverDnssecConfigList":{
"type":"list",
"member":{"shape":"ResolverDnssecConfig"}
},
"ResolverEndpoint":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint.</p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request that created the Resolver endpoint. The <code>CreatorRequestId</code> allows failed requests to be retried without the risk of running the operation twice.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN (Amazon Resource Name) for the Resolver endpoint.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name that you assigned to the Resolver endpoint when you submitted a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html\">CreateResolverEndpoint</a> request.</p>"
},
"SecurityGroupIds":{
"shape":"SecurityGroupIds",
"documentation":"<p>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.</p>"
},
"Direction":{
"shape":"ResolverEndpointDirection",
"documentation":"<p>Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:</p> <ul> <li> <p> <code>INBOUND</code>: allows DNS queries to your VPC from your network</p> </li> <li> <p> <code>OUTBOUND</code>: allows DNS queries from your VPC to your network</p> </li> </ul>"
},
"IpAddressCount":{
"shape":"IpAddressCount",
"documentation":"<p>The number of IP addresses that the Resolver endpoint can use for DNS queries.</p>"
},
"HostVPCId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC that you want to create the Resolver endpoint in.</p>"
},
"Status":{
"shape":"ResolverEndpointStatus",
"documentation":"<p>A code that specifies the current status of the Resolver endpoint. Valid values include the following:</p> <ul> <li> <p> <code>CREATING</code>: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.</p> </li> <li> <p> <code>OPERATIONAL</code>: 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.</p> </li> <li> <p> <code>UPDATING</code>: Resolver is associating or disassociating one or more network interfaces with this endpoint.</p> </li> <li> <p> <code>AUTO_RECOVERING</code>: 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 <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities-resolver\">Limits on Route 53 Resolver</a>.</p> </li> <li> <p> <code>ACTION_NEEDED</code>: 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 <code>ACTION_NEEDED</code> can have a variety of causes. Here are two common causes:</p> <ul> <li> <p>One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.</p> </li> <li> <p>The network interface couldn't be created for some reason that's outside the control of Resolver.</p> </li> </ul> </li> <li> <p> <code>DELETING</code>: Resolver is deleting this endpoint and the associated network interfaces.</p> </li> </ul>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>A detailed description of the status of the Resolver endpoint.</p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the endpoint was created, in Unix time format and Coordinated Universal Time (UTC).</p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the endpoint was last modified, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>In the response to a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverEndpoint.html\">CreateResolverEndpoint</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverEndpoint.html\">DeleteResolverEndpoint</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html\">ListResolverEndpoints</a>, or <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverEndpoint.html\">UpdateResolverEndpoint</a> request, a complex type that contains settings for an existing inbound or outbound Resolver endpoint.</p>"
},
"ResolverEndpointDirection":{
"type":"string",
"enum":[
"INBOUND",
"OUTBOUND"
]
},
"ResolverEndpointStatus":{
"type":"string",
"enum":[
"CREATING",
"OPERATIONAL",
"UPDATING",
"AUTO_RECOVERING",
"ACTION_NEEDED",
"DELETING"
]
},
"ResolverEndpoints":{
"type":"list",
"member":{"shape":"ResolverEndpoint"}
},
"ResolverQueryLogConfig":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID for the query logging configuration.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>The Amazon Web Services account ID for the account that created the query logging configuration. </p>"
},
"Status":{
"shape":"ResolverQueryLogConfigStatus",
"documentation":"<p>The status of the specified query logging configuration. Valid values include the following:</p> <ul> <li> <p> <code>CREATING</code>: Resolver is creating the query logging configuration.</p> </li> <li> <p> <code>CREATED</code>: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.</p> </li> <li> <p> <code>DELETING</code>: Resolver is deleting this query logging configuration.</p> </li> <li> <p> <code>FAILED</code>: Resolver can't deliver logs to the location that is specified in the query logging configuration. Here are two common causes:</p> <ul> <li> <p>The specified destination (for example, an Amazon S3 bucket) was deleted.</p> </li> <li> <p>Permissions don't allow sending logs to the destination.</p> </li> </ul> </li> </ul>"
},
"ShareStatus":{
"shape":"ShareStatus",
"documentation":"<p>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).</p>"
},
"AssociationCount":{
"shape":"Count",
"documentation":"<p>The number of VPCs that are associated with the query logging configuration.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN for the query logging configuration.</p>"
},
"Name":{
"shape":"ResolverQueryLogConfigName",
"documentation":"<p>The name of the query logging configuration. </p>"
},
"DestinationArn":{
"shape":"DestinationArn",
"documentation":"<p>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.</p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that identifies the request that created the query logging configuration. The <code>CreatorRequestId</code> allows failed requests to be retried without the risk of running the operation twice.</p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>In the response to a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverQueryLogConfig.html\">CreateResolverQueryLogConfig</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverQueryLogConfig.html\">DeleteResolverQueryLogConfig</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfig.html\">GetResolverQueryLogConfig</a>, or <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigs.html\">ListResolverQueryLogConfigs</a> request, a complex type that contains settings for one query logging configuration.</p>"
},
"ResolverQueryLogConfigAssociation":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the query logging association.</p>"
},
"ResolverQueryLogConfigId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the query logging configuration that a VPC is associated with.</p>"
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Amazon VPC that is associated with the query logging configuration.</p>"
},
"Status":{
"shape":"ResolverQueryLogConfigAssociationStatus",
"documentation":"<p>The status of the specified query logging association. Valid values include the following:</p> <ul> <li> <p> <code>CREATING</code>: Resolver is creating an association between an Amazon VPC and a query logging configuration.</p> </li> <li> <p> <code>CREATED</code>: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.</p> </li> <li> <p> <code>DELETING</code>: Resolver is deleting this query logging association.</p> </li> <li> <p> <code>FAILED</code>: Resolver either couldn't create or couldn't delete the query logging association.</p> </li> </ul>"
},
"Error":{
"shape":"ResolverQueryLogConfigAssociationError",
"documentation":"<p>If the value of <code>Status</code> is <code>FAILED</code>, the value of <code>Error</code> indicates the cause:</p> <ul> <li> <p> <code>DESTINATION_NOT_FOUND</code>: The specified destination (for example, an Amazon S3 bucket) was deleted.</p> </li> <li> <p> <code>ACCESS_DENIED</code>: Permissions don't allow sending logs to the destination.</p> </li> </ul> <p>If the value of <code>Status</code> is a value other than <code>FAILED</code>, <code>Error</code> is null. </p>"
},
"ErrorMessage":{
"shape":"ResolverQueryLogConfigAssociationErrorMessage",
"documentation":"<p>Contains additional information about the error. If the value or <code>Error</code> is null, the value of <code>ErrorMessage</code> also is null.</p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>In the response to an <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverQueryLogConfig.html\">AssociateResolverQueryLogConfig</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverQueryLogConfig.html\">DisassociateResolverQueryLogConfig</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverQueryLogConfigAssociation.html\">GetResolverQueryLogConfigAssociation</a>, or <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverQueryLogConfigAssociations.html\">ListResolverQueryLogConfigAssociations</a>, request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.</p>"
},
"ResolverQueryLogConfigAssociationError":{
"type":"string",
"enum":[
"NONE",
"DESTINATION_NOT_FOUND",
"ACCESS_DENIED",
"INTERNAL_SERVICE_ERROR"
]
},
"ResolverQueryLogConfigAssociationErrorMessage":{"type":"string"},
"ResolverQueryLogConfigAssociationList":{
"type":"list",
"member":{"shape":"ResolverQueryLogConfigAssociation"}
},
"ResolverQueryLogConfigAssociationStatus":{
"type":"string",
"enum":[
"CREATING",
"ACTIVE",
"ACTION_NEEDED",
"DELETING",
"FAILED"
]
},
"ResolverQueryLogConfigList":{
"type":"list",
"member":{"shape":"ResolverQueryLogConfig"}
},
"ResolverQueryLogConfigName":{
"type":"string",
"max":64,
"min":1,
"pattern":"(?!^[0-9]+$)([a-zA-Z0-9\\-_' ']+)"
},
"ResolverQueryLogConfigPolicy":{
"type":"string",
"max":30000
},
"ResolverQueryLogConfigStatus":{
"type":"string",
"enum":[
"CREATING",
"CREATED",
"DELETING",
"FAILED"
]
},
"ResolverRule":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID that Resolver assigned to the Resolver rule when you created it.</p>"
},
"CreatorRequestId":{
"shape":"CreatorRequestId",
"documentation":"<p>A unique string that you specified when you created the Resolver rule. <code>CreatorRequestId</code> identifies the request and allows failed requests to be retried without the risk of running the operation twice. </p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN (Amazon Resource Name) for the Resolver rule specified by <code>Id</code>.</p>"
},
"DomainName":{
"shape":"DomainName",
"documentation":"<p>DNS queries for this domain name are forwarded to the IP addresses that are specified in <code>TargetIps</code>. 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).</p>"
},
"Status":{
"shape":"ResolverRuleStatus",
"documentation":"<p>A code that specifies the current status of the Resolver rule.</p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>A detailed description of the status of a Resolver rule.</p>"
},
"RuleType":{
"shape":"RuleTypeOption",
"documentation":"<p>When you want to forward DNS queries for specified domain name to resolvers on your network, specify <code>FORWARD</code>.</p> <p>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 <code>SYSTEM</code>.</p> <p>For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify <code>FORWARD</code> for <code>RuleType</code>. To then have Resolver process queries for apex.example.com, you create a rule and specify <code>SYSTEM</code> for <code>RuleType</code>.</p> <p>Currently, only Resolver can create rules that have a value of <code>RECURSIVE</code> for <code>RuleType</code>.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name for the Resolver rule, which you specified when you created the Resolver rule.</p>"
},
"TargetIps":{
"shape":"TargetList",
"documentation":"<p>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. Specify IPv4 addresses. IPv6 is not supported.</p>"
},
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the endpoint that the rule is associated with.</p>"
},
"OwnerId":{
"shape":"AccountId",
"documentation":"<p>When a rule is shared with another Amazon Web Services account, the account ID of the account that the rule is shared with.</p>"
},
"ShareStatus":{
"shape":"ShareStatus",
"documentation":"<p>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.</p>"
},
"CreationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the Resolver rule was created, in Unix time format and Coordinated Universal Time (UTC).</p>"
},
"ModificationTime":{
"shape":"Rfc3339TimeString",
"documentation":"<p>The date and time that the Resolver rule was last updated, in Unix time format and Coordinated Universal Time (UTC).</p>"
}
},
"documentation":"<p>For queries that originate in your VPC, detailed information about a Resolver rule, which specifies how to route DNS queries out of the VPC. The <code>ResolverRule</code> parameter appears in the response to a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html\">CreateResolverRule</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DeleteResolverRule.html\">DeleteResolverRule</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html\">GetResolverRule</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html\">ListResolverRules</a>, or <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html\">UpdateResolverRule</a> request.</p>"
},
"ResolverRuleAssociation":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html\">AssociateResolverRule</a> request.</p>"
},
"ResolverRuleId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule that you associated with the VPC that is specified by <code>VPCId</code>.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of an association between a Resolver rule and a VPC.</p>"
},
"VPCId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC that you associated the Resolver rule with.</p>"
},
"Status":{
"shape":"ResolverRuleAssociationStatus",
"documentation":"<p>A code that specifies the current status of the association between a Resolver rule and a VPC.</p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>A detailed description of the status of the association between a Resolver rule and a VPC.</p>"
}
},
"documentation":"<p>In the response to an <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_AssociateResolverRule.html\">AssociateResolverRule</a>, <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_DisassociateResolverRule.html\">DisassociateResolverRule</a>, or <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html\">ListResolverRuleAssociations</a> request, provides information about an association between a Resolver rule and a VPC. The association determines which DNS queries that originate in the VPC are forwarded to your network. </p>"
},
"ResolverRuleAssociationStatus":{
"type":"string",
"enum":[
"CREATING",
"COMPLETE",
"DELETING",
"FAILED",
"OVERRIDDEN"
]
},
"ResolverRuleAssociations":{
"type":"list",
"member":{"shape":"ResolverRuleAssociation"}
},
"ResolverRuleConfig":{
"type":"structure",
"members":{
"Name":{
"shape":"Name",
"documentation":"<p>The new name for the Resolver rule. The name that you specify appears in the Resolver dashboard in the Route 53 console. </p>"
},
"TargetIps":{
"shape":"TargetList",
"documentation":"<p>For DNS queries that originate in your VPC, the new IP addresses that you want to route outbound DNS queries to.</p>"
},
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>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 <code>TargetIps</code>.</p>"
}
},
"documentation":"<p>In an <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_UpdateResolverRule.html\">UpdateResolverRule</a> request, information about the changes that you want to make.</p>"
},
"ResolverRulePolicy":{
"type":"string",
"max":5000
},
"ResolverRuleStatus":{
"type":"string",
"enum":[
"COMPLETE",
"DELETING",
"UPDATING",
"FAILED"
]
},
"ResolverRules":{
"type":"list",
"member":{"shape":"ResolverRule"}
},
"ResourceExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"String",
"documentation":"<p>For a <code>ResourceExistsException</code> error, the type of resource that the error applies to.</p>"
}
},
"documentation":"<p>The resource that you tried to create already exists.</p>",
"exception":true
},
"ResourceId":{
"type":"string",
"max":64,
"min":1
},
"ResourceInUseException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"String",
"documentation":"<p>For a <code>ResourceInUseException</code> error, the type of resource that is currently in use.</p>"
}
},
"documentation":"<p>The resource that you tried to update or delete is currently in use.</p>",
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"String",
"documentation":"<p>For a <code>ResourceNotFoundException</code> error, the type of resource that doesn't exist.</p>"
}
},
"documentation":"<p>The specified resource doesn't exist.</p>",
"exception":true
},
"ResourceUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"String",
"documentation":"<p>For a <code>ResourceUnavailableException</code> error, the type of resource that isn't available.</p>"
}
},
"documentation":"<p>The specified resource isn't available.</p>",
"exception":true
},
"Rfc3339TimeString":{
"type":"string",
"max":40,
"min":20
},
"RuleTypeOption":{
"type":"string",
"enum":[
"FORWARD",
"SYSTEM",
"RECURSIVE"
]
},
"SecurityGroupIds":{
"type":"list",
"member":{"shape":"ResourceId"}
},
"ServicePrinciple":{
"type":"string",
"max":512,
"min":1
},
"ShareStatus":{
"type":"string",
"enum":[
"NOT_SHARED",
"SHARED_WITH_ME",
"SHARED_BY_ME"
]
},
"SortByKey":{
"type":"string",
"max":64,
"min":1
},
"SortOrder":{
"type":"string",
"enum":[
"ASCENDING",
"DESCENDING"
]
},
"StatusMessage":{
"type":"string",
"max":255
},
"String":{"type":"string"},
"SubnetId":{
"type":"string",
"max":32,
"min":1
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>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 <code>Key</code> might be <code>account-id</code>.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The value for the tag. For example, if <code>Key</code> is <code>account-id</code>, then <code>Value</code> might be the ID of the customer account that you're creating the resource for.</p>"
}
},
"documentation":"<p>One tag that you want to add to the specified resource. A tag consists of a <code>Key</code> (a name for the tag) and a <code>Value</code>.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>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 <code>Get</code> or <code>List</code> command: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html\">GetResolverRule</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html\">GetResolverRuleAssociation</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html\">ListResolverEndpoints</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html\">ListResolverRuleAssociations</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html\">ListResolverRules</a> </p> </li> </ul>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that you want to add to the specified resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"TargetAddress":{
"type":"structure",
"required":["Ip"],
"members":{
"Ip":{
"shape":"Ip",
"documentation":"<p>One IP address that you want to forward DNS queries to. You can specify only IPv4 addresses.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>The port at <code>Ip</code> that you want to forward DNS queries to.</p>",
"box":true
}
},
"documentation":"<p>In a <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_CreateResolverRule.html\">CreateResolverRule</a> request, an array of the IPs that you want to forward DNS queries to.</p>"
},
"TargetList":{
"type":"list",
"member":{"shape":"TargetAddress"},
"min":1
},
"ThrottlingException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The request was throttled. Try again in a few minutes.</p>",
"exception":true
},
"UnknownResourceException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified resource doesn't exist.</p>",
"exception":true
},
"Unsigned":{"type":"integer"},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>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 <code>Get</code> or <code>List</code> command: </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverEndpoint.html\">GetResolverEndpoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRule.html\">GetResolverRule</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_GetResolverRuleAssociation.html\">GetResolverRuleAssociation</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverEndpoints.html\">ListResolverEndpoints</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRuleAssociations.html\">ListResolverRuleAssociations</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/Route53/latest/APIReference/API_route53resolver_ListResolverRules.html\">ListResolverRules</a> </p> </li> </ul>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tags that you want to remove to the specified resource.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateFirewallConfigRequest":{
"type":"structure",
"required":[
"ResourceId",
"FirewallFailOpen"
],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the VPC that the configuration is for.</p>"
},
"FirewallFailOpen":{
"shape":"FirewallFailOpenStatus",
"documentation":"<p>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. </p> <ul> <li> <p>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. </p> </li> <li> <p>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. </p> </li> </ul> <p>This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association. </p>"
}
}
},
"UpdateFirewallConfigResponse":{
"type":"structure",
"members":{
"FirewallConfig":{
"shape":"FirewallConfig",
"documentation":"<p>Configuration of the firewall behavior provided by DNS Firewall for a single VPC. </p>"
}
}
},
"UpdateFirewallDomainsRequest":{
"type":"structure",
"required":[
"FirewallDomainListId",
"Operation",
"Domains"
],
"members":{
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list whose domains you want to update. </p>"
},
"Operation":{
"shape":"FirewallDomainUpdateOperation",
"documentation":"<p>What you want DNS Firewall to do with the domains that you are providing: </p> <ul> <li> <p> <code>ADD</code> - Add the domains to the ones that are already in the domain list. </p> </li> <li> <p> <code>REMOVE</code> - Search the domain list for the domains and remove them from the list.</p> </li> <li> <p> <code>REPLACE</code> - Update the domain list to exactly match the list that you are providing. </p> </li> </ul>"
},
"Domains":{
"shape":"FirewallDomains",
"documentation":"<p>A list of domains to use in the update operation.</p> <p>Each domain specification in your domain list must satisfy the following requirements: </p> <ul> <li> <p>It can optionally start with <code>*</code> (asterisk).</p> </li> <li> <p>With the exception of the optional starting asterisk, it must only contain the following characters: <code>A-Z</code>, <code>a-z</code>, <code>0-9</code>, <code>-</code> (hyphen).</p> </li> <li> <p>It must be from 1-255 characters in length. </p> </li> </ul>"
}
}
},
"UpdateFirewallDomainsResponse":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID of the firewall domain list that DNS Firewall just updated.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the domain list. </p>"
},
"Status":{
"shape":"FirewallDomainListStatus",
"documentation":"<p> </p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>Additional information about the status of the list, if available.</p>"
}
}
},
"UpdateFirewallRuleGroupAssociationRequest":{
"type":"structure",
"required":["FirewallRuleGroupAssociationId"],
"members":{
"FirewallRuleGroupAssociationId":{
"shape":"ResourceId",
"documentation":"<p>The identifier of the <a>FirewallRuleGroupAssociation</a>. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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. </p> <p>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.</p>",
"box":true
},
"MutationProtection":{
"shape":"MutationProtectionStatus",
"documentation":"<p>If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. </p>",
"box":true
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the rule group association.</p>",
"box":true
}
}
},
"UpdateFirewallRuleGroupAssociationResponse":{
"type":"structure",
"members":{
"FirewallRuleGroupAssociation":{
"shape":"FirewallRuleGroupAssociation",
"documentation":"<p>The association that you just updated. </p>"
}
}
},
"UpdateFirewallRuleRequest":{
"type":"structure",
"required":[
"FirewallRuleGroupId",
"FirewallDomainListId"
],
"members":{
"FirewallRuleGroupId":{
"shape":"ResourceId",
"documentation":"<p>The unique identifier of the firewall rule group for the rule. </p>"
},
"FirewallDomainListId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the domain list to use in the rule. </p>"
},
"Priority":{
"shape":"Priority",
"documentation":"<p>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.</p> <p>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.</p>",
"box":true
},
"Action":{
"shape":"Action",
"documentation":"<p>The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:</p> <ul> <li> <p> <code>ALLOW</code> - Permit the request to go through.</p> </li> <li> <p> <code>ALERT</code> - Permit the request to go through but send an alert to the logs.</p> </li> <li> <p> <code>BLOCK</code> - Disallow the request. This option requires additional details in the rule's <code>BlockResponse</code>. </p> </li> </ul>",
"box":true
},
"BlockResponse":{
"shape":"BlockResponse",
"documentation":"<p>The way that you want DNS Firewall to block the request. Used for the rule action setting <code>BLOCK</code>.</p> <ul> <li> <p> <code>NODATA</code> - Respond indicating that the query was successful, but no response is available for it.</p> </li> <li> <p> <code>NXDOMAIN</code> - Respond indicating that the domain name that's in the query doesn't exist.</p> </li> <li> <p> <code>OVERRIDE</code> - Provide a custom override in the response. This option requires custom handling details in the rule's <code>BlockOverride*</code> settings. </p> </li> </ul>",
"box":true
},
"BlockOverrideDomain":{
"shape":"BlockOverrideDomain",
"documentation":"<p>The custom DNS record to send back in response to the query. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>",
"box":true
},
"BlockOverrideDnsType":{
"shape":"BlockOverrideDnsType",
"documentation":"<p>The DNS record's type. This determines the format of the record value that you provided in <code>BlockOverrideDomain</code>. Used for the rule action <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>",
"box":true
},
"BlockOverrideTtl":{
"shape":"BlockOverrideTtl",
"documentation":"<p>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 <code>BLOCK</code> with a <code>BlockResponse</code> setting of <code>OVERRIDE</code>.</p>",
"box":true
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the rule.</p>",
"box":true
}
}
},
"UpdateFirewallRuleResponse":{
"type":"structure",
"members":{
"FirewallRule":{
"shape":"FirewallRule",
"documentation":"<p>The firewall rule that you just updated. </p>"
}
}
},
"UpdateResolverConfigRequest":{
"type":"structure",
"required":[
"ResourceId",
"AutodefinedReverseFlag"
],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>Resource ID of the Amazon VPC that you want to update the Resolver configuration for.</p>"
},
"AutodefinedReverseFlag":{
"shape":"AutodefinedReverseFlag",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-classiclink.html\">ClassicLink</a> in the <i>Amazon EC2 guide</i>.</p> <note> <p>It can take some time for the status change to be completed.</p> </note> <p/>"
}
}
},
"UpdateResolverConfigResponse":{
"type":"structure",
"members":{
"ResolverConfig":{
"shape":"ResolverConfig",
"documentation":"<p>An array that contains settings for the specified Resolver configuration.</p>"
}
}
},
"UpdateResolverDnssecConfigRequest":{
"type":"structure",
"required":[
"ResourceId",
"Validation"
],
"members":{
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for.</p>"
},
"Validation":{
"shape":"Validation",
"documentation":"<p>The new value that you are specifying for DNSSEC validation for the VPC. The value can be <code>ENABLE</code> or <code>DISABLE</code>. Be aware that it can take time for a validation status change to be completed.</p>"
}
}
},
"UpdateResolverDnssecConfigResponse":{
"type":"structure",
"members":{
"ResolverDNSSECConfig":{
"shape":"ResolverDnssecConfig",
"documentation":"<p>A complex type that contains settings for the specified DNSSEC configuration.</p>"
}
}
},
"UpdateResolverEndpointRequest":{
"type":"structure",
"required":["ResolverEndpointId"],
"members":{
"ResolverEndpointId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver endpoint that you want to update.</p>"
},
"Name":{
"shape":"Name",
"documentation":"<p>The name of the Resolver endpoint that you want to update.</p>",
"box":true
}
}
},
"UpdateResolverEndpointResponse":{
"type":"structure",
"members":{
"ResolverEndpoint":{
"shape":"ResolverEndpoint",
"documentation":"<p>The response to an <code>UpdateResolverEndpoint</code> request.</p>"
}
}
},
"UpdateResolverRuleRequest":{
"type":"structure",
"required":[
"ResolverRuleId",
"Config"
],
"members":{
"ResolverRuleId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the Resolver rule that you want to update.</p>"
},
"Config":{
"shape":"ResolverRuleConfig",
"documentation":"<p>The new settings for the Resolver rule.</p>"
}
}
},
"UpdateResolverRuleResponse":{
"type":"structure",
"members":{
"ResolverRule":{
"shape":"ResolverRule",
"documentation":"<p>The response to an <code>UpdateResolverRule</code> request.</p>"
}
}
},
"Validation":{
"type":"string",
"enum":[
"ENABLE",
"DISABLE"
]
},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ExceptionMessage"}
},
"documentation":"<p/>",
"exception":true
}
},
"documentation":"<p>When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver. By default, Resolver answers DNS queries for VPC domain names such as domain names for EC2 instances or Elastic Load Balancing load balancers. Resolver performs recursive lookups against public name servers for all other domain names.</p> <p>You can also configure DNS resolution between your VPC and your network over a Direct Connect or VPN connection:</p> <p> <b>Forward DNS queries from resolvers on your network to Route 53 Resolver</b> </p> <p>DNS resolvers on your network can forward DNS queries to Resolver in a specified VPC. This allows your DNS resolvers to easily resolve domain names for Amazon Web Services resources such as EC2 instances or records in a Route 53 private hosted zone. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-network-to-vpc\">How DNS Resolvers on Your Network Forward DNS Queries to Route 53 Resolver</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p> <b>Conditionally forward queries from a VPC to resolvers on your network</b> </p> <p>You can configure Resolver to forward queries that it receives from EC2 instances in your VPCs to DNS resolvers on your network. To forward selected queries, you create Resolver rules that specify the domain names for the DNS queries that you want to forward (such as example.com), and the IP addresses of the DNS resolvers on your network that you want to forward the queries to. If a query matches multiple rules (example.com, acme.example.com), Resolver chooses the rule with the most specific match (acme.example.com) and forwards the query to the IP addresses that you specified in that rule. For more information, see <a href=\"https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/resolver.html#resolver-overview-forward-vpc-to-network\">How Route 53 Resolver Forwards DNS Queries from Your VPCs to Your Network</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>Like Amazon VPC, Resolver is Regional. In each Region where you have VPCs, you can choose whether to forward queries from your VPCs to your network (outbound queries), from your network to your VPCs (inbound queries), or both.</p>"
}