Skip to content

Route53DomainsClient#

Index > Route53Domains > Route53DomainsClient

Auto-generated documentation for Route53Domains type annotations stubs module mypy-boto3-route53domains.

Route53DomainsClient#

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

# Route53DomainsClient usage example

from boto3.session import Session
from mypy_boto3_route53domains.client import Route53DomainsClient

def get_route53domains_client() -> Route53DomainsClient:
    return Session().client("route53domains")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("route53domains")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.DnssecLimitExceeded,
    client.exceptions.DomainLimitExceeded,
    client.exceptions.DuplicateRequest,
    client.exceptions.InvalidInput,
    client.exceptions.OperationLimitExceeded,
    client.exceptions.TLDRulesViolation,
    client.exceptions.UnsupportedTLD,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_route53domains.client import Exceptions

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

Methods#

accept_domain_transfer_from_another_aws_account#

Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account.

Type annotations and code completion for boto3.client("route53domains").accept_domain_transfer_from_another_aws_account method. boto3 documentation

# accept_domain_transfer_from_another_aws_account method definition

def accept_domain_transfer_from_another_aws_account(
    self,
    *,
    DomainName: str,
    Password: str,
) -> AcceptDomainTransferFromAnotherAwsAccountResponseTypeDef:  # (1)
    ...
  1. See AcceptDomainTransferFromAnotherAwsAccountResponseTypeDef 
# accept_domain_transfer_from_another_aws_account method usage example with argument unpacking

kwargs: AcceptDomainTransferFromAnotherAwsAccountRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Password": ...,
}

parent.accept_domain_transfer_from_another_aws_account(**kwargs)
  1. See AcceptDomainTransferFromAnotherAwsAccountRequestRequestTypeDef

associate_delegation_signer_to_domain#

Creates a delegation signer (DS) record in the registry zone for this domain name.

Type annotations and code completion for boto3.client("route53domains").associate_delegation_signer_to_domain method. boto3 documentation

# associate_delegation_signer_to_domain method definition

def associate_delegation_signer_to_domain(
    self,
    *,
    DomainName: str,
    SigningAttributes: DnssecSigningAttributesTypeDef,  # (1)
) -> AssociateDelegationSignerToDomainResponseTypeDef:  # (2)
    ...
  1. See DnssecSigningAttributesTypeDef
  2. See AssociateDelegationSignerToDomainResponseTypeDef 
# associate_delegation_signer_to_domain method usage example with argument unpacking

kwargs: AssociateDelegationSignerToDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "SigningAttributes": ...,
}

parent.associate_delegation_signer_to_domain(**kwargs)
  1. See AssociateDelegationSignerToDomainRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

cancel_domain_transfer_to_another_aws_account#

Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account.

Type annotations and code completion for boto3.client("route53domains").cancel_domain_transfer_to_another_aws_account method. boto3 documentation

# cancel_domain_transfer_to_another_aws_account method definition

def cancel_domain_transfer_to_another_aws_account(
    self,
    *,
    DomainName: str,
) -> CancelDomainTransferToAnotherAwsAccountResponseTypeDef:  # (1)
    ...
  1. See CancelDomainTransferToAnotherAwsAccountResponseTypeDef 
# cancel_domain_transfer_to_another_aws_account method usage example with argument unpacking

kwargs: CancelDomainTransferToAnotherAwsAccountRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.cancel_domain_transfer_to_another_aws_account(**kwargs)
  1. See CancelDomainTransferToAnotherAwsAccountRequestRequestTypeDef

check_domain_availability#

This operation checks the availability of one domain name.

Type annotations and code completion for boto3.client("route53domains").check_domain_availability method. boto3 documentation

# check_domain_availability method definition

def check_domain_availability(
    self,
    *,
    DomainName: str,
    IdnLangCode: str = ...,
) -> CheckDomainAvailabilityResponseTypeDef:  # (1)
    ...
  1. See CheckDomainAvailabilityResponseTypeDef 
# check_domain_availability method usage example with argument unpacking

kwargs: CheckDomainAvailabilityRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.check_domain_availability(**kwargs)
  1. See CheckDomainAvailabilityRequestRequestTypeDef

check_domain_transferability#

Checks whether a domain name can be transferred to Amazon Route 53.

Type annotations and code completion for boto3.client("route53domains").check_domain_transferability method. boto3 documentation

# check_domain_transferability method definition

