Skip to content

Route53Client#

Index > Route53 > Route53Client

Auto-generated documentation for Route53 type annotations stubs module mypy-boto3-route53.

Route53Client#

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

# Route53Client usage example

from boto3.session import Session
from mypy_boto3_route53.client import Route53Client

def get_route53_client() -> Route53Client:
    return Session().client("route53")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("route53")

try:
    do_something(client)
except (
    client.exceptions.CidrBlockInUseException,
    client.exceptions.CidrCollectionAlreadyExistsException,
    client.exceptions.CidrCollectionInUseException,
    client.exceptions.CidrCollectionVersionMismatchException,
    client.exceptions.ClientError,
    client.exceptions.ConcurrentModification,
    client.exceptions.ConflictingDomainExists,
    client.exceptions.ConflictingTypes,
    client.exceptions.DNSSECNotFound,
    client.exceptions.DelegationSetAlreadyCreated,
    client.exceptions.DelegationSetAlreadyReusable,
    client.exceptions.DelegationSetInUse,
    client.exceptions.DelegationSetNotAvailable,
    client.exceptions.DelegationSetNotReusable,
    client.exceptions.HealthCheckAlreadyExists,
    client.exceptions.HealthCheckInUse,
    client.exceptions.HealthCheckVersionMismatch,
    client.exceptions.HostedZoneAlreadyExists,
    client.exceptions.HostedZoneNotEmpty,
    client.exceptions.HostedZoneNotFound,
    client.exceptions.HostedZoneNotPrivate,
    client.exceptions.HostedZonePartiallyDelegated,
    client.exceptions.IncompatibleVersion,
    client.exceptions.InsufficientCloudWatchLogsResourcePolicy,
    client.exceptions.InvalidArgument,
    client.exceptions.InvalidChangeBatch,
    client.exceptions.InvalidDomainName,
    client.exceptions.InvalidInput,
    client.exceptions.InvalidKMSArn,
    client.exceptions.InvalidKeySigningKeyName,
    client.exceptions.InvalidKeySigningKeyStatus,
    client.exceptions.InvalidPaginationToken,
    client.exceptions.InvalidSigningStatus,
    client.exceptions.InvalidTrafficPolicyDocument,
    client.exceptions.InvalidVPCId,
    client.exceptions.KeySigningKeyAlreadyExists,
    client.exceptions.KeySigningKeyInParentDSRecord,
    client.exceptions.KeySigningKeyInUse,
    client.exceptions.KeySigningKeyWithActiveStatusNotFound,
    client.exceptions.LastVPCAssociation,
    client.exceptions.LimitsExceeded,
    client.exceptions.NoSuchChange,
    client.exceptions.NoSuchCidrCollectionException,
    client.exceptions.NoSuchCidrLocationException,
    client.exceptions.NoSuchCloudWatchLogsLogGroup,
    client.exceptions.NoSuchDelegationSet,
    client.exceptions.NoSuchGeoLocation,
    client.exceptions.NoSuchHealthCheck,
    client.exceptions.NoSuchHostedZone,
    client.exceptions.NoSuchKeySigningKey,
    client.exceptions.NoSuchQueryLoggingConfig,
    client.exceptions.NoSuchTrafficPolicy,
    client.exceptions.NoSuchTrafficPolicyInstance,
    client.exceptions.NotAuthorizedException,
    client.exceptions.PriorRequestNotComplete,
    client.exceptions.PublicZoneVPCAssociation,
    client.exceptions.QueryLoggingConfigAlreadyExists,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyHealthChecks,
    client.exceptions.TooManyHostedZones,
    client.exceptions.TooManyKeySigningKeys,
    client.exceptions.TooManyTrafficPolicies,
    client.exceptions.TooManyTrafficPolicyInstances,
    client.exceptions.TooManyTrafficPolicyVersionsForCurrentPolicy,
    client.exceptions.TooManyVPCAssociationAuthorizations,
    client.exceptions.TrafficPolicyAlreadyExists,
    client.exceptions.TrafficPolicyInUse,
    client.exceptions.TrafficPolicyInstanceAlreadyExists,
    client.exceptions.VPCAssociationAuthorizationNotFound,
    client.exceptions.VPCAssociationNotFound,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_route53.client import Exceptions

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

Methods#

activate_key_signing_key#

Activates a key-signing key (KSK) so that it can be used for signing by DNSSEC.

Type annotations and code completion for boto3.client("route53").activate_key_signing_key method. boto3 documentation

# activate_key_signing_key method definition

def activate_key_signing_key(
    self,
    *,
    HostedZoneId: str,
    Name: str,
) -> ActivateKeySigningKeyResponseTypeDef:  # (1)
    ...
  1. See ActivateKeySigningKeyResponseTypeDef
# activate_key_signing_key method usage example with argument unpacking

kwargs: ActivateKeySigningKeyRequestRequestTypeDef = {  # (1)
    "HostedZoneId": ...,
    "Name": ...,
}

parent.activate_key_signing_key(**kwargs)
  1. See ActivateKeySigningKeyRequestRequestTypeDef

associate_vpc_with_hosted_zone#

Associates an Amazon VPC with a private hosted zone.

Type annotations and code completion for boto3.client("route53").associate_vpc_with_hosted_zone method. boto3 documentation

# associate_vpc_with_hosted_zone method definition

def associate_vpc_with_hosted_zone(
    self,
    *,
    HostedZoneId: str,
    VPC: VPCTypeDef,  # (1)
    Comment: str = ...,
) -> AssociateVPCWithHostedZoneResponseTypeDef:  # (2)
    ...
  1. See VPCTypeDef
  2. See AssociateVPCWithHostedZoneResponseTypeDef
# associate_vpc_with_hosted_zone method usage example with argument unpacking

kwargs: AssociateVPCWithHostedZoneRequestRequestTypeDef = {  # (1)
    "HostedZoneId": ...,
    "VPC": ...,
}

parent.associate_vpc_with_hosted_zone(**kwargs)
  1. See AssociateVPCWithHostedZoneRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

change_cidr_collection#

Creates, changes, or deletes CIDR blocks within a collection.

Type annotations and code completion for boto3.client("route53").change_cidr_collection method. boto3 documentation

# change_cidr_collection method definition

def change_cidr_collection(
    self,
    *,
    Id: str,
    Changes: Sequence[CidrCollectionChangeTypeDef],  # (1)
    CollectionVersion: int = ...,
) -> ChangeCidrCollectionResponseTypeDef:  # (2)
    ...
  1. See CidrCollectionChangeTypeDef
  2. See ChangeCidrCollectionResponseTypeDef
# change_cidr_collection method usage example with argument unpacking

kwargs: ChangeCidrCollectionRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "Changes": ...,
}

