Skip to content

Route53ResolverClient#

Index > Route53Resolver > Route53ResolverClient

Auto-generated documentation for Route53Resolver type annotations stubs module mypy-boto3-route53resolver.

Route53ResolverClient#

Type annotations and code completion for boto3.client("route53resolver"). boto3 documentation

# Route53ResolverClient usage example

from boto3.session import Session
from mypy_boto3_route53resolver.client import Route53ResolverClient

def get_route53resolver_client() -> Route53ResolverClient:
    return Session().client("route53resolver")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("route53resolver").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("route53resolver")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServiceErrorException,
    client.exceptions.InvalidNextTokenException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidPolicyDocument,
    client.exceptions.InvalidRequestException,
    client.exceptions.InvalidTagException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceUnavailableException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.UnknownResourceException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_route53resolver.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

associate_firewall_rule_group#

Associates a FirewallRuleGroup with a VPC, to provide DNS filtering for the VPC.

Type annotations and code completion for boto3.client("route53resolver").associate_firewall_rule_group method. boto3 documentation

# associate_firewall_rule_group method definition

def associate_firewall_rule_group(
    self,
    *,
    CreatorRequestId: str,
    FirewallRuleGroupId: str,
    VpcId: str,
    Priority: int,
    Name: str,
    MutationProtection: MutationProtectionStatusType = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> AssociateFirewallRuleGroupResponseTypeDef:  # (3)
    ...
  1. See MutationProtectionStatusType
  2. See TagTypeDef
  3. See AssociateFirewallRuleGroupResponseTypeDef 
# associate_firewall_rule_group method usage example with argument unpacking

kwargs: AssociateFirewallRuleGroupRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "FirewallRuleGroupId": ...,
    "VpcId": ...,
    "Priority": ...,
    "Name": ...,
}

parent.associate_firewall_rule_group(**kwargs)
  1. See AssociateFirewallRuleGroupRequestRequestTypeDef

associate_resolver_endpoint_ip_address#

Adds IP addresses to an inbound or an outbound Resolver endpoint.

Type annotations and code completion for boto3.client("route53resolver").associate_resolver_endpoint_ip_address method. boto3 documentation

# associate_resolver_endpoint_ip_address method definition

def associate_resolver_endpoint_ip_address(
    self,
    *,
    ResolverEndpointId: str,
    IpAddress: IpAddressUpdateTypeDef,  # (1)
) -> AssociateResolverEndpointIpAddressResponseTypeDef:  # (2)
    ...
  1. See IpAddressUpdateTypeDef
  2. See AssociateResolverEndpointIpAddressResponseTypeDef 
# associate_resolver_endpoint_ip_address method usage example with argument unpacking

kwargs: AssociateResolverEndpointIpAddressRequestRequestTypeDef = {  # (1)
    "ResolverEndpointId": ...,
    "IpAddress": ...,
}

parent.associate_resolver_endpoint_ip_address(**kwargs)
  1. See AssociateResolverEndpointIpAddressRequestRequestTypeDef

associate_resolver_query_log_config#

Associates an Amazon VPC with a specified query logging configuration.

Type annotations and code completion for boto3.client("route53resolver").associate_resolver_query_log_config method. boto3 documentation

# associate_resolver_query_log_config method definition

def associate_resolver_query_log_config(
    self,
    *,
    ResolverQueryLogConfigId: str,
    ResourceId: str,
) -> AssociateResolverQueryLogConfigResponseTypeDef:  # (1)
    ...
  1. See AssociateResolverQueryLogConfigResponseTypeDef 
# associate_resolver_query_log_config method usage example with argument unpacking

kwargs: AssociateResolverQueryLogConfigRequestRequestTypeDef = {  # (1)
    "ResolverQueryLogConfigId": ...,
    "ResourceId": ...,
}

parent.associate_resolver_query_log_config(**kwargs)
  1. See AssociateResolverQueryLogConfigRequestRequestTypeDef

associate_resolver_rule#

Associates a Resolver rule with a VPC.

Type annotations and code completion for boto3.client("route53resolver").associate_resolver_rule method. boto3 documentation

# associate_resolver_rule method definition

def associate_resolver_rule(
    self,
    *,
    ResolverRuleId: str,
    VPCId: str,
    Name: str = ...,
) -> AssociateResolverRuleResponseTypeDef:  # (1)
    ...
  1. See AssociateResolverRuleResponseTypeDef 
