aws_route53_domains
Amazon Route 53 API actions let you register domain names and perform related operations.
Summary
Functions
-
accept_domain_transfer_from_another_aws_account(Client, Input)
Accepts the transfer of a domain from another AWS account to the current AWS account.
- accept_domain_transfer_from_another_aws_account(Client, Input, Options)
-
cancel_domain_transfer_to_another_aws_account(Client, Input)
Cancels the transfer of a domain from the current AWS account to another AWS account.
- cancel_domain_transfer_to_another_aws_account(Client, Input, Options)
-
check_domain_availability(Client, Input)
This operation checks the availability of one domain name.
- check_domain_availability(Client, Input, Options)
-
check_domain_transferability(Client, Input)
Checks whether a domain name can be transferred to Amazon Route 53.
- check_domain_transferability(Client, Input, Options)
-
delete_tags_for_domain(Client, Input)
This operation deletes the specified tags for a domain.
- delete_tags_for_domain(Client, Input, Options)
-
disable_domain_auto_renew(Client, Input)
This operation disables automatic renewal of domain registration for the specified domain.
- disable_domain_auto_renew(Client, Input, Options)
-
disable_domain_transfer_lock(Client, Input)
This operation removes the transfer lock on the domain (specifically the
clientTransferProhibited
status) to allow domain transfers. - disable_domain_transfer_lock(Client, Input, Options)
-
enable_domain_auto_renew(Client, Input)
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires.
- enable_domain_auto_renew(Client, Input, Options)
-
enable_domain_transfer_lock(Client, Input)
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited
status) to prevent domain transfers. - enable_domain_transfer_lock(Client, Input, Options)
-
get_contact_reachability_status(Client, Input)
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.
- get_contact_reachability_status(Client, Input, Options)
-
get_domain_detail(Client, Input)
This operation returns detailed information about a specified domain that is associated with the current AWS account.
- get_domain_detail(Client, Input, Options)
-
get_domain_suggestions(Client, Input)
The GetDomainSuggestions operation returns a list of suggested domain names.
- get_domain_suggestions(Client, Input, Options)
-
get_operation_detail(Client, Input)
This operation returns the current status of an operation that is not completed.
- get_operation_detail(Client, Input, Options)
-
list_domains(Client, Input)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
- list_domains(Client, Input, Options)
-
list_operations(Client, Input)
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.
- list_operations(Client, Input, Options)
-
list_tags_for_domain(Client, Input)
This operation returns all of the tags that are associated with the specified domain.
- list_tags_for_domain(Client, Input, Options)
-
register_domain(Client, Input)
This operation registers a domain.
- register_domain(Client, Input, Options)
-
reject_domain_transfer_from_another_aws_account(Client, Input)
Rejects the transfer of a domain from another AWS account to the current AWS account.
- reject_domain_transfer_from_another_aws_account(Client, Input, Options)
-
renew_domain(Client, Input)
This operation renews a domain for the specified number of years.
- renew_domain(Client, Input, Options)
-
resend_contact_reachability_email(Client, Input)
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.
- resend_contact_reachability_email(Client, Input, Options)
-
retrieve_domain_auth_code(Client, Input)
This operation returns the AuthCode for the domain.
- retrieve_domain_auth_code(Client, Input, Options)
-
transfer_domain(Client, Input)
Transfers a domain from another registrar to Amazon Route 53.
- transfer_domain(Client, Input, Options)
-
transfer_domain_to_another_aws_account(Client, Input)
Transfers a domain from the current AWS account to another AWS account.
- transfer_domain_to_another_aws_account(Client, Input, Options)
-
update_domain_contact(Client, Input)
This operation updates the contact information for a particular domain.
- update_domain_contact(Client, Input, Options)
-
update_domain_contact_privacy(Client, Input)
This operation updates the specified domain contact's privacy setting.
- update_domain_contact_privacy(Client, Input, Options)
-
update_domain_nameservers(Client, Input)
This operation replaces the current set of name servers for the domain with the specified set of name servers.
- update_domain_nameservers(Client, Input, Options)
-
update_tags_for_domain(Client, Input)
This operation adds or updates tags for a specified domain.
- update_tags_for_domain(Client, Input, Options)
-
view_billing(Client, Input)
Returns all the domain-related billing records for the current AWS account for a specified period.
- view_billing(Client, Input, Options)
Functions
accept_domain_transfer_from_another_aws_account(Client, Input)
Accepts the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,Domain Transfer from
Aws Account 111122223333 has been cancelled
.
accept_domain_transfer_from_another_aws_account(Client, Input, Options)
cancel_domain_transfer_to_another_aws_account(Client, Input)
Cancels the transfer of a domain from the current AWS account to another AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount.
Domain Transfer from
Aws Account 111122223333 has been cancelled
.
cancel_domain_transfer_to_another_aws_account(Client, Input, Options)
check_domain_availability(Client, Input)
This operation checks the availability of one domain name. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.
check_domain_availability(Client, Input, Options)
check_domain_transferability(Client, Input)
Checks whether a domain name can be transferred to Amazon Route 53.
check_domain_transferability(Client, Input, Options)
delete_tags_for_domain(Client, Input)
This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.delete_tags_for_domain(Client, Input, Options)
disable_domain_auto_renew(Client, Input)
This operation disables automatic renewal of domain registration for the specified domain.
disable_domain_auto_renew(Client, Input, Options)
disable_domain_transfer_lock(Client, Input)
This operation removes the transfer lock on the domain (specifically
the clientTransferProhibited
status) to allow domain
transfers. We recommend you refrain from performing this action unless you
intend to transfer the domain to a different registrar. Successful
submission returns an operation ID that you can use to track the progress
and completion of the action. If the request is not completed
successfully, the domain registrant will be notified by email.
disable_domain_transfer_lock(Client, Input, Options)
enable_domain_auto_renew(Client, Input)
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.enable_domain_auto_renew(Client, Input, Options)
enable_domain_transfer_lock(Client, Input)
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited
status) to prevent domain transfers.
Successful submission returns an operation ID that you can use to track
the progress and completion of the action. If the request is not completed
successfully, the domain registrant will be notified by email.
enable_domain_transfer_lock(Client, Input, Options)
get_contact_reachability_status(Client, Input)
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.
If you want us to resend the email, use theResendContactReachabilityEmail
operation.
get_contact_reachability_status(Client, Input, Options)
get_domain_detail(Client, Input)
This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.
get_domain_detail(Client, Input, Options)
get_domain_suggestions(Client, Input)
The GetDomainSuggestions operation returns a list of suggested domain names.
get_domain_suggestions(Client, Input, Options)
get_operation_detail(Client, Input)
This operation returns the current status of an operation that is not completed.
get_operation_detail(Client, Input, Options)
list_domains(Client, Input)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
list_domains(Client, Input, Options)
list_operations(Client, Input)
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.
list_operations(Client, Input, Options)
list_tags_for_domain(Client, Input)
This operation returns all of the tags that are associated with the specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.list_tags_for_domain(Client, Input, Options)
register_domain(Client, Input)
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.
If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
register_domain(Client, Input, Options)
reject_domain_transfer_from_another_aws_account(Client, Input)
Rejects the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount.
Use either ListOperations or GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,Domain Transfer from
Aws Account 111122223333 has been cancelled
.
reject_domain_transfer_from_another_aws_account(Client, Input, Options)
renew_domain(Client, Input)
This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.renew_domain(Client, Input, Options)
resend_contact_reachability_email(Client, Input)
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.
resend_contact_reachability_email(Client, Input, Options)
retrieve_domain_auth_code(Client, Input)
This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
retrieve_domain_auth_code(Client, Input, Options)
transfer_domain(Client, Input)
Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
For more information about transferring domains, see the following topics:
For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
For information about how to transfer a domain from one AWS account to another, see TransferDomainToAnotherAwsAccount.
For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.
transfer_domain(Client, Input, Options)
transfer_domain_to_another_aws_account(Client, Input)
Transfers a domain from the current AWS account to another AWS account. Note the following:
The AWS account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.
Domain Transfer from
Aws Account 111122223333 has been cancelled
.
transfer_domain_to_another_aws_account(Client, Input, Options)
update_domain_contact(Client, Input)
This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.update_domain_contact(Client, Input, Options)
update_domain_contact_privacy(Client, Input)
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.
This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
UpdateDomainContactPrivacy
or the Route 53 console. Enabling
privacy protection removes the contact information provided for this
domain from the WHOIS database. For more information on our privacy
practices, see https://aws.amazon.com/privacy/.
update_domain_contact_privacy(Client, Input, Options)
update_domain_nameservers(Client, Input)
This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.update_domain_nameservers(Client, Input, Options)
update_tags_for_domain(Client, Input)
This operation adds or updates tags for a specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.update_tags_for_domain(Client, Input, Options)
view_billing(Client, Input)
Returns all the domain-related billing records for the current AWS account for a specified period