ExAws.Route53Domains.Core

Amazon Route 53 Domains

Source

Summary

check_domain_availability!(client, input)

Same as check_domain_availability/2 but raise on error

check_domain_availability(client, input)

CheckDomainAvailability

delete_tags_for_domain!(client, input)

Same as delete_tags_for_domain/2 but raise on error

delete_tags_for_domain(client, input)

DeleteTagsForDomain

disable_domain_auto_renew!(client, input)

Same as disable_domain_auto_renew/2 but raise on error

disable_domain_auto_renew(client, input)

DisableDomainAutoRenew

disable_domain_transfer_lock!(client, input)

Same as disable_domain_transfer_lock/2 but raise on error

disable_domain_transfer_lock(client, input)

DisableDomainTransferLock

enable_domain_auto_renew!(client, input)

Same as enable_domain_auto_renew/2 but raise on error

enable_domain_auto_renew(client, input)

EnableDomainAutoRenew

enable_domain_transfer_lock!(client, input)

Same as enable_domain_transfer_lock/2 but raise on error

enable_domain_transfer_lock(client, input)

EnableDomainTransferLock

get_domain_detail!(client, input)

Same as get_domain_detail/2 but raise on error

get_domain_detail(client, input)

GetDomainDetail

get_operation_detail!(client, input)

Same as get_operation_detail/2 but raise on error

get_operation_detail(client, input)

GetOperationDetail

list_domains!(client, input)

Same as list_domains/2 but raise on error

list_domains(client, input)

ListDomains

list_operations!(client, input)

Same as list_operations/2 but raise on error

list_operations(client, input)

ListOperations

list_tags_for_domain!(client, input)

Same as list_tags_for_domain/2 but raise on error

list_tags_for_domain(client, input)

ListTagsForDomain

register_domain!(client, input)

Same as register_domain/2 but raise on error

register_domain(client, input)

RegisterDomain

retrieve_domain_auth_code!(client, input)

Same as retrieve_domain_auth_code/2 but raise on error

retrieve_domain_auth_code(client, input)

RetrieveDomainAuthCode

transfer_domain!(client, input)

Same as transfer_domain/2 but raise on error

transfer_domain(client, input)

TransferDomain

update_domain_contact!(client, input)

Same as update_domain_contact/2 but raise on error

update_domain_contact(client, input)

UpdateDomainContact

update_domain_contact_privacy!(client, input)

Same as update_domain_contact_privacy/2 but raise on error

update_domain_contact_privacy(client, input)

UpdateDomainContactPrivacy

update_domain_nameservers!(client, input)

Same as update_domain_nameservers/2 but raise on error

update_domain_nameservers(client, input)

UpdateDomainNameservers

update_tags_for_domain!(client, input)

Same as update_tags_for_domain/2 but raise on error

update_tags_for_domain(client, input)

UpdateTagsForDomain

Types

city :: binary

contact_type :: binary

registrar_url :: binary

extra_param_value :: binary

duration_in_years :: integer

error_message :: binary

invalid_input :: [{:message, error_message}]

update_tags_for_domain_request :: [domain_name: domain_name, tags_to_update: tag_list]

get_domain_detail_request :: [{:domain_name, domain_name}]

domain_auth_code :: binary

host_name :: binary

extra_param_name :: binary

fi_auth_key :: binary

operation_status :: binary

contact_number :: binary

lang_code :: binary

reseller :: binary

email :: binary

domain_name :: binary

tag :: [key: tag_key, value: tag_value]

operation_id :: binary

timestamp :: integer

unsupported_tld :: [{:message, error_message}]

address_line :: binary

tag_list :: [tag]

tag_value :: binary

update_domain_nameservers_request :: [domain_name: domain_name, fi_auth_key: fi_auth_key, nameservers: nameserver_list]

zip_code :: binary

contact_name :: binary

registrar_name :: binary

get_operation_detail_response :: [domain_name: domain_name, message: error_message, operation_id: operation_id, status: operation_status, submitted_date: timestamp, type: operation_type]

operation_type :: binary

country_code :: binary

update_domain_contact_privacy_request :: [admin_privacy: boolean, domain_name: domain_name, registrant_privacy: boolean, tech_privacy: boolean]

update_domain_contact_request :: [admin_contact: contact_detail, domain_name: domain_name, registrant_contact: contact_detail, tech_contact: contact_detail]

