Class: Aws::Route53Domains::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53Domains::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-route53domains/client.rb
Overview
An API client for Route53Domains. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::Route53Domains::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#accept_domain_transfer_from_another_aws_account(params = {}) ⇒ Types::AcceptDomainTransferFromAnotherAwsAccountResponse
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account.
-
#associate_delegation_signer_to_domain(params = {}) ⇒ Types::AssociateDelegationSignerToDomainResponse
Creates a delegation signer (DS) record in the registry zone for this domain name.
-
#cancel_domain_transfer_to_another_aws_account(params = {}) ⇒ Types::CancelDomainTransferToAnotherAwsAccountResponse
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account.
-
#check_domain_availability(params = {}) ⇒ Types::CheckDomainAvailabilityResponse
This operation checks the availability of one domain name.
-
#check_domain_transferability(params = {}) ⇒ Types::CheckDomainTransferabilityResponse
Checks whether a domain name can be transferred to Amazon Route 53.
-
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
This operation deletes the specified domain.
-
#delete_tags_for_domain(params = {}) ⇒ Struct
This operation deletes the specified tags for a domain.
-
#disable_domain_auto_renew(params = {}) ⇒ Struct
This operation disables automatic renewal of domain registration for the specified domain.
-
#disable_domain_transfer_lock(params = {}) ⇒ Types::DisableDomainTransferLockResponse
This operation removes the transfer lock on the domain (specifically the ‘clientTransferProhibited` status) to allow domain transfers.
-
#disassociate_delegation_signer_from_domain(params = {}) ⇒ Types::DisassociateDelegationSignerFromDomainResponse
Deletes a delegation signer (DS) record in the registry zone for this domain name.
-
#enable_domain_auto_renew(params = {}) ⇒ Struct
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires.
-
#enable_domain_transfer_lock(params = {}) ⇒ Types::EnableDomainTransferLockResponse
This operation sets the transfer lock on the domain (specifically the ‘clientTransferProhibited` status) to prevent domain transfers.
-
#get_contact_reachability_status(params = {}) ⇒ Types::GetContactReachabilityStatusResponse
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_domain_detail(params = {}) ⇒ Types::GetDomainDetailResponse
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account.
-
#get_domain_suggestions(params = {}) ⇒ Types::GetDomainSuggestionsResponse
The GetDomainSuggestions operation returns a list of suggested domain names.
-
#get_operation_detail(params = {}) ⇒ Types::GetOperationDetailResponse
This operation returns the current status of an operation that is not completed.
-
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
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.
-
#list_operations(params = {}) ⇒ Types::ListOperationsResponse
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_prices(params = {}) ⇒ Types::ListPricesResponse
Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:.
-
#list_tags_for_domain(params = {}) ⇒ Types::ListTagsForDomainResponse
This operation returns all of the tags that are associated with the specified domain.
-
#push_domain(params = {}) ⇒ Struct
Moves a domain from Amazon Web Services to another registrar.
-
#register_domain(params = {}) ⇒ Types::RegisterDomainResponse
This operation registers a domain.
-
#reject_domain_transfer_from_another_aws_account(params = {}) ⇒ Types::RejectDomainTransferFromAnotherAwsAccountResponse
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account.
-
#renew_domain(params = {}) ⇒ Types::RenewDomainResponse
This operation renews a domain for the specified number of years.
-
#resend_contact_reachability_email(params = {}) ⇒ Types::ResendContactReachabilityEmailResponse
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_operation_authorization(params = {}) ⇒ Struct
Resend the form of authorization email for this operation.
-
#retrieve_domain_auth_code(params = {}) ⇒ Types::RetrieveDomainAuthCodeResponse
This operation returns the authorization code for the domain.
-
#transfer_domain(params = {}) ⇒ Types::TransferDomainResponse
Transfers a domain from another registrar to Amazon Route 53.
-
#transfer_domain_to_another_aws_account(params = {}) ⇒ Types::TransferDomainToAnotherAwsAccountResponse
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account.
-
#update_domain_contact(params = {}) ⇒ Types::UpdateDomainContactResponse
This operation updates the contact information for a particular domain.
-
#update_domain_contact_privacy(params = {}) ⇒ Types::UpdateDomainContactPrivacyResponse
This operation updates the specified domain contact’s privacy setting.
-
#update_domain_nameservers(params = {}) ⇒ Types::UpdateDomainNameserversResponse
This operation replaces the current set of name servers for the domain with the specified set of name servers.
-
#update_tags_for_domain(params = {}) ⇒ Struct
This operation adds or updates tags for a specified domain.
-
#view_billing(params = {}) ⇒ Types::ViewBillingResponse
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-route53domains/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2820 2821 2822 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2820 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2823 2824 2825 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2823 def errors_module Errors end |
Instance Method Details
#accept_domain_transfer_from_another_aws_account(params = {}) ⇒ Types::AcceptDomainTransferFromAnotherAwsAccountResponse
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using [TransferDomainToAnotherAwsAccount].
If you use the CLI command at [accept-domain-transfer-from-another-aws-account], use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes.
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`.
[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html [2]: docs.aws.amazon.com/cli/latest/reference/route53domains/accept-domain-transfer-from-another-aws-account.html [3]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html [4]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html
493 494 495 496 |
# File 'lib/aws-sdk-route53domains/client.rb', line 493 def accept_domain_transfer_from_another_aws_account(params = {}, = {}) req = build_request(:accept_domain_transfer_from_another_aws_account, params) req.send_request() end |
#associate_delegation_signer_to_domain(params = {}) ⇒ Types::AssociateDelegationSignerToDomainResponse
Creates a delegation signer (DS) record in the registry zone for this domain name.
Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see [Configuring DNSSEC signing] in the *Route 53 developer guide*.
[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec.html
542 543 544 545 |
# File 'lib/aws-sdk-route53domains/client.rb', line 542 def associate_delegation_signer_to_domain(params = {}, = {}) req = build_request(:associate_delegation_signer_to_domain, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2798 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-route53domains' context[:gem_version] = '1.63.0' Seahorse::Client::Request.new(handlers, context) end |
#cancel_domain_transfer_to_another_aws_account(params = {}) ⇒ Types::CancelDomainTransferToAnotherAwsAccountResponse
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using [TransferDomainToAnotherAwsAccount].
You must cancel the transfer before the other Amazon Web Services 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`.
[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html [2]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html [3]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html [4]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html
590 591 592 593 |
# File 'lib/aws-sdk-route53domains/client.rb', line 590 def cancel_domain_transfer_to_another_aws_account(params = {}, = {}) req = build_request(:cancel_domain_transfer_to_another_aws_account, params) req.send_request() end |
#check_domain_availability(params = {}) ⇒ Types::CheckDomainAvailabilityResponse
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.
651 652 653 654 |
# File 'lib/aws-sdk-route53domains/client.rb', line 651 def check_domain_availability(params = {}, = {}) req = build_request(:check_domain_availability, params) req.send_request() end |
#check_domain_transferability(params = {}) ⇒ Types::CheckDomainTransferabilityResponse
Checks whether a domain name can be transferred to Amazon Route 53.
707 708 709 710 |
# File 'lib/aws-sdk-route53domains/client.rb', line 707 def check_domain_transferability(params = {}, = {}) req = build_request(:check_domain_transferability, params) req.send_request() end |
#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse
This operation deletes the specified domain. This action is permanent. For more information, see [Deleting a domain name registration].
To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply:
-
You can’t get a refund for the cost of a deleted domain registration.
-
The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).
-
When the registration has been deleted, we’ll send you a confirmation to the registrant contact. The email will come from ‘noreply@domainnameverification.net` or `noreply@registrar.amazon.com`.
[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-delete.html
756 757 758 759 |
# File 'lib/aws-sdk-route53domains/client.rb', line 756 def delete_domain(params = {}, = {}) req = build_request(:delete_domain, params) req.send_request() end |
#delete_tags_for_domain(params = {}) ⇒ Struct
This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
785 786 787 788 |
# File 'lib/aws-sdk-route53domains/client.rb', line 785 def (params = {}, = {}) req = build_request(:delete_tags_for_domain, params) req.send_request() end |
#disable_domain_auto_renew(params = {}) ⇒ Struct
This operation disables automatic renewal of domain registration for the specified domain.
808 809 810 811 |
# File 'lib/aws-sdk-route53domains/client.rb', line 808 def disable_domain_auto_renew(params = {}, = {}) req = build_request(:disable_domain_auto_renew, params) req.send_request() end |
#disable_domain_transfer_lock(params = {}) ⇒ Types::DisableDomainTransferLockResponse
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.
842 843 844 845 |
# File 'lib/aws-sdk-route53domains/client.rb', line 842 def disable_domain_transfer_lock(params = {}, = {}) req = build_request(:disable_domain_transfer_lock, params) req.send_request() end |
#disassociate_delegation_signer_from_domain(params = {}) ⇒ Types::DisassociateDelegationSignerFromDomainResponse
Deletes a delegation signer (DS) record in the registry zone for this domain name.
881 882 883 884 |
# File 'lib/aws-sdk-route53domains/client.rb', line 881 def disassociate_delegation_signer_from_domain(params = {}, = {}) req = build_request(:disassociate_delegation_signer_from_domain, params) req.send_request() end |
#enable_domain_auto_renew(params = {}) ⇒ Struct
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 Amazon Web Services 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.
[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html
916 917 918 919 |
# File 'lib/aws-sdk-route53domains/client.rb', line 916 def enable_domain_auto_renew(params = {}, = {}) req = build_request(:enable_domain_auto_renew, params) req.send_request() end |
#enable_domain_transfer_lock(params = {}) ⇒ Types::EnableDomainTransferLockResponse
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.
949 950 951 952 |
# File 'lib/aws-sdk-route53domains/client.rb', line 949 def enable_domain_transfer_lock(params = {}, = {}) req = build_request(:enable_domain_transfer_lock, params) req.send_request() end |
#get_contact_reachability_status(params = {}) ⇒ Types::GetContactReachabilityStatusResponse
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.
986 987 988 989 |
# File 'lib/aws-sdk-route53domains/client.rb', line 986 def get_contact_reachability_status(params = {}, = {}) req = build_request(:get_contact_reachability_status, params) req.send_request() end |
#get_domain_detail(params = {}) ⇒ Types::GetDomainDetailResponse
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output.
1135 1136 1137 1138 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1135 def get_domain_detail(params = {}, = {}) req = build_request(:get_domain_detail, params) req.send_request() end |
#get_domain_suggestions(params = {}) ⇒ Types::GetDomainSuggestionsResponse
The GetDomainSuggestions operation returns a list of suggested domain names.
1204 1205 1206 1207 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1204 def get_domain_suggestions(params = {}, = {}) req = build_request(:get_domain_suggestions, params) req.send_request() end |
#get_operation_detail(params = {}) ⇒ Types::GetOperationDetailResponse
This operation returns the current status of an operation that is not completed.
1249 1250 1251 1252 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1249 def get_operation_detail(params = {}, = {}) req = build_request(:get_operation_detail, params) req.send_request() end |
#list_domains(params = {}) ⇒ Types::ListDomainsResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1322 1323 1324 1325 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1322 def list_domains(params = {}, = {}) req = build_request(:list_domains, params) req.send_request() end |
#list_operations(params = {}) ⇒ Types::ListOperationsResponse
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 command runs only in the us-east-1 Region.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1400 1401 1402 1403 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1400 def list_operations(params = {}, = {}) req = build_request(:list_operations, params) req.send_request() end |
#list_prices(params = {}) ⇒ Types::ListPricesResponse
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
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1477 1478 1479 1480 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1477 def list_prices(params = {}, = {}) req = build_request(:list_prices, params) req.send_request() end |
#list_tags_for_domain(params = {}) ⇒ Types::ListTagsForDomainResponse
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.
1511 1512 1513 1514 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1511 def (params = {}, = {}) req = build_request(:list_tags_for_domain, params) req.send_request() end |
#push_domain(params = {}) ⇒ Struct
Moves a domain from Amazon Web Services to another registrar.
Supported actions:
-
Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.
^
1545 1546 1547 1548 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1545 def push_domain(params = {}, = {}) req = build_request(:push_domain, params) req.send_request() end |
#register_domain(params = {}) ⇒ Types::RegisterDomainResponse
This operation registers a domain. 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 auto renew, 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 for the registrar or the phrase “REDACTED FOR PRIVACY”, or “On behalf of <domain name> owner.” If you don’t enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
<note markdown=“1”> While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.
</note>
-
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 Amazon Web Services account an amount based on the top-level domain. For more information, see [Amazon Route 53 Pricing].
1836 1837 1838 1839 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1836 def register_domain(params = {}, = {}) req = build_request(:register_domain, params) req.send_request() end |
#reject_domain_transfer_from_another_aws_account(params = {}) ⇒ Types::RejectDomainTransferFromAnotherAwsAccountResponse
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services 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`.
[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html [2]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html [3]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html
1884 1885 1886 1887 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1884 def reject_domain_transfer_from_another_aws_account(params = {}, = {}) req = build_request(:reject_domain_transfer_from_another_aws_account, params) req.send_request() end |
#renew_domain(params = {}) ⇒ Types::RenewDomainResponse
This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services 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*.
[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html
1943 1944 1945 1946 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1943 def renew_domain(params = {}, = {}) req = build_request(:renew_domain, params) req.send_request() end |
#resend_contact_reachability_email(params = {}) ⇒ Types::ResendContactReachabilityEmailResponse
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.
1979 1980 1981 1982 |
# File 'lib/aws-sdk-route53domains/client.rb', line 1979 def resend_contact_reachability_email(params = {}, = {}) req = build_request(:resend_contact_reachability_email, params) req.send_request() end |
#resend_operation_authorization(params = {}) ⇒ Struct
Resend the form of authorization email for this operation.
2001 2002 2003 2004 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2001 def (params = {}, = {}) req = build_request(:resend_operation_authorization, params) req.send_request() end |
#retrieve_domain_auth_code(params = {}) ⇒ Types::RetrieveDomainAuthCodeResponse
This operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
2031 2032 2033 2034 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2031 def retrieve_domain_auth_code(params = {}, = {}) req = build_request(:retrieve_domain_auth_code, params) req.send_request() end |
#transfer_domain(params = {}) ⇒ Types::TransferDomainResponse
Transfers a domain from another registrar to Amazon Route 53.
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 Amazon Web Services 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*.
During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner contact after the transfer is complete. For more information, see [UpdateDomainContact].
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.
[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html [2]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html [3]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html [4]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainContact.html
2314 2315 2316 2317 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2314 def transfer_domain(params = {}, = {}) req = build_request(:transfer_domain, params) req.send_request() end |
#transfer_domain_to_another_aws_account(params = {}) ⇒ Types::TransferDomainToAnotherAwsAccountResponse
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:
-
The Amazon Web Services 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].
When you transfer a domain from one Amazon Web Services 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 Amazon Web Services account, see [Migrating a Hosted Zone to a Different Amazon Web Services 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`.
[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html [2]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_CancelDomainTransferToAnotherAwsAccount.html [3]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_RejectDomainTransferFromAnotherAwsAccount.html [4]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-migrating.html [5]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html [6]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html
2385 2386 2387 2388 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2385 def transfer_domain_to_another_aws_account(params = {}, = {}) req = build_request(:transfer_domain_to_another_aws_account, params) req.send_request() end |
#update_domain_contact(params = {}) ⇒ Types::UpdateDomainContactResponse
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 operation. If the request is not completed successfully, the domain registrant will be notified by email.
2525 2526 2527 2528 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2525 def update_domain_contact(params = {}, = {}) req = build_request(:update_domain_contact, params) req.send_request() end |
#update_domain_contact_privacy(params = {}) ⇒ Types::UpdateDomainContactPrivacyResponse
This operation updates the specified domain contact’s privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase “REDACTED FOR PRIVACY”, or “On behalf of <domain name> owner.”
<note markdown=“1”> While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.
</note>
This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). 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 [aws.amazon.com/privacy/][2].
[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html [2]: aws.amazon.com/privacy/
2638 2639 2640 2641 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2638 def update_domain_contact_privacy(params = {}, = {}) req = build_request(:update_domain_contact_privacy, params) req.send_request() end |
#update_domain_nameservers(params = {}) ⇒ Types::UpdateDomainNameserversResponse
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.
2687 2688 2689 2690 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2687 def update_domain_nameservers(params = {}, = {}) req = build_request(:update_domain_nameservers, params) req.send_request() end |
#update_tags_for_domain(params = {}) ⇒ Struct
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.
2723 2724 2725 2726 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2723 def (params = {}, = {}) req = build_request(:update_tags_for_domain, params) req.send_request() end |
#view_billing(params = {}) ⇒ Types::ViewBillingResponse
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2789 2790 2791 2792 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2789 def view_billing(params = {}, = {}) req = build_request(:view_billing, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2813 2814 2815 |
# File 'lib/aws-sdk-route53domains/client.rb', line 2813 def waiter_names [] end |