# associate_resolver_rule method usage example with argument unpacking

kwargs: AssociateResolverRuleRequestRequestTypeDef = {  # (1)
    "ResolverRuleId": ...,
    "VPCId": ...,
}

parent.associate_resolver_rule(**kwargs)
  1. See AssociateResolverRuleRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("route53resolver").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("route53resolver").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_firewall_domain_list#

Creates an empty firewall domain list for use in DNS Firewall rules.

Type annotations and code completion for boto3.client("route53resolver").create_firewall_domain_list method. boto3 documentation

# create_firewall_domain_list method definition

def create_firewall_domain_list(
    self,
    *,
    CreatorRequestId: str,
    Name: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateFirewallDomainListResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateFirewallDomainListResponseTypeDef 
# create_firewall_domain_list method usage example with argument unpacking

kwargs: CreateFirewallDomainListRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "Name": ...,
}

parent.create_firewall_domain_list(**kwargs)
  1. See CreateFirewallDomainListRequestRequestTypeDef

create_firewall_rule#

Creates a single DNS Firewall rule in the specified rule group, using the specified domain list.

Type annotations and code completion for boto3.client("route53resolver").create_firewall_rule method. boto3 documentation

# create_firewall_rule method definition

def create_firewall_rule(
    self,
    *,
    CreatorRequestId: str,
    FirewallRuleGroupId: str,
    FirewallDomainListId: str,
    Priority: int,
    Action: ActionType,  # (1)
    Name: str,
    BlockResponse: BlockResponseType = ...,  # (2)
    BlockOverrideDomain: str = ...,
    BlockOverrideDnsType: BlockOverrideDnsTypeType = ...,  # (3)
    BlockOverrideTtl: int = ...,
) -> CreateFirewallRuleResponseTypeDef:  # (4)
    ...
  1. See ActionType
  2. See BlockResponseType
  3. See BlockOverrideDnsTypeType
  4. See CreateFirewallRuleResponseTypeDef 
# create_firewall_rule method usage example with argument unpacking

kwargs: CreateFirewallRuleRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "FirewallRuleGroupId": ...,
    "FirewallDomainListId": ...,
    "Priority": ...,
    "Action": ...,
    "Name": ...,
}

parent.create_firewall_rule(**kwargs)
  1. See CreateFirewallRuleRequestRequestTypeDef

create_firewall_rule_group#

Creates an empty DNS Firewall rule group for filtering DNS network traffic in a VPC.

Type annotations and code completion for boto3.client("route53resolver").create_firewall_rule_group method. boto3 documentation

# create_firewall_rule_group method definition

def create_firewall_rule_group(
    self,
    *,
    CreatorRequestId: str,
    Name: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateFirewallRuleGroupResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateFirewallRuleGroupResponseTypeDef 
# create_firewall_rule_group method usage example with argument unpacking

kwargs: CreateFirewallRuleGroupRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "Name": ...,
}

parent.create_firewall_rule_group(**kwargs)
  1. See CreateFirewallRuleGroupRequestRequestTypeDef

create_outpost_resolver#

Creates an Route 53 Resolver on an Outpost.

Type annotations and code completion for boto3.client("route53resolver").create_outpost_resolver method. boto3 documentation

# create_outpost_resolver method definition

def create_outpost_resolver(
    self,
    *,
    CreatorRequestId: str,
    Name: str,
    PreferredInstanceType: str,
    OutpostArn: str,
    InstanceCount: int = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateOutpostResolverResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateOutpostResolverResponseTypeDef 
# create_outpost_resolver method usage example with argument unpacking

kwargs: CreateOutpostResolverRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "Name": ...,
    "PreferredInstanceType": ...,
    "OutpostArn": ...,
}

parent.create_outpost_resolver(**kwargs)
  1. See CreateOutpostResolverRequestRequestTypeDef

create_resolver_endpoint#

Creates a Resolver endpoint.

Type annotations and code completion for boto3.client("route53resolver").create_resolver_endpoint method. boto3 documentation

# create_resolver_endpoint method definition

