Route53DomainsClient Class

Member Function Documentation

Route53DomainsClient::Route53DomainsClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a Route53DomainsClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

Route53DomainsClient::Route53DomainsClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads Route53DomainsClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CheckDomainAvailabilityResponse *Route53DomainsClient::checkDomainAvailability(const CheckDomainAvailabilityRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an CheckDomainAvailabilityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] CheckDomainTransferabilityResponse *Route53DomainsClient::checkDomainTransferability(const CheckDomainTransferabilityRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an CheckDomainTransferabilityResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] DeleteTagsForDomainResponse *Route53DomainsClient::deleteTagsForDomain(const DeleteTagsForDomainRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an DeleteTagsForDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This operation deletes the specified tags for a

domain>

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

[slot] DisableDomainAutoRenewResponse *Route53DomainsClient::disableDomainAutoRenew(const DisableDomainAutoRenewRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an DisableDomainAutoRenewResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This operation disables automatic renewal of domain registration for the specified

[slot] DisableDomainTransferLockResponse *Route53DomainsClient::disableDomainTransferLock(const DisableDomainTransferLockRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an DisableDomainTransferLockResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This operation removes the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> 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

[slot] EnableDomainAutoRenewResponse *Route53DomainsClient::enableDomainAutoRenew(const EnableDomainAutoRenewRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an EnableDomainAutoRenewResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times">"Renewal, restoration, and deletion times"</a> on the website for our registrar associate, Gandi. Amazon 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

[slot] EnableDomainTransferLockResponse *Route53DomainsClient::enableDomainTransferLock(const EnableDomainTransferLockRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an EnableDomainTransferLockResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This operation sets the transfer lock on the domain (specifically the <code>clientTransferProhibited</code> 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

[slot] GetContactReachabilityStatusResponse *Route53DomainsClient::getContactReachabilityStatus(const GetContactReachabilityStatusRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an GetContactReachabilityStatusResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>ResendContactReachabilityEmail</code>

[slot] GetDomainDetailResponse *Route53DomainsClient::getDomainDetail(const GetDomainDetailRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an GetDomainDetailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] GetDomainSuggestionsResponse *Route53DomainsClient::getDomainSuggestions(const GetDomainSuggestionsRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an GetDomainSuggestionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without

[slot] GetOperationDetailResponse *Route53DomainsClient::getOperationDetail(const GetOperationDetailRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an GetOperationDetailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListDomainsResponse *Route53DomainsClient::listDomains(const ListDomainsRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an ListDomainsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListOperationsResponse *Route53DomainsClient::listOperations(const ListOperationsRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an ListOperationsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] ListTagsForDomainResponse *Route53DomainsClient::listTagsForDomain(const ListTagsForDomainRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an ListTagsForDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RegisterDomainResponse *Route53DomainsClient::registerDomain(const RegisterDomainRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an RegisterDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <ul> <li>

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> </li> <li>

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> </li> <li>

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> </li> <li>

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> </li> <li>

Charges your AWS account an amount based on the top-level domain. For more information, see <a href="http://aws.amazon.com/route53/pricing/">Amazon Route 53

[slot] RenewDomainResponse *Route53DomainsClient::renewDomain(const RenewDomainRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an RenewDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html">Renewing Registration for a Domain</a> in the Amazon Route 53 Developer

[slot] ResendContactReachabilityEmailResponse *Route53DomainsClient::resendContactReachabilityEmail(const ResendContactReachabilityEmailRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an ResendContactReachabilityEmailResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] RetrieveDomainAuthCodeResponse *Route53DomainsClient::retrieveDomainAuthCode(const RetrieveDomainAuthCodeRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an RetrieveDomainAuthCodeResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] TransferDomainResponse *Route53DomainsClient::transferDomain(const TransferDomainRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an TransferDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This operation 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 transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see <a href="http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html">Transferring Registration for a Domain to Amazon Route 53</a> in the <i>Amazon Route 53 Developer

Guide</i>>

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> <b>

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> </b>

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

[slot] UpdateDomainContactResponse *Route53DomainsClient::updateDomainContact(const UpdateDomainContactRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an UpdateDomainContactResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateDomainContactPrivacyResponse *Route53DomainsClient::updateDomainContactPrivacy(const UpdateDomainContactPrivacyRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an UpdateDomainContactPrivacyResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a>GetOperationDetail</a> to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by

[slot] UpdateDomainNameserversResponse *Route53DomainsClient::updateDomainNameservers(const UpdateDomainNameserversRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an UpdateDomainNameserversResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateTagsForDomainResponse *Route53DomainsClient::updateTagsForDomain(const UpdateTagsForDomainRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an UpdateTagsForDomainResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

This operation adds or updates tags for a specified

domain>

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

[slot] ViewBillingResponse *Route53DomainsClient::viewBilling(const ViewBillingRequest &request)

Sends request to the Route53DomainsClient service, and returns a pointer to an ViewBillingResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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