Class: Aws::Route53Domains::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::Route53Domains::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-route53domains/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#accept_domain_transfer_from_another_aws_account(params = {}) ⇒ Types::AcceptDomainTransferFromAnotherAwsAccountResponse
Accepts the transfer of a domain from another AWS account to the current AWS account.
-
#cancel_domain_transfer_to_another_aws_account(params = {}) ⇒ Types::CancelDomainTransferToAnotherAwsAccountResponse
Cancels the transfer of a domain from the current AWS account to another AWS 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_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. -
#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 AWS 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 AWS account.
-
#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_tags_for_domain(params = {}) ⇒ Types::ListTagsForDomainResponse
This operation returns all of the tags that are associated with the specified domain.
-
#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 AWS account to the current AWS 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.
-
#retrieve_domain_auth_code(params = {}) ⇒ Types::RetrieveDomainAuthCodeResponse
This operation returns the AuthCode 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 AWS account to another AWS 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 AWS account for a specified period.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#accept_domain_transfer_from_another_aws_account(params = {}) ⇒ Types::AcceptDomainTransferFromAnotherAwsAccountResponse
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
.
390 391 392 393 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 390 def accept_domain_transfer_from_another_aws_account(params = {}, = {}) req = build_request(:accept_domain_transfer_from_another_aws_account, params) req.send_request() end |
#cancel_domain_transfer_to_another_aws_account(params = {}) ⇒ Types::CancelDomainTransferToAnotherAwsAccountResponse
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
.
436 437 438 439 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 436 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.
497 498 499 500 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 497 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.
551 552 553 554 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 551 def check_domain_transferability(params = {}, = {}) req = build_request(:check_domain_transferability, 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.
580 581 582 583 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 580 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.
603 604 605 606 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 603 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.
637 638 639 640 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 637 def disable_domain_transfer_lock(params = {}, = {}) req = build_request(:disable_domain_transfer_lock, 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 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.
671 672 673 674 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 671 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.
704 705 706 707 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 704 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.
741 742 743 744 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 741 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 AWS account. Contact information for the domain is also returned as part of the output.
861 862 863 864 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 861 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.
930 931 932 933 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 930 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.
971 972 973 974 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 971 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 AWS account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1023 1024 1025 1026 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1023 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1079 def list_operations(params = {}, = {}) req = build_request(:list_operations, 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.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1113 def (params = {}, = {}) req = build_request(:list_tags_for_domain, params) req.send_request() end |
#register_domain(params = {}) ⇒ Types::RegisterDomainResponse
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.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1346 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 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
.
1392 1393 1394 1395 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1392 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 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.
1450 1451 1452 1453 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1450 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.
1486 1487 1488 1489 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1486 def resend_contact_reachability_email(params = {}, = {}) req = build_request(:resend_contact_reachability_email, params) req.send_request() end |
#retrieve_domain_auth_code(params = {}) ⇒ Types::RetrieveDomainAuthCodeResponse
This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
1516 1517 1518 1519 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1516 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. 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.
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.
1745 1746 1747 1748 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1745 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 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.
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
.
1815 1816 1817 1818 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1815 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 action. If the request is not completed successfully, the domain registrant will be notified by email.
1923 1924 1925 1926 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 1923 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, 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/.
2005 2006 2007 2008 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 2005 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.
2054 2055 2056 2057 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 2054 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.
2090 2091 2092 2093 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 2090 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 AWS account for a specified period
2153 2154 2155 2156 |
# File 'gems/aws-sdk-route53domains/lib/aws-sdk-route53domains/client.rb', line 2153 def view_billing(params = {}, = {}) req = build_request(:view_billing, params) req.send_request() end |