def create_resolver_endpoint(
    self,
    *,
    CreatorRequestId: str,
    SecurityGroupIds: Sequence[str],
    Direction: ResolverEndpointDirectionType,  # (1)
    IpAddresses: Sequence[IpAddressRequestTypeDef],  # (2)
    Name: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
    ResolverEndpointType: ResolverEndpointTypeType = ...,  # (4)
    OutpostArn: str = ...,
    PreferredInstanceType: str = ...,
) -> CreateResolverEndpointResponseTypeDef:  # (5)
    ...
  1. See ResolverEndpointDirectionType
  2. See IpAddressRequestTypeDef
  3. See TagTypeDef
  4. See ResolverEndpointTypeType
  5. See CreateResolverEndpointResponseTypeDef 
# create_resolver_endpoint method usage example with argument unpacking

kwargs: CreateResolverEndpointRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "SecurityGroupIds": ...,
    "Direction": ...,
    "IpAddresses": ...,
}

parent.create_resolver_endpoint(**kwargs)
  1. See CreateResolverEndpointRequestRequestTypeDef

create_resolver_query_log_config#

Creates a Resolver query logging configuration, which defines where you want Resolver to save DNS query logs that originate in your VPCs.

Type annotations and code completion for boto3.client("route53resolver").create_resolver_query_log_config method. boto3 documentation

# create_resolver_query_log_config method definition

def create_resolver_query_log_config(
    self,
    *,
    Name: str,
    DestinationArn: str,
    CreatorRequestId: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> CreateResolverQueryLogConfigResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See CreateResolverQueryLogConfigResponseTypeDef 
# create_resolver_query_log_config method usage example with argument unpacking

kwargs: CreateResolverQueryLogConfigRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "DestinationArn": ...,
    "CreatorRequestId": ...,
}

parent.create_resolver_query_log_config(**kwargs)
  1. See CreateResolverQueryLogConfigRequestRequestTypeDef

create_resolver_rule#

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.

Type annotations and code completion for boto3.client("route53resolver").create_resolver_rule method. boto3 documentation

# create_resolver_rule method definition

def create_resolver_rule(
    self,
    *,
    CreatorRequestId: str,
    RuleType: RuleTypeOptionType,  # (1)
    DomainName: str,
    Name: str = ...,
    TargetIps: Sequence[TargetAddressTypeDef] = ...,  # (2)
    ResolverEndpointId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> CreateResolverRuleResponseTypeDef:  # (4)
    ...
  1. See RuleTypeOptionType
  2. See TargetAddressTypeDef
  3. See TagTypeDef
  4. See CreateResolverRuleResponseTypeDef 
# create_resolver_rule method usage example with argument unpacking

kwargs: CreateResolverRuleRequestRequestTypeDef = {  # (1)
    "CreatorRequestId": ...,
    "RuleType": ...,
    "DomainName": ...,
}

parent.create_resolver_rule(**kwargs)
  1. See CreateResolverRuleRequestRequestTypeDef

delete_firewall_domain_list#

Deletes the specified domain list.

Type annotations and code completion for boto3.client("route53resolver").delete_firewall_domain_list method. boto3 documentation

# delete_firewall_domain_list method definition

def delete_firewall_domain_list(
    self,
    *,
    FirewallDomainListId: str,
) -> DeleteFirewallDomainListResponseTypeDef:  # (1)
    ...
  1. See DeleteFirewallDomainListResponseTypeDef 
# delete_firewall_domain_list method usage example with argument unpacking

kwargs: DeleteFirewallDomainListRequestRequestTypeDef = {  # (1)
    "FirewallDomainListId": ...,
}

parent.delete_firewall_domain_list(**kwargs)
  1. See DeleteFirewallDomainListRequestRequestTypeDef

delete_firewall_rule#

Deletes the specified firewall rule.

Type annotations and code completion for boto3.client("route53resolver").delete_firewall_rule method. boto3 documentation

# delete_firewall_rule method definition

def delete_firewall_rule(
    self,
    *,
    FirewallRuleGroupId: str,
    FirewallDomainListId: str,
) -> DeleteFirewallRuleResponseTypeDef:  # (1)
    ...
  1. See DeleteFirewallRuleResponseTypeDef 
# delete_firewall_rule method usage example with argument unpacking

kwargs: DeleteFirewallRuleRequestRequestTypeDef = {  # (1)
    "FirewallRuleGroupId": ...,
    "FirewallDomainListId": ...,
}

parent.delete_firewall_rule(**kwargs)
  1. See DeleteFirewallRuleRequestRequestTypeDef

delete_firewall_rule_group#

Deletes the specified firewall rule group.

Type annotations and code completion for boto3.client("route53resolver").delete_firewall_rule_group method.