parent.change_cidr_collection(**kwargs)
  1. See ChangeCidrCollectionRequestRequestTypeDef

change_resource_record_sets#

Creates, changes, or deletes a resource record set, which contains authoritative DNS information for a specified domain name or subdomain name.

Type annotations and code completion for boto3.client("route53").change_resource_record_sets method. boto3 documentation

# change_resource_record_sets method definition

def change_resource_record_sets(
    self,
    *,
    HostedZoneId: str,
    ChangeBatch: ChangeBatchTypeDef,  # (1)
) -> ChangeResourceRecordSetsResponseTypeDef:  # (2)
    ...
  1. See ChangeBatchTypeDef
  2. See ChangeResourceRecordSetsResponseTypeDef
# change_resource_record_sets method usage example with argument unpacking

kwargs: ChangeResourceRecordSetsRequestRequestTypeDef = {  # (1)
    "HostedZoneId": ...,
    "ChangeBatch": ...,
}

parent.change_resource_record_sets(**kwargs)
  1. See ChangeResourceRecordSetsRequestRequestTypeDef

change_tags_for_resource#

Adds, edits, or deletes tags for a health check or a hosted zone.

Type annotations and code completion for boto3.client("route53").change_tags_for_resource method. boto3 documentation

# change_tags_for_resource method definition

def change_tags_for_resource(
    self,
    *,
    ResourceType: TagResourceTypeType,  # (1)
    ResourceId: str,
    AddTags: Sequence[TagTypeDef] = ...,  # (2)
    RemoveTagKeys: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
  1. See TagResourceTypeType
  2. See TagTypeDef
# change_tags_for_resource method usage example with argument unpacking

kwargs: ChangeTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "ResourceId": ...,
}

parent.change_tags_for_resource(**kwargs)
  1. See ChangeTagsForResourceRequestRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_cidr_collection#

Creates a CIDR collection in the current Amazon Web Services account.

Type annotations and code completion for boto3.client("route53").create_cidr_collection method. boto3 documentation

# create_cidr_collection method definition

def create_cidr_collection(
    self,
    *,
    Name: str,
    CallerReference: str,
) -> CreateCidrCollectionResponseTypeDef:  # (1)
    ...
  1. See CreateCidrCollectionResponseTypeDef
# create_cidr_collection method usage example with argument unpacking

kwargs: CreateCidrCollectionRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "CallerReference": ...,
}

parent.create_cidr_collection(**kwargs)
  1. See CreateCidrCollectionRequestRequestTypeDef

create_health_check#

Creates a new health check.

Type annotations and code completion for boto3.client("route53").create_health_check method. boto3 documentation

# create_health_check method definition

def create_health_check(
    self,
    *,
    CallerReference: str,
    HealthCheckConfig: HealthCheckConfigTypeDef,  # (1)
) -> CreateHealthCheckResponseTypeDef:  # (2)
    ...
  1. See HealthCheckConfigTypeDef
  2. See CreateHealthCheckResponseTypeDef
# create_health_check method usage example with argument unpacking

kwargs: CreateHealthCheckRequestRequestTypeDef = {  # (1)
    "CallerReference": ...,
    "HealthCheckConfig": ...,
}

parent.create_health_check(**kwargs)
  1. See CreateHealthCheckRequestRequestTypeDef

create_hosted_zone#

Creates a new public or private hosted zone.

Type annotations and code completion for boto3.client("route53").create_hosted_zone method. boto3 documentation

# create_hosted_zone method definition

def create_hosted_zone(
    self,
    *,
    Name: str,
    CallerReference: str,
    VPC: VPCTypeDef = ...,  # (1)
    HostedZoneConfig: HostedZoneConfigTypeDef = ...,  # (2)
    DelegationSetId: str = ...,
) -> CreateHostedZoneResponseTypeDef:  # (3)
    ...
  1. See VPCTypeDef
  2. See HostedZoneConfigTypeDef
  3. See CreateHostedZoneResponseTypeDef
# create_hosted_zone method usage example with argument unpacking

kwargs: CreateHostedZoneRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "CallerReference": ...,
}

parent.create_hosted_zone(**kwargs)
  1. See CreateHostedZoneRequestRequestTypeDef

create_key_signing_key#

Creates a new key-signing key (KSK) associated with a hosted zone.

Type annotations and code completion for boto3.client("route53").create_key_signing_key method.