transfer_domain_response :: [{:operation_id, operation_id}]

transfer_domain_request :: [admin_contact: contact_detail, auth_code: domain_auth_code, auto_renew: boolean, domain_name: domain_name, duration_in_years: duration_in_years, idn_lang_code: lang_code, nameservers: nameserver_list, privacy_protect_admin_contact: boolean, privacy_protect_registrant_contact: boolean, privacy_protect_tech_contact: boolean, registrant_contact: contact_detail, tech_contact: contact_detail]

nameserver :: [glue_ips: glue_ip_list, name: host_name]

operation_summary :: [operation_id: operation_id, status: operation_status, submitted_date: timestamp, type: operation_type]

dns_sec :: binary

registry_domain_id :: binary

register_domain_request :: [admin_contact: contact_detail, auto_renew: boolean, domain_name: domain_name, duration_in_years: duration_in_years, idn_lang_code: lang_code, privacy_protect_admin_contact: boolean, privacy_protect_registrant_contact: boolean, privacy_protect_tech_contact: boolean, registrant_contact: contact_detail, tech_contact: contact_detail]

list_domains_response :: [domains: domain_summary_list, next_page_marker: page_marker]

tag_key :: binary

glue_ip :: binary

contact_detail :: [address_line1: address_line, address_line2: address_line, city: city, contact_type: contact_type, country_code: country_code, email: email, extra_params: extra_param_list, fax: contact_number, first_name: contact_name, last_name: contact_name, organization_name: contact_name, phone_number: contact_number, state: state, zip_code: zip_code]

domain_summary :: [auto_renew: boolean, domain_name: domain_name, expiry: timestamp, transfer_lock: boolean]

delete_tags_for_domain_request :: [domain_name: domain_name, tags_to_delete: tag_key_list]

register_domain_response :: [{:operation_id, operation_id}]

page_marker :: binary

page_max_items :: integer

get_domain_detail_response :: [abuse_contact_email: email, abuse_contact_phone: contact_number, admin_contact: contact_detail, admin_privacy: boolean, auto_renew: boolean, creation_date: timestamp, dns_sec: dns_sec, domain_name: domain_name, expiration_date: timestamp, nameservers: nameserver_list, registrant_contact: contact_detail, registrant_privacy: boolean, registrar_name: registrar_name, registrar_url: registrar_url, registry_domain_id: registry_domain_id, reseller: reseller, status_list: domain_status_list, tech_contact: contact_detail, tech_privacy: boolean, updated_date: timestamp, who_is_server: registrar_who_is_server]

duplicate_request :: [{:message, error_message}]

list_operations_response :: [next_page_marker: page_marker, operations: operation_summary_list]

domain_status :: binary

check_domain_availability_request :: [domain_name: domain_name, idn_lang_code: lang_code]

state :: binary

Functions

check_domain_availability(client, input)

Specs:

CheckDomainAvailability

This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

Source
check_domain_availability!(client, input)

Specs:

Same as check_domain_availability/2 but raise on error.

Source
delete_tags_for_domain(client, input)

Specs:

DeleteTagsForDomain

This operation deletes the specified tags for a domain.

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

Source
delete_tags_for_domain!(client, input)

Specs:

Same as delete_tags_for_domain/2 but raise on error.

Source
disable_domain_auto_renew(client, input)

Specs:

DisableDomainAutoRenew

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

Note:Caution! Amazon Route 53 doesn’t have a manual renewal process, so if you disable automatic renewal, registration for the domain will not be renewed when the expiration date passes, and you will lose control of the domain name.

Source
disable_domain_auto_renew!(client, input)

Specs:

Same as disable_domain_auto_renew/2 but raise on error.

Source
disable_domain_transfer_lock(client, input)

Specs:

DisableDomainTransferLock

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.

Source
disable_domain_transfer_lock!(client, input)

Specs:

Same as disable_domain_transfer_lock/2 but raise on error.

Source
enable_domain_auto_renew(client, input)

Specs:

EnableDomainAutoRenew

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 “Renewal, restoration, and deletion times” on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

Source
enable_domain_auto_renew!(client, input)

Specs:

Same as enable_domain_auto_renew/2 but raise on error.

Source
enable_domain_transfer_lock(client, input)

Specs:

EnableDomainTransferLock

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.

Source
enable_domain_transfer_lock!(client, input)