def check_domain_transferability(
    self,
    *,
    DomainName: str,
    AuthCode: str = ...,
) -> CheckDomainTransferabilityResponseTypeDef:  # (1)
    ...
  1. See CheckDomainTransferabilityResponseTypeDef 
# check_domain_transferability method usage example with argument unpacking

kwargs: CheckDomainTransferabilityRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.check_domain_transferability(**kwargs)
  1. See CheckDomainTransferabilityRequestRequestTypeDef

close#

Closes underlying endpoint connections.

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

# close method definition

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

delete_domain#

This operation deletes the specified domain.

Type annotations and code completion for boto3.client("route53domains").delete_domain method. boto3 documentation

# delete_domain method definition

def delete_domain(
    self,
    *,
    DomainName: str,
) -> DeleteDomainResponseTypeDef:  # (1)
    ...
  1. See DeleteDomainResponseTypeDef 
# delete_domain method usage example with argument unpacking

kwargs: DeleteDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.delete_domain(**kwargs)
  1. See DeleteDomainRequestRequestTypeDef

delete_tags_for_domain#

This operation deletes the specified tags for a domain.

Type annotations and code completion for boto3.client("route53domains").delete_tags_for_domain method. boto3 documentation

# delete_tags_for_domain method definition

def delete_tags_for_domain(
    self,
    *,
    DomainName: str,
    TagsToDelete: Sequence[str],
) -> Dict[str, Any]:
    ...
# delete_tags_for_domain method usage example with argument unpacking

kwargs: DeleteTagsForDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "TagsToDelete": ...,
}

parent.delete_tags_for_domain(**kwargs)
  1. See DeleteTagsForDomainRequestRequestTypeDef

disable_domain_auto_renew#

This operation disables automatic renewal of domain registration for the specified domain.

Type annotations and code completion for boto3.client("route53domains").disable_domain_auto_renew method. boto3 documentation

# disable_domain_auto_renew method definition

def disable_domain_auto_renew(
    self,
    *,
    DomainName: str,
) -> Dict[str, Any]:
    ...
# disable_domain_auto_renew method usage example with argument unpacking

kwargs: DisableDomainAutoRenewRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.disable_domain_auto_renew(**kwargs)
  1. See DisableDomainAutoRenewRequestRequestTypeDef

disable_domain_transfer_lock#

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers.

Type annotations and code completion for boto3.client("route53domains").disable_domain_transfer_lock method. boto3 documentation

# disable_domain_transfer_lock method definition

def disable_domain_transfer_lock(
    self,
    *,
    DomainName: str,
) -> DisableDomainTransferLockResponseTypeDef:  # (1)
    ...
  1. See DisableDomainTransferLockResponseTypeDef 
# disable_domain_transfer_lock method usage example with argument unpacking

kwargs: DisableDomainTransferLockRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.disable_domain_transfer_lock(**kwargs)
  1. See DisableDomainTransferLockRequestRequestTypeDef

disassociate_delegation_signer_from_domain#

Deletes a delegation signer (DS) record in the registry zone for this domain name.

Type annotations and code completion for boto3.client("route53domains").disassociate_delegation_signer_from_domain method. boto3 documentation

# disassociate_delegation_signer_from_domain method definition

def disassociate_delegation_signer_from_domain(
    self,
    *,
    DomainName: str,
    Id: str,
) -> DisassociateDelegationSignerFromDomainResponseTypeDef:  # (1)
    ...
  1. See DisassociateDelegationSignerFromDomainResponseTypeDef 
# disassociate_delegation_signer_from_domain method usage example with argument unpacking

kwargs: DisassociateDelegationSignerFromDomainRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "Id": ...,
}

parent.disassociate_delegation_signer_from_domain(**kwargs)
  1. See DisassociateDelegationSignerFromDomainRequestRequestTypeDef

enable_domain_auto_renew#

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires.

Type annotations and code completion for boto3.client("route53domains").enable_domain_auto_renew method. boto3 documentation

# enable_domain_auto_renew method definition

def enable_domain_auto_renew(
    self,
    *,
    DomainName: str,
) -> Dict[str, Any]:
    ...
# enable_domain_auto_renew method usage example with argument unpacking

kwargs: EnableDomainAutoRenewRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.enable_domain_auto_renew(**kwargs)
  1. See EnableDomainAutoRenewRequestRequestTypeDef

enable_domain_transfer_lock#

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers.

