Route53DomainsClient
Index > Route53Domains > Route53DomainsClient
Auto-generated documentation for Route53Domains type annotations stubs module types-aiobotocore-route53domains.
Route53DomainsClient
Type annotations and code completion for session.client("route53domains")
boto3 documentation
from aioboto3.session import Session
from types_aiobotocore_route53domains.client import Route53DomainsClient
session = Session()
async with session.client("route53domains") as client:
client: Route53DomainsClient
Exceptions
aioboto3
client exceptions are generated in runtime.
This class provides code completion for session.client("route53domains").exceptions
structure.
async with session.client("route53domains") as client:
try:
do_something(client)
except (
client.ClientError,
client.DomainLimitExceeded,
client.DuplicateRequest,
client.InvalidInput,
client.OperationLimitExceeded,
client.TLDRulesViolation,
client.UnsupportedTLD,
) as e:
print(e)
from types_aiobotocore_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 session.client("route53domains").accept_domain_transfer_from_another_aws_account
method.
boto3 documentation
await def accept_domain_transfer_from_another_aws_account(
self,
*,
DomainName: str,
Password: str,
) -> AcceptDomainTransferFromAnotherAwsAccountResponseTypeDef: # (1)
...
kwargs: AcceptDomainTransferFromAnotherAwsAccountRequestRequestTypeDef = { # (1)
"DomainName": ...,
"Password": ...,
}
parent.accept_domain_transfer_from_another_aws_account(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for session.client("route53domains").can_paginate
method.
boto3 documentation
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 session.client("route53domains").cancel_domain_transfer_to_another_aws_account
method.
boto3 documentation
await def cancel_domain_transfer_to_another_aws_account(
self,
*,
DomainName: str,
) -> CancelDomainTransferToAnotherAwsAccountResponseTypeDef: # (1)
...
kwargs: CancelDomainTransferToAnotherAwsAccountRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.cancel_domain_transfer_to_another_aws_account(**kwargs)
check_domain_availability
This operation checks the availability of one domain name.
Type annotations and code completion for session.client("route53domains").check_domain_availability
method.
boto3 documentation
await def check_domain_availability(
self,
*,
DomainName: str,
IdnLangCode: str = ...,
) -> CheckDomainAvailabilityResponseTypeDef: # (1)
...
kwargs: CheckDomainAvailabilityRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.check_domain_availability(**kwargs)
check_domain_transferability
Checks whether a domain name can be transferred to Amazon Route 53.
Type annotations and code completion for session.client("route53domains").check_domain_transferability
method.
boto3 documentation
await def check_domain_transferability(
self,
*,
DomainName: str,
AuthCode: str = ...,
) -> CheckDomainTransferabilityResponseTypeDef: # (1)
...
kwargs: CheckDomainTransferabilityRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.check_domain_transferability(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for session.client("route53domains").close
method.
boto3 documentation
delete_domain
This operation deletes the specified domain.
Type annotations and code completion for session.client("route53domains").delete_domain
method.
boto3 documentation
await def delete_domain(
self,
*,
DomainName: str,
) -> DeleteDomainResponseTypeDef: # (1)
...
kwargs: DeleteDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.delete_domain(**kwargs)
delete_tags_for_domain
This operation deletes the specified tags for a domain.
Type annotations and code completion for session.client("route53domains").delete_tags_for_domain
method.
boto3 documentation
await def delete_tags_for_domain(
self,
*,
DomainName: str,
TagsToDelete: Sequence[str],
) -> Dict[str, Any]:
...
kwargs: DeleteTagsForDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
"TagsToDelete": ...,
}
parent.delete_tags_for_domain(**kwargs)
disable_domain_auto_renew
This operation disables automatic renewal of domain registration for the specified domain.
Type annotations and code completion for session.client("route53domains").disable_domain_auto_renew
method.
boto3 documentation
await def disable_domain_auto_renew(
self,
*,
DomainName: str,
) -> Dict[str, Any]:
...
kwargs: DisableDomainAutoRenewRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.disable_domain_auto_renew(**kwargs)
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 session.client("route53domains").disable_domain_transfer_lock
method.
boto3 documentation
await def disable_domain_transfer_lock(
self,
*,
DomainName: str,
) -> DisableDomainTransferLockResponseTypeDef: # (1)
...
kwargs: DisableDomainTransferLockRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.disable_domain_transfer_lock(**kwargs)
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 session.client("route53domains").enable_domain_auto_renew
method.
boto3 documentation
await def enable_domain_auto_renew(
self,
*,
DomainName: str,
) -> Dict[str, Any]:
...
kwargs: EnableDomainAutoRenewRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.enable_domain_auto_renew(**kwargs)
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 session.client("route53domains").enable_domain_transfer_lock
method.
boto3 documentation
await def enable_domain_transfer_lock(
self,
*,
DomainName: str,
) -> EnableDomainTransferLockResponseTypeDef: # (1)
...
kwargs: EnableDomainTransferLockRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.enable_domain_transfer_lock(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.client("route53domains").generate_presigned_url
method.
boto3 documentation
await 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 session.client("route53domains").get_contact_reachability_status
method.
boto3 documentation
await def get_contact_reachability_status(
self,
*,
domainName: str = ...,
) -> GetContactReachabilityStatusResponseTypeDef: # (1)
...
kwargs: GetContactReachabilityStatusRequestRequestTypeDef = { # (1)
"domainName": ...,
}
parent.get_contact_reachability_status(**kwargs)
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 session.client("route53domains").get_domain_detail
method.
boto3 documentation
await def get_domain_detail(
self,
*,
DomainName: str,
) -> GetDomainDetailResponseTypeDef: # (1)
...
kwargs: GetDomainDetailRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.get_domain_detail(**kwargs)
get_domain_suggestions
The GetDomainSuggestions operation returns a list of suggested domain names.
Type annotations and code completion for session.client("route53domains").get_domain_suggestions
method.
boto3 documentation
await def get_domain_suggestions(
self,
*,
DomainName: str,
SuggestionCount: int,
OnlyAvailable: bool,
) -> GetDomainSuggestionsResponseTypeDef: # (1)
...
kwargs: GetDomainSuggestionsRequestRequestTypeDef = { # (1)
"DomainName": ...,
"SuggestionCount": ...,
"OnlyAvailable": ...,
}
parent.get_domain_suggestions(**kwargs)
get_operation_detail
This operation returns the current status of an operation that is not completed.
Type annotations and code completion for session.client("route53domains").get_operation_detail
method.
boto3 documentation
await def get_operation_detail(
self,
*,
OperationId: str,
) -> GetOperationDetailResponseTypeDef: # (1)
...
kwargs: GetOperationDetailRequestRequestTypeDef = { # (1)
"OperationId": ...,
}
parent.get_operation_detail(**kwargs)
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 session.client("route53domains").list_domains
method.
boto3 documentation
await def list_domains(
self,
*,
FilterConditions: Sequence[FilterConditionTypeDef] = ..., # (1)
SortCondition: SortConditionTypeDef = ..., # (2)
Marker: str = ...,
MaxItems: int = ...,
) -> ListDomainsResponseTypeDef: # (3)
...
kwargs: ListDomainsRequestRequestTypeDef = { # (1)
"FilterConditions": ...,
}
parent.list_domains(**kwargs)
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 session.client("route53domains").list_operations
method.
boto3 documentation
await def list_operations(
self,
*,
SubmittedSince: Union[datetime, str] = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListOperationsResponseTypeDef: # (1)
...
kwargs: ListOperationsRequestRequestTypeDef = { # (1)
"SubmittedSince": ...,
}
parent.list_operations(**kwargs)
list_prices
Lists the following prices for either all the TLDs supported by Route 53, or the
specified TLD * Registration * Transfer * Owner change * Domain renewal * Domain
restoration See also: AWS API Documentation
<https://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-1...
.
Type annotations and code completion for session.client("route53domains").list_prices
method.
boto3 documentation
await def list_prices(
self,
*,
Tld: str = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ListPricesResponseTypeDef: # (1)
...
kwargs: ListPricesRequestRequestTypeDef = { # (1)
"Tld": ...,
}
parent.list_prices(**kwargs)
list_tags_for_domain
This operation returns all of the tags that are associated with the specified domain.
Type annotations and code completion for session.client("route53domains").list_tags_for_domain
method.
boto3 documentation
await def list_tags_for_domain(
self,
*,
DomainName: str,
) -> ListTagsForDomainResponseTypeDef: # (1)
...
kwargs: ListTagsForDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.list_tags_for_domain(**kwargs)
register_domain
This operation registers a domain.
Type annotations and code completion for session.client("route53domains").register_domain
method.
boto3 documentation
await def register_domain(
self,
*,
DomainName: str,
DurationInYears: int,
AdminContact: ContactDetailTypeDef, # (1)
RegistrantContact: ContactDetailTypeDef, # (1)
TechContact: ContactDetailTypeDef, # (1)
IdnLangCode: str = ...,
AutoRenew: bool = ...,
PrivacyProtectAdminContact: bool = ...,
PrivacyProtectRegistrantContact: bool = ...,
PrivacyProtectTechContact: bool = ...,
) -> RegisterDomainResponseTypeDef: # (4)
...
- See ContactDetailTypeDef
- See ContactDetailTypeDef
- See ContactDetailTypeDef
- See RegisterDomainResponseTypeDef
kwargs: RegisterDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
"DurationInYears": ...,
"AdminContact": ...,
"RegistrantContact": ...,
"TechContact": ...,
}
parent.register_domain(**kwargs)
reject_domain_transfer_from_another_aws_account
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account.
Type annotations and code completion for session.client("route53domains").reject_domain_transfer_from_another_aws_account
method.
boto3 documentation
await def reject_domain_transfer_from_another_aws_account(
self,
*,
DomainName: str,
) -> RejectDomainTransferFromAnotherAwsAccountResponseTypeDef: # (1)
...
kwargs: RejectDomainTransferFromAnotherAwsAccountRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.reject_domain_transfer_from_another_aws_account(**kwargs)
renew_domain
This operation renews a domain for the specified number of years.
Type annotations and code completion for session.client("route53domains").renew_domain
method.
boto3 documentation
await def renew_domain(
self,
*,
DomainName: str,
CurrentExpiryYear: int,
DurationInYears: int = ...,
) -> RenewDomainResponseTypeDef: # (1)
...
kwargs: RenewDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
"CurrentExpiryYear": ...,
}
parent.renew_domain(**kwargs)
resend_contact_reachability_email
For operations that require confirmation that the email address for the registrant contact is valid, such as registering a new domain, this operation resends the confirmation email to the current email address for the registrant contact.
Type annotations and code completion for session.client("route53domains").resend_contact_reachability_email
method.
boto3 documentation
await def resend_contact_reachability_email(
self,
*,
domainName: str = ...,
) -> ResendContactReachabilityEmailResponseTypeDef: # (1)
...
kwargs: ResendContactReachabilityEmailRequestRequestTypeDef = { # (1)
"domainName": ...,
}
parent.resend_contact_reachability_email(**kwargs)
retrieve_domain_auth_code
This operation returns the AuthCode for the domain.
Type annotations and code completion for session.client("route53domains").retrieve_domain_auth_code
method.
boto3 documentation
await def retrieve_domain_auth_code(
self,
*,
DomainName: str,
) -> RetrieveDomainAuthCodeResponseTypeDef: # (1)
...
kwargs: RetrieveDomainAuthCodeRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.retrieve_domain_auth_code(**kwargs)
transfer_domain
Transfers a domain from another registrar to Amazon Route 53.
Type annotations and code completion for session.client("route53domains").transfer_domain
method.
boto3 documentation
await def transfer_domain(
self,
*,
DomainName: str,
DurationInYears: int,
AdminContact: ContactDetailTypeDef, # (1)
RegistrantContact: ContactDetailTypeDef, # (1)
TechContact: ContactDetailTypeDef, # (1)
IdnLangCode: str = ...,
Nameservers: Sequence[NameserverTypeDef] = ..., # (4)
AuthCode: str = ...,
AutoRenew: bool = ...,
PrivacyProtectAdminContact: bool = ...,
PrivacyProtectRegistrantContact: bool = ...,
PrivacyProtectTechContact: bool = ...,
) -> TransferDomainResponseTypeDef: # (5)
...
- See ContactDetailTypeDef
- See ContactDetailTypeDef
- See ContactDetailTypeDef
- See NameserverTypeDef
- See TransferDomainResponseTypeDef
kwargs: TransferDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
"DurationInYears": ...,
"AdminContact": ...,
"RegistrantContact": ...,
"TechContact": ...,
}
parent.transfer_domain(**kwargs)
transfer_domain_to_another_aws_account
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account.
Type annotations and code completion for session.client("route53domains").transfer_domain_to_another_aws_account
method.
boto3 documentation
await def transfer_domain_to_another_aws_account(
self,
*,
DomainName: str,
AccountId: str,
) -> TransferDomainToAnotherAwsAccountResponseTypeDef: # (1)
...
kwargs: TransferDomainToAnotherAwsAccountRequestRequestTypeDef = { # (1)
"DomainName": ...,
"AccountId": ...,
}
parent.transfer_domain_to_another_aws_account(**kwargs)
update_domain_contact
This operation updates the contact information for a particular domain.
Type annotations and code completion for session.client("route53domains").update_domain_contact
method.
boto3 documentation
await def update_domain_contact(
self,
*,
DomainName: str,
AdminContact: ContactDetailTypeDef = ..., # (1)
RegistrantContact: ContactDetailTypeDef = ..., # (1)
TechContact: ContactDetailTypeDef = ..., # (1)
) -> UpdateDomainContactResponseTypeDef: # (4)
...
- See ContactDetailTypeDef
- See ContactDetailTypeDef
- See ContactDetailTypeDef
- See UpdateDomainContactResponseTypeDef
kwargs: UpdateDomainContactRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.update_domain_contact(**kwargs)
update_domain_contact_privacy
This operation updates the specified domain contact's privacy setting.
Type annotations and code completion for session.client("route53domains").update_domain_contact_privacy
method.
boto3 documentation
await def update_domain_contact_privacy(
self,
*,
DomainName: str,
AdminPrivacy: bool = ...,
RegistrantPrivacy: bool = ...,
TechPrivacy: bool = ...,
) -> UpdateDomainContactPrivacyResponseTypeDef: # (1)
...
kwargs: UpdateDomainContactPrivacyRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.update_domain_contact_privacy(**kwargs)
update_domain_nameservers
This operation replaces the current set of name servers for the domain with the specified set of name servers.
Type annotations and code completion for session.client("route53domains").update_domain_nameservers
method.
boto3 documentation
await def update_domain_nameservers(
self,
*,
DomainName: str,
Nameservers: Sequence[NameserverTypeDef], # (1)
FIAuthKey: str = ...,
) -> UpdateDomainNameserversResponseTypeDef: # (2)
...
kwargs: UpdateDomainNameserversRequestRequestTypeDef = { # (1)
"DomainName": ...,
"Nameservers": ...,
}
parent.update_domain_nameservers(**kwargs)
update_tags_for_domain
This operation adds or updates tags for a specified domain.
Type annotations and code completion for session.client("route53domains").update_tags_for_domain
method.
boto3 documentation
await def update_tags_for_domain(
self,
*,
DomainName: str,
TagsToUpdate: Sequence[TagTypeDef] = ..., # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: UpdateTagsForDomainRequestRequestTypeDef = { # (1)
"DomainName": ...,
}
parent.update_tags_for_domain(**kwargs)
view_billing
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period See also: AWS API Documentation.
Type annotations and code completion for session.client("route53domains").view_billing
method.
boto3 documentation
await def view_billing(
self,
*,
Start: Union[datetime, str] = ...,
End: Union[datetime, str] = ...,
Marker: str = ...,
MaxItems: int = ...,
) -> ViewBillingResponseTypeDef: # (1)
...
kwargs: ViewBillingRequestRequestTypeDef = { # (1)
"Start": ...,
}
parent.view_billing(**kwargs)
__aenter__
Type annotations and code completion for session.client("route53domains").__aenter__
method.
boto3 documentation
__aexit__
Type annotations and code completion for session.client("route53domains").__aexit__
method.
boto3 documentation
get_paginator
Type annotations and code completion for session.client("route53domains").get_paginator
method with overloads.
client.get_paginator("list_domains")
-> ListDomainsPaginatorclient.get_paginator("list_operations")
-> ListOperationsPaginatorclient.get_paginator("list_prices")
-> ListPricesPaginatorclient.get_paginator("view_billing")
-> ViewBillingPaginator