openapi: 3.2.0
info:
version: '2018-04-01'
x-release: v4
title: Amazon Route 53 Resolver API
description: When you create a VPC using Amazon VPC, you automatically get DNS resolution within the VPC from Route 53 Resolver.
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: route53resolver
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/route53resolver-2018-04-01.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://route53resolver.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Route53Resolver multi-region endpoint
- url: https://route53resolver.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Route53Resolver multi-region endpoint
- url: http://route53resolver.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Route53Resolver endpoint for China (Beijing) and China (Ningxia)
- url: https://route53resolver.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Route53Resolver endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Amazon Route 53 Resolver
paths:
/#X-Amz-Target=Route53Resolver.AssociateFirewallRuleGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateFirewallRuleGroup
description: Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateFirewallRuleGroupResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateFirewallRuleGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.AssociateFirewallRuleGroup
tags:
- Amazon Route 53 Resolver
summary: Associate firewall rule group
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.AssociateResolverEndpointIpAddress:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateResolverEndpointIpAddress
description: 'Adds IP addresses to an inbound or an outbound Resolver endpoint. If you want to add more than one IP address, submit one AssociateResolverEndpointIpAddress request for each IP address.
To remove an IP address from an endpoint, see DisassociateResolverEndpointIpAddress.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateResolverEndpointIpAddressResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateResolverEndpointIpAddressRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.AssociateResolverEndpointIpAddress
tags:
- Amazon Route 53 Resolver
summary: Associate resolver endpoint ip address
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.AssociateResolverQueryLogConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateResolverQueryLogConfig
description: '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 AssociateResolverQueryLogConfig request for each VPC.
The VPCs that you associate with a query logging configuration must be in the same Region as the configuration.
To remove a VPC from a query logging configuration, see DisassociateResolverQueryLogConfig.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateResolverQueryLogConfigResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'487':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateResolverQueryLogConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.AssociateResolverQueryLogConfig
tags:
- Amazon Route 53 Resolver
summary: Associate resolver query log config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.AssociateResolverRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: AssociateResolverRule
description: 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 CreateResolverRule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateResolverRuleResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'484':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'485':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'486':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'487':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AssociateResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.AssociateResolverRule
tags:
- Amazon Route 53 Resolver
summary: Associate resolver rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.CreateFirewallDomainList:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateFirewallDomainList
description: 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 ImportFirewallDomains, or with domain strings, using UpdateFirewallDomains.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFirewallDomainListResponse'
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFirewallDomainListRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.CreateFirewallDomainList
tags:
- Amazon Route 53 Resolver
summary: Create firewall domain list
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.CreateFirewallRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateFirewallRule
description: Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFirewallRuleResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFirewallRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.CreateFirewallRule
tags:
- Amazon Route 53 Resolver
summary: Create firewall rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.CreateFirewallRuleGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateFirewallRuleGroup
description: 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 CreateFirewallRule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFirewallRuleGroupResponse'
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateFirewallRuleGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.CreateFirewallRuleGroup
tags:
- Amazon Route 53 Resolver
summary: Create firewall rule group
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.CreateResolverEndpoint:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateResolverEndpoint
description: 'Creates a Resolver endpoint. There are two types of Resolver endpoints, inbound and outbound:
An inbound Resolver endpoint forwards DNS queries to the DNS service for a VPC from your network.
An outbound Resolver endpoint forwards DNS queries from the DNS service for a VPC to your network.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResolverEndpointResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResolverEndpointRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.CreateResolverEndpoint
tags:
- Amazon Route 53 Resolver
summary: Create resolver endpoint
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.CreateResolverQueryLogConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateResolverQueryLogConfig
description: '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.
To specify which VPCs you want to log queries for, you use AssociateResolverQueryLogConfig. For more information, see AssociateResolverQueryLogConfig.
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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResolverQueryLogConfigResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'487':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResolverQueryLogConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.CreateResolverQueryLogConfig
tags:
- Amazon Route 53 Resolver
summary: Create resolver query log config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.CreateResolverRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: CreateResolverRule
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResolverRuleResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'484':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'485':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'486':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'487':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.CreateResolverRule
tags:
- Amazon Route 53 Resolver
summary: Create resolver rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DeleteFirewallDomainList:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteFirewallDomainList
description: Deletes the specified domain list.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFirewallDomainListResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFirewallDomainListRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DeleteFirewallDomainList
tags:
- Amazon Route 53 Resolver
summary: Delete firewall domain list
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DeleteFirewallRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteFirewallRule
description: Deletes the specified firewall rule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFirewallRuleResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFirewallRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DeleteFirewallRule
tags:
- Amazon Route 53 Resolver
summary: Delete firewall rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DeleteFirewallRuleGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteFirewallRuleGroup
description: Deletes the specified firewall rule group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFirewallRuleGroupResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'482':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteFirewallRuleGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DeleteFirewallRuleGroup
tags:
- Amazon Route 53 Resolver
summary: Delete firewall rule group
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DeleteResolverEndpoint:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteResolverEndpoint
description: 'Deletes a Resolver endpoint. The effect of deleting a Resolver endpoint depends on whether it''s an inbound or an outbound Resolver endpoint:
Inbound: DNS queries from your network are no longer routed to the DNS service for the specified VPC.
Outbound: DNS queries from a VPC are no longer routed to your network.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResolverEndpointResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResolverEndpointRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DeleteResolverEndpoint
tags:
- Amazon Route 53 Resolver
summary: Delete resolver endpoint
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DeleteResolverQueryLogConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteResolverQueryLogConfig
description: '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.
Before you can delete a query logging configuration, you must first disassociate all VPCs from the configuration. See DisassociateResolverQueryLogConfig.
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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResolverQueryLogConfigResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResolverQueryLogConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DeleteResolverQueryLogConfig
tags:
- Amazon Route 53 Resolver
summary: Delete resolver query log config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DeleteResolverRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DeleteResolverRule
description: 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 DisassociateResolverRule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResolverRuleResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DeleteResolverRule
tags:
- Amazon Route 53 Resolver
summary: Delete resolver rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DisassociateFirewallRuleGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisassociateFirewallRuleGroup
description: Disassociates a FirewallRuleGroup from a VPC, to remove DNS filtering from the VPC.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateFirewallRuleGroupResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateFirewallRuleGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DisassociateFirewallRuleGroup
tags:
- Amazon Route 53 Resolver
summary: Disassociate firewall rule group
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DisassociateResolverEndpointIpAddress:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisassociateResolverEndpointIpAddress
description: 'Removes IP addresses from an inbound or an outbound Resolver endpoint. If you want to remove more than one IP address, submit one DisassociateResolverEndpointIpAddress request for each IP address.
To add an IP address to an endpoint, see AssociateResolverEndpointIpAddress.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateResolverEndpointIpAddressResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceExistsException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateResolverEndpointIpAddressRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DisassociateResolverEndpointIpAddress
tags:
- Amazon Route 53 Resolver
summary: Disassociate resolver endpoint ip address
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DisassociateResolverQueryLogConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisassociateResolverQueryLogConfig
description: 'Disassociates a VPC from a query logging configuration.
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:
The accounts that you shared the configuration with can disassociate VPCs from the configuration.
You can stop sharing the configuration.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateResolverQueryLogConfigResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateResolverQueryLogConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DisassociateResolverQueryLogConfig
tags:
- Amazon Route 53 Resolver
summary: Disassociate resolver query log config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.DisassociateResolverRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: DisassociateResolverRule
description: 'Removes the association between a specified Resolver rule and a specified VPC.
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.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateResolverRuleResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DisassociateResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.DisassociateResolverRule
tags:
- Amazon Route 53 Resolver
summary: Disassociate resolver rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetFirewallConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetFirewallConfig
description: Retrieves the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallConfigResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetFirewallConfig
tags:
- Amazon Route 53 Resolver
summary: Get firewall config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetFirewallDomainList:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetFirewallDomainList
description: Retrieves the specified firewall domain list.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallDomainListResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallDomainListRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetFirewallDomainList
tags:
- Amazon Route 53 Resolver
summary: Get firewall domain list
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetFirewallRuleGroup:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetFirewallRuleGroup
description: Retrieves the specified firewall rule group.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallRuleGroupResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallRuleGroupRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetFirewallRuleGroup
tags:
- Amazon Route 53 Resolver
summary: Get firewall rule group
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetFirewallRuleGroupAssociation:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetFirewallRuleGroupAssociation
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallRuleGroupAssociationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallRuleGroupAssociationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetFirewallRuleGroupAssociation
tags:
- Amazon Route 53 Resolver
summary: Get firewall rule group association
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetFirewallRuleGroupPolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetFirewallRuleGroupPolicy
description: 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).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallRuleGroupPolicyResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetFirewallRuleGroupPolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetFirewallRuleGroupPolicy
tags:
- Amazon Route 53 Resolver
summary: Get firewall rule group policy
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverConfig
description: Retrieves the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverConfigResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'485':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverConfig
tags:
- Amazon Route 53 Resolver
summary: Get resolver config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverDnssecConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverDnssecConfig
description: Gets DNSSEC validation information for a specified resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverDnssecConfigResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverDnssecConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverDnssecConfig
tags:
- Amazon Route 53 Resolver
summary: Get resolver dnssec config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverEndpoint:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverEndpoint
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverEndpointResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverEndpointRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverEndpoint
tags:
- Amazon Route 53 Resolver
summary: Get resolver endpoint
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverQueryLogConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverQueryLogConfig
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverQueryLogConfigResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverQueryLogConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverQueryLogConfig
tags:
- Amazon Route 53 Resolver
summary: Get resolver query log config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverQueryLogConfigAssociation:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverQueryLogConfigAssociation
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverQueryLogConfigAssociationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverQueryLogConfigAssociationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverQueryLogConfigAssociation
tags:
- Amazon Route 53 Resolver
summary: Get resolver query log config association
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverQueryLogConfigPolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverQueryLogConfigPolicy
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverQueryLogConfigPolicyResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: UnknownResourceException
content:
application/json:
schema:
$ref: '#/components/schemas/UnknownResourceException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverQueryLogConfigPolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverQueryLogConfigPolicy
tags:
- Amazon Route 53 Resolver
summary: Get resolver query log config policy
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverRule
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverRuleResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverRule
tags:
- Amazon Route 53 Resolver
summary: Get resolver rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverRuleAssociation:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverRuleAssociation
description: Gets information about an association between a specified Resolver rule and a VPC. You associate a Resolver rule and a VPC using AssociateResolverRule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverRuleAssociationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverRuleAssociationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverRuleAssociation
tags:
- Amazon Route 53 Resolver
summary: Get resolver rule association
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.GetResolverRulePolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: GetResolverRulePolicy
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverRulePolicyResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: UnknownResourceException
content:
application/json:
schema:
$ref: '#/components/schemas/UnknownResourceException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/GetResolverRulePolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.GetResolverRulePolicy
tags:
- Amazon Route 53 Resolver
summary: Get resolver rule policy
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ImportFirewallDomains:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ImportFirewallDomains
description: 'Imports domain names from a file into a domain list, for use in a DNS firewall rule group.
Each domain specification in your domain list must satisfy the following requirements:
It can optionally start with * (asterisk).
With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ImportFirewallDomainsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ImportFirewallDomainsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ImportFirewallDomains
tags:
- Amazon Route 53 Resolver
summary: Import firewall domains
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListFirewallConfigs:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListFirewallConfigs
description: 'Retrieves the firewall configurations that you have defined. DNS Firewall uses the configurations to manage firewall behavior for your VPCs.
A single call might return only a partial list of the configurations. For information, see MaxResults.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallConfigsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallConfigsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListFirewallConfigs
tags:
- Amazon Route 53 Resolver
summary: List firewall configs
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListFirewallDomainLists:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListFirewallDomainLists
description: '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 ListFirewallDomains.
A single call to this list operation might return only a partial list of the domain lists. For information, see MaxResults.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallDomainListsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallDomainListsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListFirewallDomainLists
tags:
- Amazon Route 53 Resolver
summary: List firewall domain lists
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListFirewallDomains:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListFirewallDomains
description: 'Retrieves the domains that you have defined for the specified firewall domain list.
A single call might return only a partial list of the domains. For information, see MaxResults.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallDomainsResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallDomainsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListFirewallDomains
tags:
- Amazon Route 53 Resolver
summary: List firewall domains
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListFirewallRuleGroupAssociations:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListFirewallRuleGroupAssociations
description: 'Retrieves the firewall rule group associations that you have defined. Each association enables DNS filtering for a VPC with one rule group.
A single call might return only a partial list of the associations. For information, see MaxResults.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallRuleGroupAssociationsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallRuleGroupAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListFirewallRuleGroupAssociations
tags:
- Amazon Route 53 Resolver
summary: List firewall rule group associations
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListFirewallRuleGroups:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListFirewallRuleGroups
description: 'Retrieves the minimal high-level information for the rule groups that you have defined.
A single call might return only a partial list of the rule groups. For information, see MaxResults.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallRuleGroupsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallRuleGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListFirewallRuleGroups
tags:
- Amazon Route 53 Resolver
summary: List firewall rule groups
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListFirewallRules:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListFirewallRules
description: 'Retrieves the firewall rules that you have defined for the specified firewall rule group. DNS Firewall uses the rules in a rule group to filter DNS network traffic for a VPC.
A single call might return only a partial list of the rules. For information, see MaxResults.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallRulesResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListFirewallRulesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListFirewallRules
tags:
- Amazon Route 53 Resolver
summary: List firewall rules
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverConfigs:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverConfigs
description: Retrieves the Resolver configurations that you have defined. Route 53 Resolver uses the configurations to manage DNS resolution behavior for your VPCs.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverConfigsResponse'
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'486':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverConfigsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverConfigs
tags:
- Amazon Route 53 Resolver
summary: List resolver configs
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverDnssecConfigs:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverDnssecConfigs
description: Lists the configurations for DNSSEC validation that are associated with the current Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverDnssecConfigsResponse'
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverDnssecConfigsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverDnssecConfigs
tags:
- Amazon Route 53 Resolver
summary: List resolver dnssec configs
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverEndpointIpAddresses:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverEndpointIpAddresses
description: Gets the IP addresses for a specified Resolver endpoint.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverEndpointIpAddressesResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'483':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverEndpointIpAddressesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverEndpointIpAddresses
tags:
- Amazon Route 53 Resolver
summary: List resolver endpoint ip addresses
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverEndpoints:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverEndpoints
description: Lists all the Resolver endpoints that were created using the current Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverEndpointsResponse'
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverEndpointsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverEndpoints
tags:
- Amazon Route 53 Resolver
summary: List resolver endpoints
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverQueryLogConfigAssociations:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverQueryLogConfigAssociations
description: Lists information about associations between Amazon VPCs and query logging configurations.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverQueryLogConfigAssociationsResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverQueryLogConfigAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverQueryLogConfigAssociations
tags:
- Amazon Route 53 Resolver
summary: List resolver query log config associations
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverQueryLogConfigs:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverQueryLogConfigs
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverQueryLogConfigsResponse'
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverQueryLogConfigsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverQueryLogConfigs
tags:
- Amazon Route 53 Resolver
summary: List resolver query log configs
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverRuleAssociations:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverRuleAssociations
description: Lists the associations that were created between Resolver rules and VPCs using the current Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverRuleAssociationsResponse'
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverRuleAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverRuleAssociations
tags:
- Amazon Route 53 Resolver
summary: List resolver rule associations
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListResolverRules:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListResolverRules
description: Lists the Resolver rules that were created using the current Amazon Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverRulesResponse'
'480':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'481':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListResolverRulesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListResolverRules
tags:
- Amazon Route 53 Resolver
summary: List resolver rules
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.ListTagsForResource:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: ListTagsForResource
description: Lists the tags that you associated with the specified resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidNextTokenException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'483':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListTagsForResourceRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.ListTagsForResource
tags:
- Amazon Route 53 Resolver
summary: List tags for resource
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.PutFirewallRuleGroupPolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: PutFirewallRuleGroupPolicy
description: 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).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutFirewallRuleGroupPolicyResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutFirewallRuleGroupPolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.PutFirewallRuleGroupPolicy
tags:
- Amazon Route 53 Resolver
summary: Put firewall rule group policy
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.PutResolverQueryLogConfigPolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: PutResolverQueryLogConfigPolicy
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResolverQueryLogConfigPolicyResponse'
'480':
description: InvalidPolicyDocument
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidPolicyDocument'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: UnknownResourceException
content:
application/json:
schema:
$ref: '#/components/schemas/UnknownResourceException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutResolverQueryLogConfigPolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.PutResolverQueryLogConfigPolicy
tags:
- Amazon Route 53 Resolver
summary: Put resolver query log config policy
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.PutResolverRulePolicy:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: PutResolverRulePolicy
description: 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PutResolverRulePolicyResponse'
'480':
description: InvalidPolicyDocument
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidPolicyDocument'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: UnknownResourceException
content:
application/json:
schema:
$ref: '#/components/schemas/UnknownResourceException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PutResolverRulePolicyRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.PutResolverRulePolicy
tags:
- Amazon Route 53 Resolver
summary: Put resolver rule policy
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.TagResource:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: TagResource
description: Adds one or more tags to a specified resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceResponse'
'480':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'483':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'484':
description: InvalidTagException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidTagException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TagResourceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.TagResource
tags:
- Amazon Route 53 Resolver
summary: Tag resource
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UntagResource:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UntagResource
description: Removes one or more tags from a specified resource.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UntagResourceRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UntagResource
tags:
- Amazon Route 53 Resolver
summary: Untag resource
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateFirewallConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateFirewallConfig
description: Updates the configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC).
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallConfigResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateFirewallConfig
tags:
- Amazon Route 53 Resolver
summary: Update firewall config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateFirewallDomains:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateFirewallDomains
description: Updates the firewall domain list from an array of domain specifications.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallDomainsResponse'
'480':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'481':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'484':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallDomainsRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateFirewallDomains
tags:
- Amazon Route 53 Resolver
summary: Update firewall domains
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateFirewallRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateFirewallRule
description: Updates the specified firewall rule.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallRuleResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateFirewallRule
tags:
- Amazon Route 53 Resolver
summary: Update firewall rule
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateFirewallRuleGroupAssociation:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateFirewallRuleGroupAssociation
description: Changes the association of a FirewallRuleGroup with a VPC. The association enables DNS filtering for the VPC.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallRuleGroupAssociationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
'482':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'483':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'484':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'485':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFirewallRuleGroupAssociationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateFirewallRuleGroupAssociation
tags:
- Amazon Route 53 Resolver
summary: Update firewall rule group association
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateResolverConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateResolverConfig
description: Updates the behavior configuration of Route 53 Resolver behavior for a single VPC from Amazon Virtual Private Cloud.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverConfigResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'487':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'488':
description: ValidationException
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateResolverConfig
tags:
- Amazon Route 53 Resolver
summary: Update resolver config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateResolverDnssecConfig:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateResolverDnssecConfig
description: Updates an existing DNSSEC validation configuration. If there is no existing DNSSEC validation configuration, one is created.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverDnssecConfigResponse'
'480':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
'485':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverDnssecConfigRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateResolverDnssecConfig
tags:
- Amazon Route 53 Resolver
summary: Update resolver dnssec config
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateResolverEndpoint:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateResolverEndpoint
description: Updates the name, or enpoint type for an inbound or an outbound Resolver endpoint. You can only update between IPV4 and DUALSTACK, IPV6 endpoint type can't be updated to other type.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverEndpointResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'483':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'484':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverEndpointRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateResolverEndpoint
tags:
- Amazon Route 53 Resolver
summary: Update resolver endpoint
x-summary-source: derived
/#X-Amz-Target=Route53Resolver.UpdateResolverRule:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateResolverRule
description: Updates settings for a specified Resolver rule. ResolverRuleId is required, and all other parameters are optional. If you don't specify a parameter, it retains its current value.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverRuleResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InvalidParameterException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'483':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'484':
description: LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'485':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'486':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateResolverRuleRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- Route53Resolver.UpdateResolverRule
tags:
- Amazon Route 53 Resolver
summary: Update resolver rule
x-summary-source: derived
components:
schemas:
FirewallRules:
type: array
items:
$ref: '#/components/schemas/FirewallRule'
ListResolverRulesResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If more than MaxResults Resolver rules match the specified criteria, you can submit another ListResolverRules request to get the next group of results. In the next request, specify the value of NextToken from the previous response. '
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The value that you specified for MaxResults in the request.
ResolverRules:
allOf:
- $ref: '#/components/schemas/ResolverRules'
- description: The Resolver rules that were created using the current Amazon Web Services account and that match the specified filters, if any.
GetResolverRuleRequest:
type: object
required:
- ResolverRuleId
title: GetResolverRuleRequest
properties:
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to get information about.
ValidationException: {}
DisassociateResolverRuleRequest:
type: object
required:
- VPCId
- ResolverRuleId
title: DisassociateResolverRuleRequest
properties:
VPCId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC that you want to disassociate the Resolver rule from.
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you want to disassociate from the specified VPC.
ResolverQueryLogConfig:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID for the query logging configuration.
OwnerId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: 'The Amazon Web Services account ID for the account that created the query logging configuration. '
Status:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigStatus'
- description: '
The status of the specified query logging configuration. Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver can''t deliver logs to the location that is specified in the query logging configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don''t allow sending logs to the destination.
CreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
description: In the response to a CreateResolverQueryLogConfig, DeleteResolverQueryLogConfig, GetResolverQueryLogConfig, or ListResolverQueryLogConfigs request, a complex type that contains settings for one query logging configuration.
GetResolverConfigRequest:
type: object
required:
- ResourceId
title: GetResolverConfigRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: Resource ID of the Amazon VPC that you want to get information about.
Rfc3339TimeString:
type: string
minLength: 20
maxLength: 40
FirewallRuleGroupPolicy:
type: string
maxLength: 30000
GetFirewallRuleGroupPolicyRequest:
type: object
required:
- Arn
title: GetFirewallRuleGroupPolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) for the rule group.
FirewallRuleGroupMetadata:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the rule group. '
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) of the rule group.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the rule group.
OwnerId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: '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. '
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: '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. '
ShareStatus:
allOf:
- $ref: '#/components/schemas/ShareStatus'
- description: 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).
description: Minimal high-level information for a firewall rule group. The action ListFirewallRuleGroups returns an array of these objects.
To retrieve full information for a firewall rule group, call GetFirewallRuleGroup and ListFirewallRules.
InternalServiceErrorException: {} FirewallDomains: type: array items: $ref: '#/components/schemas/FirewallDomainName' UntagResourceRequest: type: object required: - ResourceArn - TagKeys title: UntagResourceRequest properties: ResourceArn: allOf: - $ref: '#/components/schemas/Arn' - description: 'The Amazon Resource Name (ARN) for the resource that you want to remove tags from. To get the ARN for a resource, use the applicable Get or List command:
AssociateResolverEndpointIpAddress request.
ResolverQueryLogConfigAssociationError:
type: string
enum:
- NONE
- DESTINATION_NOT_FOUND
- ACCESS_DENIED
- INTERNAL_SERVICE_ERROR
TargetAddress:
type: object
properties:
Ip:
allOf:
- $ref: '#/components/schemas/Ip'
- description: One IPv4 address that you want to forward DNS queries to.
Port:
allOf:
- $ref: '#/components/schemas/Port'
- description: The port at Ip that you want to forward DNS queries to.
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' One IPv6 address that you want to forward DNS queries to. '
description: In a CreateResolverRule request, an array of the IPs that you want to forward DNS queries to.
FilterValues:
type: array
items:
$ref: '#/components/schemas/FilterValue'
CreateResolverEndpointResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: Information about the CreateResolverEndpoint request, including the status of the request.
Boolean:
type: boolean
GetResolverDnssecConfigResponse:
type: object
properties:
ResolverDNSSECConfig:
allOf:
- $ref: '#/components/schemas/ResolverDnssecConfig'
- description: The information about a configuration for DNSSEC validation.
ResolverQueryLogConfigAssociationStatus:
type: string
enum:
- CREATING
- ACTIVE
- ACTION_NEEDED
- DELETING
- FAILED
UpdateResolverDnssecConfigRequest:
type: object
required:
- ResourceId
- Validation
title: UpdateResolverDnssecConfigRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the virtual private cloud (VPC) that you're updating the DNSSEC validation status for.
Validation:
allOf:
- $ref: '#/components/schemas/Validation'
- description: The new value that you are specifying for DNSSEC validation for the VPC. The value can be ENABLE or DISABLE. Be aware that it can take time for a validation status change to be completed.
ServicePrinciple:
type: string
minLength: 1
maxLength: 512
TagResourceRequest:
type: object
required:
- ResourceArn
- Tags
title: TagResourceRequest
properties:
ResourceArn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: 'The Amazon Resource Name (ARN) for the resource that you want to add tags to. To get the ARN for a resource, use the applicable Get or List command:
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:
S3 bucket:
arn:aws:s3:::examplebucket
You can optionally append a file prefix to the end of the ARN.
arn:aws:s3:::examplebucket/development/
CloudWatch Logs log group:
arn:aws:logs:us-west-1:123456789012:log-group:/mystack-testgroup-12ABC1AB12A1:*
Kinesis Data Firehose delivery stream:
arn:aws:kinesis:us-east-2:0123456789:stream/my_stream_name
CreatorRequestId can be any unique string, for example, a date/time stamp. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of the tag keys and values that you want to associate with the query logging configuration.
ResolverRules:
type: array
items:
$ref: '#/components/schemas/ResolverRule'
IpAddressResponse:
type: object
properties:
IpId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of one IP address.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of one subnet.
Ip:
allOf:
- $ref: '#/components/schemas/Ip'
- description: One IPv4 address that the Resolver endpoint uses for DNS queries.
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' One IPv6 address that the Resolver endpoint uses for DNS queries. '
Status:
allOf:
- $ref: '#/components/schemas/IpAddressStatus'
- description: A status code that gives the current status of the request.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A message that provides additional information about the status of the request.
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the IP address was created, in Unix time format and Coordinated Universal Time (UTC).
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the IP address was last modified, in Unix time format and Coordinated Universal Time (UTC).
description: In the response to a GetResolverEndpoint request, information about the IP addresses that the Resolver endpoint uses for DNS queries.
FirewallRuleGroup:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the rule group. '
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) of the rule group.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the rule group.
RuleCount:
allOf:
- $ref: '#/components/schemas/Unsigned'
- description: The number of rules in the rule group.
Status:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupStatus'
- description: 'The status of the domain list. '
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the rule group, if available.
OwnerId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: '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. '
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: '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. '
ShareStatus:
allOf:
- $ref: '#/components/schemas/ShareStatus'
- description: 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).
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC). '
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).
description: 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 ListFirewallRules.
TagValue:
type: string
minLength: 0
maxLength: 256
AccountId:
type: string
minLength: 12
maxLength: 32
UpdateIpAddress:
type: object
required:
- IpId
- Ipv6
properties:
IpId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: ' The ID of the IP address, specified by the ResolverEndpointId. '
Ipv6:
allOf:
- $ref: '#/components/schemas/Ipv6'
- description: ' The IPv6 address that you want to use for DNS queries. '
description: ' Provides information about the IP address type in response to UpdateResolverEndpoint. '
GetFirewallRuleGroupRequest:
type: object
required:
- FirewallRuleGroupId
title: GetFirewallRuleGroupRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group. '
UpdateFirewallRuleRequest:
type: object
required:
- FirewallRuleGroupId
- FirewallDomainListId
title: UpdateFirewallRuleRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group for the rule. '
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list to use in the rule. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Action: allOf: - $ref: '#/components/schemas/Action' - description:The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.
BLOCK with a BlockResponse setting of OVERRIDE.
BlockOverrideDnsType:
allOf:
- $ref: '#/components/schemas/BlockOverrideDnsType'
- description: The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
BlockOverrideTtl:
allOf:
- $ref: '#/components/schemas/BlockOverrideTtl'
- description: The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of the rule.
CreateResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfig:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfig'
- description: Information about the CreateResolverQueryLogConfig request, including the status of the request.
FirewallConfig:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the firewall configuration.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC that this firewall configuration applies to.
OwnerId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The Amazon Web Services account ID of the owner of the VPC that this firewall configuration applies to.
FirewallFailOpen:
allOf:
- $ref: '#/components/schemas/FirewallFailOpenStatus'
- description: Determines how DNS Firewall operates during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall returns a failure error when it is unable to properly evaluate a query.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.
description: 'Configuration of the firewall behavior provided by DNS Firewall for a single VPC from Amazon Virtual Private Cloud (Amazon VPC). ' FirewallRuleGroupAssociation: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: The identifier for the association. Arn: allOf: - $ref: '#/components/schemas/Arn' - description: The Amazon Resource Name (ARN) of the firewall rule group association. FirewallRuleGroupId: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The unique identifier of the firewall rule group. ' VpcId: allOf: - $ref: '#/components/schemas/ResourceId' - description: 'The unique identifier of the VPC that is associated with the rule group. ' Name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the association. Priority: allOf: - $ref: '#/components/schemas/Priority' - description: '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. ' MutationProtection: allOf: - $ref: '#/components/schemas/MutationProtectionStatus' - description: 'If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. ' ManagedOwnerName: allOf: - $ref: '#/components/schemas/ServicePrinciple' - description: 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. Status: allOf: - $ref: '#/components/schemas/FirewallRuleGroupAssociationStatus' - description: The current status of the association. StatusMessage: allOf: - $ref: '#/components/schemas/StatusMessage' - description: Additional information about the status of the response, if available. CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: '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. ' CreationTime: allOf: - $ref: '#/components/schemas/Rfc3339TimeString' - description: 'The date and time that the association was created, in Unix time format and Coordinated Universal Time (UTC). ' ModificationTime: allOf: - $ref: '#/components/schemas/Rfc3339TimeString' - description: The date and time that the association was last modified, in Unix time format and Coordinated Universal Time (UTC). description: 'An association between a firewall rule group and a VPC, which enables DNS filtering for the VPC. ' ListResolverQueryLogConfigsRequest: type: object title: ListResolverQueryLogConfigsRequest properties: MaxResults: allOf: - $ref: '#/components/schemas/MaxResults' - description: 'The maximum number of query logging configurations that you want to return in the response to aListResolverQueryLogConfigs request. If you don''t specify a value for MaxResults, Resolver returns up to 100 query logging configurations. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverQueryLogConfigs request, omit this value.
If there are more than MaxResults query logging configurations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of query logging configurations.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
The element that you want Resolver to sort query logging configurations by.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.
Valid values include the following elements:
Arn: The ARN of the query logging configuration
AssociationCount: The number of VPCs that are associated with the specified configuration
CreationTime: The date and time that Resolver returned when the configuration was created
CreatorRequestId: The value that was specified for CreatorRequestId when the configuration was created
DestinationArn: The location that logs are sent to
Id: The ID of the configuration
Name: The name of the configuration
OwnerId: The Amazon Web Services account number of the account that created the configuration
ShareStatus: Whether the configuration is shared with other Amazon Web Services accounts or shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).
Status: The current status of the configuration. Valid values include the following:
CREATING: Resolver is creating the query logging configuration.
CREATED: The query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging configuration.
FAILED: Resolver either couldn''t create or couldn''t delete the query logging configuration. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don''t allow sending logs to the destination.
If you specified a value for SortBy, the order that you want query logging configurations to be listed in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigs request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.
The way that you want DNS Firewall to block the request. Used for the rule action setting BLOCK.
NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.
BLOCK with a BlockResponse setting of OVERRIDE.
BlockOverrideDnsType:
allOf:
- $ref: '#/components/schemas/BlockOverrideDnsType'
- description: The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
BlockOverrideTtl:
allOf:
- $ref: '#/components/schemas/Unsigned'
- description: The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of executing the operation twice. This can be any unique string, for example, a timestamp. '
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the rule was created, in Unix time format and Coordinated Universal Time (UTC). '
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the rule was last modified, in Unix time format and Coordinated Universal Time (UTC).
description: A single firewall rule in a rule group.
ResolverQueryLogConfigAssociationErrorMessage:
type: string
PutFirewallRuleGroupPolicyRequest:
type: object
required:
- Arn
- FirewallRuleGroupPolicy
title: PutFirewallRuleGroupPolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) for the rule group that you want to share.
FirewallRuleGroupPolicy:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupPolicy'
- description: The Identity and Access Management (Amazon Web Services IAM) policy to attach to the rule group.
ResolverRule:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID that Resolver assigned to the Resolver rule when you created it.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that you specified when you created the Resolver rule. CreatorRequestId identifies the request and allows failed requests to be retried without the risk of running the operation twice. '
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) for the Resolver rule specified by Id.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: DNS queries for this domain name are forwarded to the IP addresses that are specified in TargetIps. If a query matches multiple Resolver rules (example.com and www.example.com), the query is routed using the Resolver rule that contains the most specific domain name (www.example.com).
Status:
allOf:
- $ref: '#/components/schemas/ResolverRuleStatus'
- description: A code that specifies the current status of the Resolver rule.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A detailed description of the status of a Resolver rule.
RuleType:
allOf:
- $ref: '#/components/schemas/RuleTypeOption'
- description: When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
ResolverRule parameter appears in the response to a CreateResolverRule, DeleteResolverRule, GetResolverRule, ListResolverRules, or UpdateResolverRule request.
FirewallDomainListMetadataList:
type: array
items:
$ref: '#/components/schemas/FirewallDomainListMetadata'
AssociateResolverRuleResponse:
type: object
properties:
ResolverRuleAssociation:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociation'
- description: Information about the AssociateResolverRule request, including the status of the request.
GetFirewallDomainListRequest:
type: object
required:
- FirewallDomainListId
title: GetFirewallDomainListRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list. '
ListFirewallRulesRequest:
type: object
required:
- FirewallRuleGroupId
title: ListFirewallRulesRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group that you want to retrieve the rules for. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: Optional additional filter for the rules to retrieve.
The setting that determines the processing order of the rules in a rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
Action: allOf: - $ref: '#/components/schemas/Action' - description:Optional additional filter for the rules to retrieve.
The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request to go through but send an alert to the logs.
BLOCK - Disallow the request. If this is specified, additional handling details are provided in the rule's BlockResponse setting.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
ListResolverQueryLogConfigAssociations request. If you don''t specify a value for MaxResults, Resolver returns up to 100 query logging associations. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverQueryLogConfigAssociations request, omit this value.
If there are more than MaxResults query logging associations that match the values that you specify for Filters, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of query logging associations.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
The element that you want Resolver to sort query logging associations by.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortBy, if any, as in the previous request.
Valid values include the following elements:
CreationTime: The ID of the query logging association.
Error: If the value of Status is FAILED, the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don''t allow sending logs to the destination.
If Status is a value other than FAILED, ERROR is null.
Id: The ID of the query logging association
ResolverQueryLogConfigId: The ID of the query logging configuration
ResourceId: The ID of the VPC that is associated with the query logging configuration
Status: The current status of the configuration. Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn''t create or couldn''t delete the query logging association. Here are two common causes:
The specified destination (for example, an Amazon S3 bucket) was deleted.
Permissions don''t allow sending logs to the destination.
If you specified a value for SortBy, the order that you want query logging associations to be listed in, ASCENDING or DESCENDING.
If you submit a second or subsequent ListResolverQueryLogConfigAssociations request and specify the NextToken parameter, you must use the same value for SortOrder, if any, as in the previous request.
Key might be account-id.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The value for the tag. For example, if Key is account-id, then Value might be the ID of the customer account that you're creating the resource for.
description: One tag that you want to add to the specified resource. A tag consists of a Key (a name for the tag) and a Value.
FirewallRuleGroupStatus:
type: string
enum:
- COMPLETE
- DELETING
- UPDATING
ListResolverRulesRequest:
type: object
title: ListResolverRulesRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of Resolver rules that you want to return in the response to a ListResolverRules request. If you don't specify a value for MaxResults, Resolver returns up to 100 Resolver rules.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverRules request, omit this value.
If you have more than MaxResults Resolver rules, you can submit another ListResolverRules request to get the next group of Resolver rules. In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of Resolver rules, such as all Resolver rules that are associated with the same Resolver endpoint.
If you submit a second or subsequent ListResolverRules request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
TargetIps.
description: In an UpdateResolverRule request, information about the changes that you want to make.
ResolverQueryLogConfigName:
type: string
pattern: (?!^[0-9]+$)([a-zA-Z0-9\-_' ']+)
minLength: 1
maxLength: 64
ResolverQueryLogConfigPolicy:
type: string
maxLength: 30000
CreateResolverEndpointRequest:
type: object
required:
- CreatorRequestId
- SecurityGroupIds
- Direction
- IpAddresses
title: CreateResolverEndpointRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. '
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: A friendly name that lets you easily find a configuration in the Resolver dashboard in the Route 53 console.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: 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.
Direction:
allOf:
- $ref: '#/components/schemas/ResolverEndpointDirection'
- description: 'Specify the applicable value:
INBOUND: Resolver forwards DNS queries to the DNS service for a VPC from your network
OUTBOUND: Resolver forwards DNS queries from the DNS service for a VPC to your network
CreateResolverRule request, including the status of the request.
GetResolverRulePolicyResponse:
type: object
properties:
ResolverRulePolicy:
allOf:
- $ref: '#/components/schemas/ResolverRulePolicy'
- description: The Resolver rule policy for the rule that you specified in a GetResolverRulePolicy request.
PutResolverRulePolicyRequest:
type: object
required:
- Arn
- ResolverRulePolicy
title: PutResolverRulePolicyRequest
properties:
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the rule that you want to share with another account.
ResolverRulePolicy:
allOf:
- $ref: '#/components/schemas/ResolverRulePolicy'
- description: An Identity and Access Management policy statement that lists the rules that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:
route53resolver:GetResolverRule
route53resolver:AssociateResolverRule
route53resolver:DisassociateResolverRule
route53resolver:ListResolverRules
route53resolver:ListResolverRuleAssociations
In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.
ListTagsForResource request. If you don't specify a value for MaxResults, Resolver returns up to 100 tags.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListTagsForResource request, omit this value.
If you have more than MaxResults tags, you can submit another ListTagsForResource request to get the next group of tags for the resource. In the next request, specify the value of NextToken from the previous response.
The name of the parameter that you want to use to filter objects.
The valid values for Name depend on the action that you''re including the filter in, ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, or ListResolverQueryLogConfigAssociations.
In early versions of Resolver, values for Name were listed as uppercase, with underscore (_) delimiters. For example, CreatorRequestId was originally listed as CREATOR_REQUEST_ID. Uppercase values for Name are still supported.
ListResolverEndpoints
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver endpoint.
Direction: Whether you want to return inbound or outbound Resolver endpoints. If you specify DIRECTION for Name, specify INBOUND or OUTBOUND for Values.
HostVPCId: The ID of the VPC that inbound DNS queries pass through on the way from your network to your VPCs in a region, or the VPC that outbound queries pass through on the way from your VPCs to your network. In a CreateResolverEndpoint request, SubnetId indirectly identifies the VPC. In a GetResolverEndpoint request, the VPC ID for a Resolver endpoint is returned in the HostVPCId element.
IpAddressCount: The number of IP addresses that you have associated with the Resolver endpoint.
Name: The name of the Resolver endpoint.
SecurityGroupIds: The IDs of the VPC security groups that you specified when you created the Resolver endpoint.
Status: The status of the Resolver endpoint. If you specify Status for Name, specify one of the following status codes for Values: CREATING, OPERATIONAL, UPDATING, AUTO_RECOVERING, ACTION_NEEDED, or DELETING. For more information, see Status in ResolverEndpoint.
ListResolverRules
Valid values for Name include the following:
CreatorRequestId: The value that you specified when you created the Resolver rule.
DomainName: The domain name for which Resolver is forwarding DNS queries to your network. In the value that you specify for Values, include a trailing dot (.) after the domain name. For example, if the domain name is example.com, specify the following value. Note the "." after com:
example.com.
Name: The name of the Resolver rule.
ResolverEndpointId: The ID of the Resolver endpoint that the Resolver rule is associated with.
You can filter on the Resolver endpoint only for rules that have a value of FORWARD for RuleType.
Status: The status of the Resolver rule. If you specify Status for Name, specify one of the following status codes for Values: COMPLETE, DELETING, UPDATING, or FAILED.
Type: The type of the Resolver rule. If you specify TYPE for Name, specify FORWARD or SYSTEM for Values.
ListResolverRuleAssociations
Valid values for Name include the following:
Name: The name of the Resolver rule association.
ResolverRuleId: The ID of the Resolver rule that is associated with one or more VPCs.
Status: The status of the Resolver rule association. If you specify Status for Name, specify one of the following status codes for Values: CREATING, COMPLETE, DELETING, or FAILED.
VPCId: The ID of the VPC that the Resolver rule is associated with.
ListResolverQueryLogConfigs
Valid values for Name include the following:
Arn: The ARN for the query logging configuration.
AssociationCount: The number of VPCs that are associated with the query logging configuration.
CreationTime: The date and time that the query logging configuration was created, in Unix time format and Coordinated Universal Time (UTC).
CreatorRequestId: A unique string that identifies the request that created the query logging configuration.
Destination: The Amazon Web Services service that you want to forward query logs to. Valid values include the following:
S3
CloudWatchLogs
KinesisFirehose
DestinationArn: The ARN of the location that Resolver is sending query logs to. This value can be the ARN for an S3 bucket, a CloudWatch Logs log group, or a Kinesis Data Firehose delivery stream.
Id: The ID of the query logging configuration
Name: The name of the query logging configuration
OwnerId: The Amazon Web Services account ID for the account that created the query logging configuration.
ShareStatus: An indication of whether the query logging configuration is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Valid values include: NOT_SHARED, SHARED_WITH_ME, or SHARED_BY_ME.
Status: The status of the query logging configuration. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
ListResolverQueryLogConfigAssociations
Valid values for Name include the following:
CreationTime: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
Error: If the value of Status is FAILED, specify the cause: DESTINATION_NOT_FOUND or ACCESS_DENIED.
Id: The ID of the query logging association.
ResolverQueryLogConfigId: The ID of the query logging configuration that a VPC is associated with.
ResourceId: The ID of the Amazon VPC that is associated with the query logging configuration.
Status: The status of the query logging association. If you specify Status for Name, specify the applicable status code for Values: CREATING, CREATED, DELETING, or FAILED. For more information, see Status.
List operation and you want the operation to return a subset of objects, such as Resolver endpoints or Resolver rules, the value of the parameter that you want to use to filter objects. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.
description: For Resolver list operations (ListResolverEndpoints, ListResolverRules, ListResolverRuleAssociations, ListResolverQueryLogConfigs, ListResolverQueryLogConfigAssociations), and ListResolverDnssecConfigs), an optional specification to return a subset of objects.
To filter objects, such as Resolver endpoints or Resolver rules, you specify Name and Values. For example, to list only inbound Resolver endpoints, specify Direction for Name and specify INBOUND for Values.
MaxResults query logging associations, you can submit another ListResolverQueryLogConfigAssociations request to get the next group of associations. In the next request, specify the value of NextToken from the previous response. '
TotalCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging associations that were created by the current account in the specified Region. This count can differ from the number of associations that are returned in a ListResolverQueryLogConfigAssociations response, depending on the values that you specify in the request.
TotalFilteredCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging associations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigAssociations request. For the total number of associations that were created by the current account in the specified Region, see TotalCount.
ResolverQueryLogConfigAssociations:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociationList'
- description: A list that contains one ResolverQueryLogConfigAssociations element for each query logging association that matches the values that you specified for Filter.
CreateResolverRuleRequest:
type: object
required:
- CreatorRequestId
- RuleType
- DomainName
title: CreateResolverRuleRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. '
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: A friendly name that lets you easily find a rule in the Resolver dashboard in the Route 53 console.
RuleType:
allOf:
- $ref: '#/components/schemas/RuleTypeOption'
- description: When you want to forward DNS queries for specified domain name to resolvers on your network, specify FORWARD.
When you have a forwarding rule to forward DNS queries for a domain to your network and you want Resolver to process queries for a subdomain of that domain, specify SYSTEM.
For example, to forward DNS queries for example.com to resolvers on your network, you create a rule and specify FORWARD for RuleType. To then have Resolver process queries for apex.example.com, you create a rule and specify SYSTEM for RuleType.
Currently, only Resolver can create rules that have a value of RECURSIVE for RuleType.
TargetIps. 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).
TargetIps:
allOf:
- $ref: '#/components/schemas/TargetList'
- description: The IPs that you want Resolver to forward DNS queries to. You can specify only IPv4 addresses. Separate IP addresses with a space.
TargetIps is available only when the value of Rule type is FORWARD.
TargetIps.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: A list of the tag keys and values that you want to associate with the endpoint.
ListResolverConfigsMaxResult:
type: integer
minimum: 5
maximum: 100
ListFirewallRuleGroupAssociationsResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 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.
FirewallRuleGroupAssociations:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociations'
- description: A list of your firewall rule group associations.
This might be a partial list of the associations that you have defined. For information, see MaxResults.
GetResolverRule request.
GetResolverEndpointRequest:
type: object
required:
- ResolverEndpointId
title: GetResolverEndpointRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to get information about.
ListResolverDnssecConfigsResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: If a response includes the last of the DNSSEC configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverDnssecConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
ListResolverRuleAssociations request. If you don''t specify a value for MaxResults, Resolver returns up to 100 rule associations. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverRuleAssociation request, omit this value.
If you have more than MaxResults rule associations, you can submit another ListResolverRuleAssociation request to get the next group of rule associations. In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of Resolver rules, such as Resolver rules that are associated with the same VPC ID.
If you submit a second or subsequent ListResolverRuleAssociations request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
GetResolverQueryLogConfigPolicy request.
DeleteResolverEndpointRequest:
type: object
required:
- ResolverEndpointId
title: DeleteResolverEndpointRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to delete.
GetFirewallRuleGroupAssociationRequest:
type: object
required:
- FirewallRuleGroupAssociationId
title: GetFirewallRuleGroupAssociationRequest
properties:
FirewallRuleGroupAssociationId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The identifier of the FirewallRuleGroupAssociation. '
ImportFirewallDomainsRequest:
type: object
required:
- FirewallDomainListId
- Operation
- DomainFileUrl
title: ImportFirewallDomainsRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the domain list that you want to modify with the import operation.
Operation:
allOf:
- $ref: '#/components/schemas/FirewallDomainImportOperation'
- description: 'What you want DNS Firewall to do with the domains that are listed in the file. This must be set to REPLACE, which updates the domain list to exactly match the list in the file. '
DomainFileUrl:
allOf:
- $ref: '#/components/schemas/DomainListFileUrl'
- description: The fully qualified URL or URI of the file stored in Amazon Simple Storage Service (Amazon S3) that contains the list of domains to import.
The file must be in an S3 bucket that's in the same Region as your DNS Firewall. The file must be a text file and must contain a single domain per line.
Filters: type: array items: $ref: '#/components/schemas/Filter' UpdateIpAddresses: type: array items: $ref: '#/components/schemas/UpdateIpAddress' minItems: 0 maxItems: 50 TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' maxItems: 200 StatusMessage: type: string maxLength: 255 CreateFirewallDomainListRequest: type: object required: - CreatorRequestId - Name title: CreateFirewallDomainListRequest properties: CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: 'A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice.CreatorRequestId can be any unique string, for example, a date/time stamp. '
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: A name that lets you identify the domain list to manage and use it.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'A list of the tag keys and values that you want to associate with the domain list. '
DeleteResolverQueryLogConfigRequest:
type: object
required:
- ResolverQueryLogConfigId
title: DeleteResolverQueryLogConfigRequest
properties:
ResolverQueryLogConfigId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the query logging configuration that you want to delete.
GetResolverRuleAssociationResponse:
type: object
properties:
ResolverRuleAssociation:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociation'
- description: Information about the Resolver rule association that you specified in a GetResolverRuleAssociation request.
DisassociateResolverQueryLogConfigRequest:
type: object
required:
- ResolverQueryLogConfigId
- ResourceId
title: DisassociateResolverQueryLogConfigRequest
properties:
ResolverQueryLogConfigId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the query logging configuration that you want to disassociate a specified VPC from.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Amazon VPC that you want to disassociate from a specified query logging configuration.
ResolverEndpointType:
type: string
enum:
- IPV6
- IPV4
- DUALSTACK
IpAddressStatus:
type: string
enum:
- CREATING
- FAILED_CREATION
- ATTACHING
- ATTACHED
- REMAP_DETACHING
- REMAP_ATTACHING
- DETACHING
- FAILED_RESOURCE_GONE
- DELETING
- DELETE_FAILED_FAS_EXPIRED
- UPDATING
ListTagsForResourceResponse:
type: object
properties:
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: The tags that are associated with the resource that you specified in the ListTagsForResource request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If more than MaxResults tags match the specified criteria, you can submit another ListTagsForResource request to get the next group of results. In the next request, specify the value of NextToken from the previous response. '
UnknownResourceException: {}
GetFirewallRuleGroupAssociationResponse:
type: object
properties:
FirewallRuleGroupAssociation:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociation'
- description: 'The association that you requested. '
FirewallDomainName:
type: string
minLength: 1
maxLength: 255
ResolverRuleAssociations:
type: array
items:
$ref: '#/components/schemas/ResolverRuleAssociation'
CreateFirewallRuleRequest:
type: object
required:
- CreatorRequestId
- FirewallRuleGroupId
- FirewallDomainListId
- Priority
- Action
- Name
title: CreateFirewallRuleRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows you to retry failed requests without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. '
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group where you want to create the rule. '
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list that you want to use in the rule. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: The setting that determines the processing order of the rule in the rule group. DNS Firewall processes the rules in a rule group by order of priority, starting from the lowest setting.
You must specify a unique priority for each rule in a rule group. To make it easier to insert rules later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for the rules in a rule group at any time.
Action: allOf: - $ref: '#/components/schemas/Action' - description:The action that DNS Firewall should take on a DNS query when it matches one of the domains in the rule's domain list:
ALLOW - Permit the request to go through.
ALERT - Permit the request and send metrics and logs to Cloud Watch.
BLOCK - Disallow the request. This option requires additional details in the rule's BlockResponse.
The way that you want DNS Firewall to block the request, used with the rule action setting BLOCK.
NODATA - Respond indicating that the query was successful, but no response is available for it.
NXDOMAIN - Respond indicating that the domain name that's in the query doesn't exist.
OVERRIDE - Provide a custom override in the response. This option requires custom handling details in the rule's BlockOverride* settings.
This setting is required if the rule action setting is BLOCK.
The custom DNS record to send back in response to the query. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
The DNS record's type. This determines the format of the record value that you provided in BlockOverrideDomain. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
The recommended amount of time, in seconds, for the DNS resolver or web browser to cache the provided override record. Used for the rule action BLOCK with a BlockResponse setting of OVERRIDE.
This setting is required if the BlockResponse setting is OVERRIDE.
If a response includes the last of the Resolver configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the response.
If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListResolverConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.
ResolverConfigs element for each Resolver configuration that is associated with the current Amazon Web Services account.
ListResolverEndpointIpAddressesResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If the specified endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response. '
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The value that you specified for MaxResults in the request.
IpAddresses:
allOf:
- $ref: '#/components/schemas/IpAddressesResponse'
- description: 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).
NextToken:
type: string
ListFirewallDomainsRequest:
type: object
required:
- FirewallDomainListId
title: ListFirewallDomainsRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list whose domains you want to retrieve. '
MaxResults:
allOf:
- $ref: '#/components/schemas/ListDomainMaxResults'
- description: The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
The status of the specified query logging association. Valid values include the following:
CREATING: Resolver is creating an association between an Amazon VPC and a query logging configuration.
CREATED: The association between an Amazon VPC and a query logging configuration was successfully created. Resolver is logging queries that originate in the specified VPC.
DELETING: Resolver is deleting this query logging association.
FAILED: Resolver either couldn''t create or couldn''t delete the query logging association.
If the value of Status is FAILED, the value of Error indicates the cause:
DESTINATION_NOT_FOUND: The specified destination (for example, an Amazon S3 bucket) was deleted.
ACCESS_DENIED: Permissions don''t allow sending logs to the destination.
If the value of Status is a value other than FAILED, Error is null.
Error is null, the value of ErrorMessage also is null.
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: The date and time that the VPC was associated with the query logging configuration, in Unix time format and Coordinated Universal Time (UTC).
description: In the response to an AssociateResolverQueryLogConfig, DisassociateResolverQueryLogConfig, GetResolverQueryLogConfigAssociation, or ListResolverQueryLogConfigAssociations, request, a complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
InvalidNextTokenException: {}
UpdateFirewallDomainsResponse:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the firewall domain list that DNS Firewall just updated.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the domain list. '
Status:
allOf:
- $ref: '#/components/schemas/FirewallDomainListStatus'
- description: Status of the UpdateFirewallDomains request.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the list, if available.
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
maxItems: 200
IpAddressesResponse:
type: array
items:
$ref: '#/components/schemas/IpAddressResponse'
DisassociateResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfigAssociation:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
- description: A complex type that contains settings for the association that you deleted between an Amazon VPC and a query logging configuration.
UntagResourceResponse:
type: object
properties: {}
FirewallDomainImportOperation:
type: string
enum:
- REPLACE
ConflictException: {}
ListResolverQueryLogConfigsResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'If there are more than MaxResults query logging configurations, you can submit another ListResolverQueryLogConfigs request to get the next group of configurations. In the next request, specify the value of NextToken from the previous response. '
TotalCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging configurations that were created by the current account in the specified Region. This count can differ from the number of query logging configurations that are returned in a ListResolverQueryLogConfigs response, depending on the values that you specify in the request.
TotalFilteredCount:
allOf:
- $ref: '#/components/schemas/Count'
- description: The total number of query logging configurations that were created by the current account in the specified Region and that match the filters that were specified in the ListResolverQueryLogConfigs request. For the total number of query logging configurations that were created by the current account in the specified Region, see TotalCount.
ResolverQueryLogConfigs:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigList'
- description: A list that contains one ResolverQueryLogConfig element for each query logging configuration that matches the values that you specified for Filter.
DisassociateResolverRuleResponse:
type: object
properties:
ResolverRuleAssociation:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociation'
- description: Information about the DisassociateResolverRule request, including the status of the request.
DeleteFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroup:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroup'
- description: 'A collection of rules used to filter DNS network traffic. '
FirewallConfigList:
type: array
items:
$ref: '#/components/schemas/FirewallConfig'
AssociateFirewallRuleGroupRequest:
type: object
required:
- CreatorRequestId
- FirewallRuleGroupId
- VpcId
- Priority
- Name
title: AssociateFirewallRuleGroupRequest
properties:
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: 'A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp. '
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group. '
VpcId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the VPC that you want to associate with the rule group. '
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- description: The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 101, 200, and so on. You can change the priority setting for a rule group association after you create it.
The allowed values for Priority are between 100 and 9900.
DISABLED. '
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- description: 'A list of the tag keys and values that you want to associate with the rule group association. '
ResolverQueryLogConfigStatus:
type: string
enum:
- CREATING
- CREATED
- DELETING
- FAILED
ListFirewallConfigsMaxResult:
type: integer
minimum: 5
maximum: 10
CreateFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroup:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroup'
- description: 'A collection of rules used to filter DNS network traffic. '
DeleteFirewallRuleRequest:
type: object
required:
- FirewallRuleGroupId
- FirewallDomainListId
title: DeleteFirewallRuleRequest
properties:
FirewallRuleGroupId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The unique identifier of the firewall rule group that you want to delete the rule from. '
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list that''s used in the rule. '
UpdateResolverRuleResponse:
type: object
properties:
ResolverRule:
allOf:
- $ref: '#/components/schemas/ResolverRule'
- description: The response to an UpdateResolverRule request.
IpAddressCount:
type: integer
ListFirewallDomainListsResponse:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 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.
FirewallDomainLists:
allOf:
- $ref: '#/components/schemas/FirewallDomainListMetadataList'
- description: A list of the domain lists that you have defined.
This might be a partial list of the domain lists that you've defined. For information, see MaxResults.
GetResolverConfig request.
SecurityGroupIds:
type: array
items:
$ref: '#/components/schemas/ResourceId'
TagResourceResponse:
type: object
properties: {}
Unsigned:
type: integer
CreateFirewallDomainListResponse:
type: object
properties:
FirewallDomainList:
allOf:
- $ref: '#/components/schemas/FirewallDomainList'
- description: The domain list that you just created.
ResolverEndpoints:
type: array
items:
$ref: '#/components/schemas/ResolverEndpoint'
Port:
type: integer
minimum: 0
maximum: 65535
FirewallDomainListMetadata:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list. '
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the firewall domain list metadata.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the domain list. '
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: '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. '
ManagedOwnerName:
allOf:
- $ref: '#/components/schemas/ServicePrinciple'
- description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.
description: Minimal high-level information for a firewall domain list. The action ListFirewallDomainLists returns an array of these objects.
To retrieve full information for a firewall domain list, call GetFirewallDomainList and ListFirewallDomains.
FirewallDomainUpdateOperation: type: string enum: - ADD - REMOVE - REPLACE AssociateResolverQueryLogConfigRequest: type: object required: - ResolverQueryLogConfigId - ResourceId title: AssociateResolverQueryLogConfigRequest properties: ResolverQueryLogConfigId: allOf: - $ref: '#/components/schemas/ResourceId' - description: The ID of the query logging configuration that you want to associate a VPC with. ResourceId: allOf: - $ref: '#/components/schemas/ResourceId' - description:The ID of an Amazon VPC that you want this query logging configuration to log queries for.
The VPCs and the query logging configuration must be in the same Region.
Status setting that you want DNS Firewall to filter on for the list. If you don't specify this, then DNS Firewall returns all associations, regardless of status.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
The status of whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. The status can be one of following:
ENABLING: Autodefined rules for reverse DNS lookups are being enabled but are not complete.
ENABLED: Autodefined rules for reverse DNS lookups are enabled.
DISABLING: Autodefined rules for reverse DNS lookups are being disabled but are not complete.
DISABLED: Autodefined rules for reverse DNS lookups are disabled.
GetQueryLogConfig request.
FilterValue:
type: string
minLength: 1
maxLength: 600
AssociateFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroupAssociation:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroupAssociation'
- description: 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.
ResolverQueryLogConfigList:
type: array
items:
$ref: '#/components/schemas/ResolverQueryLogConfig'
SortByKey:
type: string
minLength: 1
maxLength: 64
ShareStatus:
type: string
enum:
- NOT_SHARED
- SHARED_WITH_ME
- SHARED_BY_ME
UpdateFirewallConfigResponse:
type: object
properties:
FirewallConfig:
allOf:
- $ref: '#/components/schemas/FirewallConfig'
- description: 'Configuration of the firewall behavior provided by DNS Firewall for a single VPC. '
ListResolverDnssecConfigsRequest:
type: object
title: ListResolverDnssecConfigsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: ' Optional: An integer that specifies the maximum number of DNSSEC configuration results that you want Amazon Route 53 to return. If you don''t specify a value for MaxResults, Route 53 returns up to 100 configuration per page.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: (Optional) If the current Amazon Web Services account has more than MaxResults DNSSEC configurations, use NextToken to get the second and subsequent pages of results.
For the first ListResolverDnssecConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
An Identity and Access Management policy statement that lists the query logging configurations that you want to share with another Amazon Web Services account and the operations that you want the account to be able to perform. You can specify the following operations in the Actions section of the statement:
route53resolver:AssociateResolverQueryLogConfig
route53resolver:DisassociateResolverQueryLogConfig
route53resolver:ListResolverQueryLogConfigAssociations
route53resolver:ListResolverQueryLogConfigs
In the Resource section of the statement, you specify the ARNs for the query logging configurations that you want to share with the account that you specified in Arn.
A list of the domains in the firewall domain list.
This might be a partial list of the domains that you've defined in the domain list. For information, see MaxResults.
A list of the rules that you have defined.
This might be a partial list of the firewall rules that you've defined. For information, see MaxResults.
ListResolverEndpoints request. If you don''t specify a value for MaxResults, Resolver returns up to 100 Resolver endpoints. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverEndpoints request, omit this value.
If you have more than MaxResults Resolver endpoints, you can submit another ListResolverEndpoints request to get the next group of Resolver endpoints. In the next request, specify the value of NextToken from the previous response.
An optional specification to return a subset of Resolver endpoints, such as all inbound Resolver endpoints.
If you submit a second or subsequent ListResolverEndpoints request and specify the NextToken parameter, you must use the same values for Filters, if any, as in the previous request.
The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
Determines how Route 53 Resolver handles queries during failures, for example when all traffic that is sent to DNS Firewall fails to receive a reply.
By default, fail open is disabled, which means the failure mode is closed. This approach favors security over availability. DNS Firewall blocks queries that it is unable to evaluate properly.
If you enable this option, the failure mode is open. This approach favors availability over security. DNS Firewall allows queries to proceed if it is unable to properly evaluate them.
This behavior is only enforced for VPCs that have at least one DNS Firewall rule group association.
GetResolverEndpointResponse: type: object properties: ResolverEndpoint: allOf: - $ref: '#/components/schemas/ResolverEndpoint' - description: Information about the Resolver endpoint that you specified in aGetResolverEndpoint request.
ListFirewallDomainListsRequest:
type: object
title: ListFirewallDomainListsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of objects that you want Resolver to return for this request. If more objects are available, in the response, Resolver provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
If you don't specify a value for MaxResults, Resolver returns up to 100 objects.
For the first call to this list request, omit this value.
When you request a list of objects, Resolver returns at most the number of objects specified in MaxResults. If more objects are available for retrieval, Resolver returns a NextToken value in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.
A list of your firewall rule groups.
This might be a partial list of the rule groups that you have defined. For information, see MaxResults.
MaxResults rule associations match the specified criteria, you can submit another ListResolverRuleAssociation request to get the next group of results. In the next request, specify the value of NextToken from the previous response. '
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The value that you specified for MaxResults in the request.
ResolverRuleAssociations:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociations'
- description: 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.
SortOrder:
type: string
enum:
- ASCENDING
- DESCENDING
BlockResponse:
type: string
enum:
- NODATA
- NXDOMAIN
- OVERRIDE
SubnetId:
type: string
minLength: 1
maxLength: 32
GetResolverDnssecConfigRequest:
type: object
required:
- ResourceId
title: GetResolverDnssecConfigRequest
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the virtual private cloud (VPC) for the DNSSEC validation status.
InvalidRequestException: {}
ResolverDnssecConfig:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID for a configuration for DNSSEC validation.
OwnerId:
allOf:
- $ref: '#/components/schemas/AccountId'
- description: The owner account ID of the virtual private cloud (VPC) for a configuration for DNSSEC validation.
ResourceId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the virtual private cloud (VPC) that you're configuring the DNSSEC validation status for.
ValidationStatus:
allOf:
- $ref: '#/components/schemas/ResolverDNSSECValidationStatus'
- description: The validation status for a DNSSEC configuration. The status can be one of the following:
ENABLING: DNSSEC validation is being enabled but is not complete.
ENABLED: DNSSEC validation is enabled.
DISABLING: DNSSEC validation is being disabled but is not complete.
DISABLED DNSSEC validation is disabled.
The setting that determines the processing order of the rule group among the rule groups that you associate with the specified VPC. DNS Firewall filters VPC traffic starting from the rule group with the lowest numeric priority setting.
You must specify a unique priority for each rule group that you associate with a single VPC. To make it easier to insert rule groups later, leave space between the numbers, for example, use 100, 200, and so on. You can change the priority setting for a rule group association after you create it.
MutationProtection: allOf: - $ref: '#/components/schemas/MutationProtectionStatus' - description: 'If enabled, this setting disallows modification or removal of the association, to help prevent against accidentally altering DNS firewall protections. ' Name: allOf: - $ref: '#/components/schemas/Name' - description: The name of the rule group association. ListResolverEndpointsResponse: type: object properties: NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'If more thanMaxResults IP addresses match the specified criteria, you can submit another ListResolverEndpoint request to get the next group of results. In the next request, specify the value of NextToken from the previous response. '
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The value that you specified for MaxResults in the request.
ResolverEndpoints:
allOf:
- $ref: '#/components/schemas/ResolverEndpoints'
- description: The Resolver endpoints that were created by using the current Amazon Web Services account, and that match the specified filters, if any.
FirewallFailOpenStatus:
type: string
enum:
- ENABLED
- DISABLED
- USE_LOCAL_RESOURCE_SETTING
AssociateResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfigAssociation:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
- description: A complex type that contains settings for a specified association between an Amazon VPC and a query logging configuration.
ResolverQueryLogConfigAssociationList:
type: array
items:
$ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
ListResolverConfigsRequest:
type: object
title: ListResolverConfigsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/ListResolverConfigsMaxResult'
- description: The maximum number of Resolver configurations that you want to return in the response to a ListResolverConfigs request. If you don't specify a value for MaxResults, up to 100 Resolver configurations are returned.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: (Optional) If the current Amazon Web Services account has more than MaxResults Resolver configurations, use NextToken to get the second and subsequent pages of results.
For the first ListResolverConfigs request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
UpdateResolverEndpoint request.
InvalidTagException: {}
BlockOverrideDomain:
type: string
minLength: 1
maxLength: 255
ResolverRuleStatus:
type: string
enum:
- COMPLETE
- DELETING
- UPDATING
- FAILED
BlockOverrideDnsType:
type: string
enum:
- CNAME
PutResolverRulePolicyResponse:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the PutResolverRulePolicy request was successful.
description: The response to a PutResolverRulePolicy request.
DeleteResolverQueryLogConfigResponse:
type: object
properties:
ResolverQueryLogConfig:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfig'
- description: Information about the query logging configuration that you deleted, including the status of the request.
ResolverDnssecConfigList:
type: array
items:
$ref: '#/components/schemas/ResolverDnssecConfig'
DeleteResolverEndpointResponse:
type: object
properties:
ResolverEndpoint:
allOf:
- $ref: '#/components/schemas/ResolverEndpoint'
- description: Information about the DeleteResolverEndpoint request, including the status of the request.
InvalidPolicyDocument: {}
ListResolverEndpointIpAddressesRequest:
type: object
required:
- ResolverEndpointId
title: ListResolverEndpointIpAddressesRequest
properties:
ResolverEndpointId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver endpoint that you want to get IP addresses for.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: 'The maximum number of IP addresses that you want to return in the response to a ListResolverEndpointIpAddresses request. If you don''t specify a value for MaxResults, Resolver returns up to 100 IP addresses. '
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: For the first ListResolverEndpointIpAddresses request, omit this value.
If the specified Resolver endpoint has more than MaxResults IP addresses, you can submit another ListResolverEndpointIpAddresses request to get the next group of IP addresses. In the next request, specify the value of NextToken from the previous response.
DisassociateResolverEndpointIpAddress request.
ResourceInUseException: {}
PutResolverQueryLogConfigPolicyResponse:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Whether the PutResolverQueryLogConfigPolicy request was successful.
description: The response to a PutResolverQueryLogConfigPolicy request.
ResolverRuleAssociation:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the association between a Resolver rule and a VPC. Resolver assigns this value when you submit an AssociateResolverRule request.
ResolverRuleId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the Resolver rule that you associated with the VPC that is specified by VPCId.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name of an association between a Resolver rule and a VPC.
VPCId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: The ID of the VPC that you associated the Resolver rule with.
Status:
allOf:
- $ref: '#/components/schemas/ResolverRuleAssociationStatus'
- description: A code that specifies the current status of the association between a Resolver rule and a VPC.
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: A detailed description of the status of the association between a Resolver rule and a VPC.
description: 'In the response to an AssociateResolverRule, DisassociateResolverRule, or ListResolverRuleAssociations 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. '
FirewallRuleGroupMetadataList:
type: array
items:
$ref: '#/components/schemas/FirewallRuleGroupMetadata'
DeleteFirewallRuleResponse:
type: object
properties:
FirewallRule:
allOf:
- $ref: '#/components/schemas/FirewallRule'
- description: The specification for the firewall rule that you just deleted.
FirewallDomainList:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list. '
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The Amazon Resource Name (ARN) of the firewall domain list.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: 'The name of the domain list. '
DomainCount:
allOf:
- $ref: '#/components/schemas/Unsigned'
- description: The number of domain names that are specified in the domain list.
Status:
allOf:
- $ref: '#/components/schemas/FirewallDomainListStatus'
- description: 'The status of the domain list. '
StatusMessage:
allOf:
- $ref: '#/components/schemas/StatusMessage'
- description: Additional information about the status of the list, if available.
ManagedOwnerName:
allOf:
- $ref: '#/components/schemas/ServicePrinciple'
- description: The owner of the list, used only for lists that are not managed by you. For example, the managed domain list AWSManagedDomainsMalwareDomainList has the managed owner name Route 53 Resolver DNS Firewall.
CreatorRequestId:
allOf:
- $ref: '#/components/schemas/CreatorRequestId'
- description: '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. '
CreationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the domain list was created, in Unix time format and Coordinated Universal Time (UTC). '
ModificationTime:
allOf:
- $ref: '#/components/schemas/Rfc3339TimeString'
- description: 'The date and time that the domain list was last modified, in Unix time format and Coordinated Universal Time (UTC). '
description: High-level information about a list of firewall domains for use in a FirewallRule. This is returned by GetFirewallDomainList.
To retrieve the domains that are defined for this domain list, call ListFirewallDomains.
ResolverRulePolicy: type: string maxLength: 30000 DomainName: type: string minLength: 1 maxLength: 256 DomainListFileUrl: type: string minLength: 1 maxLength: 1024 Validation: type: string enum: - ENABLE - DISABLE - USE_LOCAL_RESOURCE_SETTING ResolverEndpoint: type: object properties: Id: allOf: - $ref: '#/components/schemas/ResourceId' - description: The ID of the Resolver endpoint. CreatorRequestId: allOf: - $ref: '#/components/schemas/CreatorRequestId' - description: A unique string that identifies the request that created the Resolver endpoint. TheCreatorRequestId allows failed requests to be retried without the risk of running the operation twice.
Arn:
allOf:
- $ref: '#/components/schemas/Arn'
- description: The ARN (Amazon Resource Name) for the Resolver endpoint.
Name:
allOf:
- $ref: '#/components/schemas/Name'
- description: The name that you assigned to the Resolver endpoint when you submitted a CreateResolverEndpoint request.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIds'
- description: 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.
Direction:
allOf:
- $ref: '#/components/schemas/ResolverEndpointDirection'
- description: 'Indicates whether the Resolver endpoint allows inbound or outbound DNS queries:
INBOUND: allows DNS queries to your VPC from your network
OUTBOUND: allows DNS queries from your VPC to your network
A code that specifies the current status of the Resolver endpoint. Valid values include the following:
CREATING: Resolver is creating and configuring one or more Amazon VPC network interfaces for this endpoint.
OPERATIONAL: The Amazon VPC network interfaces for this endpoint are correctly configured and able to pass inbound or outbound DNS queries between your network and Resolver.
UPDATING: Resolver is associating or disassociating one or more network interfaces with this endpoint.
AUTO_RECOVERING: Resolver is trying to recover one or more of the network interfaces that are associated with this endpoint. During the recovery process, the endpoint functions with limited capacity because of the limit on the number of DNS queries per IP address (per network interface). For the current limit, see Limits on Route 53 Resolver.
ACTION_NEEDED: This endpoint is unhealthy, and Resolver can''t automatically recover it. To resolve the problem, we recommend that you check each IP address that you associated with the endpoint. For each IP address that isn''t available, add another IP address and then delete the IP address that isn''t available. (An endpoint must always include at least two IP addresses.) A status of ACTION_NEEDED can have a variety of causes. Here are two common causes:
One or more of the network interfaces that are associated with the endpoint were deleted using Amazon VPC.
The network interface couldn''t be created for some reason that''s outside the control of Resolver.
DELETING: Resolver is deleting this endpoint and the associated network interfaces.
Indicates whether or not the Resolver will create autodefined rules for reverse DNS lookups. This is enabled by default. Disabling this option will also affect EC2-Classic instances using ClassicLink. For more information, see ClassicLink in the Amazon EC2 guide.
We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon EC2 guide and the blog EC2-Classic Networking is Retiring – Here’s How to Prepare.
It can take some time for the status change to be completed.
IpAddressRequest also includes the ID of the subnet that contains the IP address.
GetResolverQueryLogConfigAssociationResponse:
type: object
properties:
ResolverQueryLogConfigAssociation:
allOf:
- $ref: '#/components/schemas/ResolverQueryLogConfigAssociation'
- description: Information about the Resolver query logging configuration association that you specified in a GetQueryLogConfigAssociation request.
CreateFirewallRuleResponse:
type: object
properties:
FirewallRule:
allOf:
- $ref: '#/components/schemas/FirewallRule'
- description: 'The firewall rule that you just created. '
ResourceUnavailableException: {}
RuleTypeOption:
type: string
enum:
- FORWARD
- SYSTEM
- RECURSIVE
ResolverDNSSECValidationStatus:
type: string
enum:
- ENABLING
- ENABLED
- DISABLING
- DISABLED
- UPDATING_TO_USE_LOCAL_RESOURCE_SETTING
- USE_LOCAL_RESOURCE_SETTING
GetFirewallRuleGroupResponse:
type: object
properties:
FirewallRuleGroup:
allOf:
- $ref: '#/components/schemas/FirewallRuleGroup'
- description: 'A collection of rules used to filter DNS network traffic. '
CreatorRequestId:
type: string
minLength: 1
maxLength: 255
DeleteResolverRuleResponse:
type: object
properties:
ResolverRule:
allOf:
- $ref: '#/components/schemas/ResolverRule'
- description: Information about the DeleteResolverRule request, including the status of the request.
UpdateFirewallDomainsRequest:
type: object
required:
- FirewallDomainListId
- Operation
- Domains
title: UpdateFirewallDomainsRequest
properties:
FirewallDomainListId:
allOf:
- $ref: '#/components/schemas/ResourceId'
- description: 'The ID of the domain list whose domains you want to update. '
Operation:
allOf:
- $ref: '#/components/schemas/FirewallDomainUpdateOperation'
- description: 'What you want DNS Firewall to do with the domains that you are providing:
ADD - Add the domains to the ones that are already in the domain list.
REMOVE - Search the domain list for the domains and remove them from the list.
REPLACE - Update the domain list to exactly match the list that you are providing.
A list of domains to use in the update operation.
There is a limit of 1000 domains per request.
Each domain specification in your domain list must satisfy the following requirements:
It can optionally start with * (asterisk).
With the exception of the optional starting asterisk, it must only contain the following characters: A-Z, a-z, 0-9, - (hyphen).
It must be from 1-255 characters in length.