Type annotations and code completion for boto3.client("route53domains").enable_domain_transfer_lock method. boto3 documentation

# enable_domain_transfer_lock method definition

def enable_domain_transfer_lock(
    self,
    *,
    DomainName: str,
) -> EnableDomainTransferLockResponseTypeDef:  # (1)
    ...
  1. See EnableDomainTransferLockResponseTypeDef 
# enable_domain_transfer_lock method usage example with argument unpacking

kwargs: EnableDomainTransferLockRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.enable_domain_transfer_lock(**kwargs)
  1. See EnableDomainTransferLockRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("route53domains").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_contact_reachability_status#

For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation returns information about whether the registrant contact has responded.

Type annotations and code completion for boto3.client("route53domains").get_contact_reachability_status method. boto3 documentation

# get_contact_reachability_status method definition

def get_contact_reachability_status(
    self,
    *,
    domainName: str = ...,
) -> GetContactReachabilityStatusResponseTypeDef:  # (1)
    ...
  1. See GetContactReachabilityStatusResponseTypeDef 
# get_contact_reachability_status method usage example with argument unpacking

kwargs: GetContactReachabilityStatusRequestRequestTypeDef = {  # (1)
    "domainName": ...,
}

parent.get_contact_reachability_status(**kwargs)
  1. See GetContactReachabilityStatusRequestRequestTypeDef

get_domain_detail#

This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account.

Type annotations and code completion for boto3.client("route53domains").get_domain_detail method. boto3 documentation

# get_domain_detail method definition

def get_domain_detail(
    self,
    *,
    DomainName: str,
) -> GetDomainDetailResponseTypeDef:  # (1)
    ...
  1. See GetDomainDetailResponseTypeDef 
# get_domain_detail method usage example with argument unpacking

kwargs: GetDomainDetailRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
}

parent.get_domain_detail(**kwargs)
  1. See GetDomainDetailRequestRequestTypeDef

get_domain_suggestions#

The GetDomainSuggestions operation returns a list of suggested domain names.

Type annotations and code completion for boto3.client("route53domains").get_domain_suggestions method. boto3 documentation

# get_domain_suggestions method definition

def get_domain_suggestions(
    self,
    *,
    DomainName: str,
    SuggestionCount: int,
    OnlyAvailable: bool,
) -> GetDomainSuggestionsResponseTypeDef:  # (1)
    ...
  1. See GetDomainSuggestionsResponseTypeDef 
# get_domain_suggestions method usage example with argument unpacking

kwargs: GetDomainSuggestionsRequestRequestTypeDef = {  # (1)
    "DomainName": ...,
    "SuggestionCount": ...,
    "OnlyAvailable": ...,
}

parent.get_domain_suggestions(**kwargs)
  1. See GetDomainSuggestionsRequestRequestTypeDef

get_operation_detail#

This operation returns the current status of an operation that is not completed.

Type annotations and code completion for boto3.client("route53domains").get_operation_detail method. boto3 documentation

# get_operation_detail method definition

def get_operation_detail(
    self,
    *,
    OperationId: str,
) -> GetOperationDetailResponseTypeDef:  # (1)
    ...
  1. See GetOperationDetailResponseTypeDef 
# get_operation_detail method usage example with argument unpacking

kwargs: GetOperationDetailRequestRequestTypeDef = {  # (1)
    "OperationId": ...,
}

parent.get_operation_detail(**kwargs)
  1. See GetOperationDetailRequestRequestTypeDef

list_domains#

This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.

Type annotations and code completion for boto3.client("route53domains").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    FilterConditions: Sequence[FilterConditionTypeDef] = ...,  # (1)
    SortCondition: SortConditionTypeDef = ...,  # (2)
    Marker: str = ...,
    MaxItems: int = ...,
) -> ListDomainsResponseTypeDef:  # (3)
    ...
  1. See FilterConditionTypeDef
  2. See SortConditionTypeDef
  3. See ListDomainsResponseTypeDef 
# list_domains method usage example with argument unpacking

kwargs: ListDomainsRequestRequestTypeDef = {  # (1)
    "FilterConditions": ...,
}

parent.list_domains(**kwargs)
  1. See ListDomainsRequestRequestTypeDef

list_operations#

Returns information about all of the operations that return an operation ID and that have ever been performed on domains that were registered by the current account.

Type annotations and code completion for boto3.client("route53domains").list_operations method.