Specs:

Same as enable_domain_transfer_lock/2 but raise on error.

Source
get_domain_detail(client, input)

Specs:

GetDomainDetail

This operation returns detailed information about the domain. The domain’s contact information is also returned as part of the output.

Source
get_domain_detail!(client, input)

Specs:

  • get_domain_detail!(client :: ExAws.Route53Domains.t, input :: get_domain_detail_request) :: ExAws.Request.JSON.success_t | no_return

Same as get_domain_detail/2 but raise on error.

Source
get_operation_detail(client, input)

Specs:

GetOperationDetail

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

Source
get_operation_detail!(client, input)

Specs:

  • get_operation_detail!(client :: ExAws.Route53Domains.t, input :: get_operation_detail_request) :: ExAws.Request.JSON.success_t | no_return

Same as get_operation_detail/2 but raise on error.

Source
list_domains(client, input)

Specs:

  • list_domains(client :: ExAws.Route53Domains.t, input :: list_domains_request) :: ExAws.Request.JSON.response_t

ListDomains

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

Source
list_domains!(client, input)

Specs:

  • list_domains!(client :: ExAws.Route53Domains.t, input :: list_domains_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_domains/2 but raise on error.

Source
list_operations(client, input)

Specs:

  • list_operations(client :: ExAws.Route53Domains.t, input :: list_operations_request) :: ExAws.Request.JSON.response_t

ListOperations

This operation returns the operation IDs of operations that are not yet complete.

Source
list_operations!(client, input)

Specs:

  • list_operations!(client :: ExAws.Route53Domains.t, input :: list_operations_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_operations/2 but raise on error.

Source
list_tags_for_domain(client, input)

Specs:

ListTagsForDomain

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

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

Source
list_tags_for_domain!(client, input)

Specs:

  • list_tags_for_domain!(client :: ExAws.Route53Domains.t, input :: list_tags_for_domain_request) :: ExAws.Request.JSON.success_t | no_return

Same as list_tags_for_domain/2 but raise on error.

Source
register_domain(client, input)

Specs:

  • register_domain(client :: ExAws.Route53Domains.t, input :: register_domain_request) :: ExAws.Request.JSON.response_t

RegisterDomain

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

  • Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon 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 for our registrar partner, Gandi, instead of the information you entered for 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.
Source
register_domain!(client, input)

Specs:

  • register_domain!(client :: ExAws.Route53Domains.t, input :: register_domain_request) :: ExAws.Request.JSON.success_t | no_return

Same as register_domain/2 but raise on error.

Source
retrieve_domain_auth_code(client, input)

Specs:

RetrieveDomainAuthCode

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

Source
retrieve_domain_auth_code!(client, input)

Specs:

Same as retrieve_domain_auth_code/2 but raise on error.

Source
transfer_domain(client, input)

Specs:

  • transfer_domain(client :: ExAws.Route53Domains.t, input :: transfer_domain_request) :: ExAws.Request.JSON.response_t

TransferDomain

This operation transfers a domain from another registrar to Amazon Route

  1. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.

For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 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 consider transferring your DNS service to Amazon 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.

Note:Caution! 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.

Source
transfer_domain!(client, input)

Specs:

  • transfer_domain!(client :: ExAws.Route53Domains.t, input :: transfer_domain_request) :: ExAws.Request.JSON.success_t | no_return

Same as transfer_domain/2 but raise on error.

Source
update_domain_contact(client, input)

Specs:

UpdateDomainContact

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

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.

Source
update_domain_contact!(client, input)

Specs:

Same as update_domain_contact/2 but raise on error.

Source
update_domain_contact_privacy(client, input)

Specs:

UpdateDomainContactPrivacy

This operation updates the specified domain contact’s privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Source
update_domain_contact_privacy!(client, input)

Specs:

Same as update_domain_contact_privacy/2 but raise on error.

Source
update_domain_nameservers(client, input)

Specs:

UpdateDomainNameservers

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.

Source
update_domain_nameservers!(client, input)

Specs:

Same as update_domain_nameservers/2 but raise on error.

Source
update_tags_for_domain(client, input)

Specs:

UpdateTagsForDomain

This operation adds or updates tags for a specified domain.

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

Source
update_tags_for_domain!(client, input)

Specs:

Same as update_tags_for_domain/2 but raise on error.

Source