AWS.Route53Domains (aws-elixir v0.8.0) View Source

Amazon Route 53 API actions let you register domain names and perform related operations.

Link to this section Summary

Functions

Accepts the transfer of a domain from another AWS account to the current AWS account.

Cancels the transfer of a domain from the current AWS account to another AWS account.

This operation checks the availability of one domain name.

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

This operation deletes the specified tags for a domain.

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

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

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

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

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.

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

The GetDomainSuggestions operation returns a list of suggested domain names.

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

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

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.

This operation returns all of the tags that are associated with the specified domain.

This operation registers a domain.

Rejects the transfer of a domain from another AWS account to the current AWS account.

This operation renews a domain for the specified number of years.

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.

This operation returns the AuthCode for the domain.

Transfers a domain from another registrar to Amazon Route 53.

Transfers a domain from the current AWS account to another AWS account.

This operation updates the contact information for a particular domain.

This operation updates the specified domain contact's privacy setting.

This operation replaces the current set of name servers for the domain with the specified set of name servers.

This operation adds or updates tags for a specified domain.

Returns all the domain-related billing records for the current AWS account for a specified period

Link to this section Functions

Link to this function

accept_domain_transfer_from_another_aws_account(client, input, options \\ [])

View Source

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.

Link to this function

cancel_domain_transfer_to_another_aws_account(client, input, options \\ [])

View Source

Cancels the transfer of a domain from the current AWS account to another AWS account.

You initiate a transfer between AWS accounts using TransferDomainToAnotherAwsAccount. You must cancel the transfer before the other AWS account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount.

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.

Link to this function

check_domain_availability(client, input, options \\ [])

View Source

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.

Link to this function

check_domain_transferability(client, input, options \\ [])

View Source

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

Link to this function

delete_tags_for_domain(client, input, options \\ [])

View Source

This operation deletes the specified tags for a domain.

All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.

Link to this function

disable_domain_auto_renew(client, input, options \\ [])

View Source

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

Link to this function

disable_domain_transfer_lock(client, input, options \\ [])

View Source

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.

Link to this function

enable_domain_auto_renew(client, input, options \\ [])

View Source

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.

Link to this function

enable_domain_transfer_lock(client, input, options \\ [])

View Source

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.

Link to this function

get_contact_reachability_status(client, input, options \\ [])

View Source

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 the ResendContactReachabilityEmail operation.

Link to this function

get_domain_detail(client, input, options \\ [])

View Source

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.

Link to this function

get_domain_suggestions(client, input, options \\ [])

View Source

The GetDomainSuggestions operation returns a list of suggested domain names.

Link to this function

get_operation_detail(client, input, options \\ [])

View Source

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

Link to this function

list_domains(client, input, options \\ [])

View Source

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

Link to this function

list_operations(client, input, options \\ [])

View Source

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.

Link to this function

list_tags_for_domain(client, input, options \\ [])

View Source

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.

Link to this function

register_domain(client, input, options \\ [])

View Source

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.

Link to this function

reject_domain_transfer_from_another_aws_account(client, input, options \\ [])

View Source

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.

Link to this function

renew_domain(client, input, options \\ [])

View Source

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.

Link to this function

resend_contact_reachability_email(client, input, options \\ [])

View Source

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.

Link to this function

retrieve_domain_auth_code(client, input, options \\ [])

View Source

This operation returns the AuthCode for the domain.

To transfer a domain to another registrar, you provide this value to the new registrar.

Link to this function

transfer_domain(client, input, options \\ [])

View Source

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:

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.

If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

Link to this function

transfer_domain_to_another_aws_account(client, input, options \\ [])

View Source

Transfers a domain from the current AWS account to another AWS account.

Note the following:

When you transfer a domain from one AWS account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another AWS account, see Migrating a Hosted Zone to a Different AWS Account in the Amazon Route 53 Developer Guide.

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.

Link to this function

update_domain_contact(client, input, options \\ [])

View Source

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.

Link to this function

update_domain_contact_privacy(client, input, options \\ [])

View Source

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.

By disabling the privacy service via API, you consent to the publication of the contact information provided for this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection using either 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/.

Link to this function

update_domain_nameservers(client, input, options \\ [])

View Source

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.

Link to this function

update_tags_for_domain(client, input, options \\ [])

View Source

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.

Link to this function

view_billing(client, input, options \\ [])

View Source

Returns all the domain-related billing records for the current AWS account for a specified period