com.amazonaws.services.route53domains

Interface AmazonRoute53Domains

All Known Subinterfaces:

AmazonRoute53DomainsAsync

All Known Implementing Classes:

AbstractAmazonRoute53Domains, AbstractAmazonRoute53DomainsAsync, AmazonRoute53DomainsAsyncClient, AmazonRoute53DomainsClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonRoute53Domains

Interface for accessing Amazon Route 53 Domains.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonRoute53Domains instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AcceptDomainTransferFromAnotherAwsAccountResult	acceptDomainTransferFromAnotherAwsAccount(AcceptDomainTransferFromAnotherAwsAccountRequest acceptDomainTransferFromAnotherAwsAccountRequest) Accepts the transfer of a domain from another AWS account to the current AWS account.
CancelDomainTransferToAnotherAwsAccountResult	cancelDomainTransferToAnotherAwsAccount(CancelDomainTransferToAnotherAwsAccountRequest cancelDomainTransferToAnotherAwsAccountRequest) Cancels the transfer of a domain from the current AWS account to another AWS account.
CheckDomainAvailabilityResult	checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest) This operation checks the availability of one domain name.
CheckDomainTransferabilityResult	checkDomainTransferability(CheckDomainTransferabilityRequest checkDomainTransferabilityRequest) Checks whether a domain name can be transferred to Amazon Route 53.
DeleteTagsForDomainResult	deleteTagsForDomain(DeleteTagsForDomainRequest deleteTagsForDomainRequest) This operation deletes the specified tags for a domain.
DisableDomainAutoRenewResult	disableDomainAutoRenew(DisableDomainAutoRenewRequest disableDomainAutoRenewRequest) This operation disables automatic renewal of domain registration for the specified domain.
DisableDomainTransferLockResult	disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest) This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers.
EnableDomainAutoRenewResult	enableDomainAutoRenew(EnableDomainAutoRenewRequest enableDomainAutoRenewRequest) This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires.
EnableDomainTransferLockResult	enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest) This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetContactReachabilityStatusResult	getContactReachabilityStatus(GetContactReachabilityStatusRequest getContactReachabilityStatusRequest) 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.
GetDomainDetailResult	getDomainDetail(GetDomainDetailRequest getDomainDetailRequest) This operation returns detailed information about a specified domain that is associated with the current AWS account.
GetDomainSuggestionsResult	getDomainSuggestions(GetDomainSuggestionsRequest getDomainSuggestionsRequest) The GetDomainSuggestions operation returns a list of suggested domain names.
GetOperationDetailResult	getOperationDetail(GetOperationDetailRequest getOperationDetailRequest) This operation returns the current status of an operation that is not completed.
ListDomainsResult	listDomains() Simplified method form for invoking the ListDomains operation.
ListDomainsResult	listDomains(ListDomainsRequest listDomainsRequest) This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
ListOperationsResult	listOperations() Simplified method form for invoking the ListOperations operation.
ListOperationsResult	listOperations(ListOperationsRequest listOperationsRequest) 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.
ListTagsForDomainResult	listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest) This operation returns all of the tags that are associated with the specified domain.
RegisterDomainResult	registerDomain(RegisterDomainRequest registerDomainRequest) This operation registers a domain.
RejectDomainTransferFromAnotherAwsAccountResult	rejectDomainTransferFromAnotherAwsAccount(RejectDomainTransferFromAnotherAwsAccountRequest rejectDomainTransferFromAnotherAwsAccountRequest) Rejects the transfer of a domain from another AWS account to the current AWS account.
RenewDomainResult	renewDomain(RenewDomainRequest renewDomainRequest) This operation renews a domain for the specified number of years.
ResendContactReachabilityEmailResult	resendContactReachabilityEmail(ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest) 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.
RetrieveDomainAuthCodeResult	retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest) This operation returns the AuthCode for the domain.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TransferDomainResult	transferDomain(TransferDomainRequest transferDomainRequest) Transfers a domain from another registrar to Amazon Route 53.
TransferDomainToAnotherAwsAccountResult	transferDomainToAnotherAwsAccount(TransferDomainToAnotherAwsAccountRequest transferDomainToAnotherAwsAccountRequest) Transfers a domain from the current AWS account to another AWS account.
UpdateDomainContactResult	updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest) This operation updates the contact information for a particular domain.
UpdateDomainContactPrivacyResult	updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest) This operation updates the specified domain contact's privacy setting.
UpdateDomainNameserversResult	updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest) This operation replaces the current set of name servers for the domain with the specified set of name servers.
UpdateTagsForDomainResult	updateTagsForDomain(UpdateTagsForDomainRequest updateTagsForDomainRequest) This operation adds or updates tags for a specified domain.
ViewBillingResult	viewBilling(ViewBillingRequest viewBillingRequest) Returns all the domain-related billing records for the current AWS account for a specified period

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

Overrides the default endpoint for this client ("https://route53domains.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "route53domains.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://route53domains.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "route53domains.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://route53domains.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

acceptDomainTransferFromAnotherAwsAccount

AcceptDomainTransferFromAnotherAwsAccountResult acceptDomainTransferFromAnotherAwsAccount(AcceptDomainTransferFromAnotherAwsAccountRequest acceptDomainTransferFromAnotherAwsAccountRequest)

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.

Parameters:

acceptDomainTransferFromAnotherAwsAccountRequest - The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.

Returns:

Result of the AcceptDomainTransferFromAnotherAwsAccount operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

DomainLimitExceededException - The number of domains has exceeded the allowed threshold for the account.

See Also:

AWS API Documentation

cancelDomainTransferToAnotherAwsAccount

CancelDomainTransferToAnotherAwsAccountResult cancelDomainTransferToAnotherAwsAccount(CancelDomainTransferToAnotherAwsAccountRequest cancelDomainTransferToAnotherAwsAccountRequest)

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.

Parameters:

cancelDomainTransferToAnotherAwsAccountRequest - The CancelDomainTransferToAnotherAwsAccount request includes the following element.

Returns:

Result of the CancelDomainTransferToAnotherAwsAccount operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

See Also:

AWS API Documentation

checkDomainAvailability

CheckDomainAvailabilityResult checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest)

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.

Parameters:

checkDomainAvailabilityRequest - The CheckDomainAvailability request contains the following elements.

Returns:

Result of the CheckDomainAvailability operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

checkDomainTransferability

CheckDomainTransferabilityResult checkDomainTransferability(CheckDomainTransferabilityRequest checkDomainTransferabilityRequest)

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

Parameters:

checkDomainTransferabilityRequest - The CheckDomainTransferability request contains the following elements.

Returns:

Result of the CheckDomainTransferability operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

deleteTagsForDomain

DeleteTagsForDomainResult deleteTagsForDomain(DeleteTagsForDomainRequest deleteTagsForDomainRequest)

This operation deletes the specified tags for a domain.

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

Parameters:

deleteTagsForDomainRequest - The DeleteTagsForDomainRequest includes the following elements.

Returns:

Result of the DeleteTagsForDomain operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

disableDomainAutoRenew

DisableDomainAutoRenewResult disableDomainAutoRenew(DisableDomainAutoRenewRequest disableDomainAutoRenewRequest)

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

Parameters:

disableDomainAutoRenewRequest -

Returns:

Result of the DisableDomainAutoRenew operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

disableDomainTransferLock

DisableDomainTransferLockResult disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest)

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.

Parameters:

disableDomainTransferLockRequest - The DisableDomainTransferLock request includes the following element.

Returns:

Result of the DisableDomainTransferLock operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

enableDomainAutoRenew

EnableDomainAutoRenewResult enableDomainAutoRenew(EnableDomainAutoRenewRequest enableDomainAutoRenewRequest)

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.

Parameters:

enableDomainAutoRenewRequest -

Returns:

Result of the EnableDomainAutoRenew operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

TLDRulesViolationException - The top-level domain does not support this operation.

See Also:

AWS API Documentation

enableDomainTransferLock

EnableDomainTransferLockResult enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest)

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.

Parameters:

enableDomainTransferLockRequest - A request to set the transfer lock for the specified domain.

Returns:

Result of the EnableDomainTransferLock operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

getContactReachabilityStatus

GetContactReachabilityStatusResult getContactReachabilityStatus(GetContactReachabilityStatusRequest getContactReachabilityStatusRequest)

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.

Parameters:

getContactReachabilityStatusRequest -

Returns:

Result of the GetContactReachabilityStatus operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

getDomainDetail

GetDomainDetailResult getDomainDetail(GetDomainDetailRequest getDomainDetailRequest)

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.

Parameters:

getDomainDetailRequest - The GetDomainDetail request includes the following element.

Returns:

Result of the GetDomainDetail operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

getDomainSuggestions

GetDomainSuggestionsResult getDomainSuggestions(GetDomainSuggestionsRequest getDomainSuggestionsRequest)

The GetDomainSuggestions operation returns a list of suggested domain names.

Parameters:

getDomainSuggestionsRequest -

Returns:

Result of the GetDomainSuggestions operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

getOperationDetail

GetOperationDetailResult getOperationDetail(GetOperationDetailRequest getOperationDetailRequest)

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

Parameters:

getOperationDetailRequest - The GetOperationDetail request includes the following element.

Returns:

Result of the GetOperationDetail operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

See Also:

AWS API Documentation

listDomains

ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)

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

Parameters:

listDomainsRequest - The ListDomains request includes the following elements.

Returns:

Result of the ListDomains operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

See Also:

AWS API Documentation

listDomains

ListDomainsResult listDomains()

Simplified method form for invoking the ListDomains operation.

See Also:

listDomains(ListDomainsRequest)

listOperations

ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest)

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.

Parameters:

listOperationsRequest - The ListOperations request includes the following elements.

Returns:

Result of the ListOperations operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

See Also:

AWS API Documentation

listOperations

ListOperationsResult listOperations()

Simplified method form for invoking the ListOperations operation.

See Also:

listOperations(ListOperationsRequest)

listTagsForDomain

ListTagsForDomainResult listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest)

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.

Parameters:

listTagsForDomainRequest - The ListTagsForDomainRequest includes the following elements.

Returns:

Result of the ListTagsForDomain operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

registerDomain

RegisterDomainResult registerDomain(RegisterDomainRequest registerDomainRequest)

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.

Parameters:

registerDomainRequest - The RegisterDomain request includes the following elements.

Returns:

Result of the RegisterDomain operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

DomainLimitExceededException - The number of domains has exceeded the allowed threshold for the account.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

See Also:

AWS API Documentation

rejectDomainTransferFromAnotherAwsAccount

RejectDomainTransferFromAnotherAwsAccountResult rejectDomainTransferFromAnotherAwsAccount(RejectDomainTransferFromAnotherAwsAccountRequest rejectDomainTransferFromAnotherAwsAccountRequest)

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.

Parameters:

rejectDomainTransferFromAnotherAwsAccountRequest - The RejectDomainTransferFromAnotherAwsAccount request includes the following element.

Returns:

Result of the RejectDomainTransferFromAnotherAwsAccount operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

See Also:

AWS API Documentation

renewDomain

RenewDomainResult renewDomain(RenewDomainRequest renewDomainRequest)

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.

Parameters:

renewDomainRequest - A RenewDomain request includes the number of years that you want to renew for and the current expiration year.

Returns:

Result of the RenewDomain operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

See Also:

AWS API Documentation

resendContactReachabilityEmail

ResendContactReachabilityEmailResult resendContactReachabilityEmail(ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest)

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.

Parameters:

resendContactReachabilityEmailRequest -

Returns:

Result of the ResendContactReachabilityEmail operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

retrieveDomainAuthCode

RetrieveDomainAuthCodeResult retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest)

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

Parameters:

retrieveDomainAuthCodeRequest - A request for the authorization code for the specified domain. To transfer a domain to another registrar, you provide this value to the new registrar.

Returns:

Result of the RetrieveDomainAuthCode operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

transferDomain

TransferDomainResult transferDomain(TransferDomainRequest transferDomainRequest)

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.

Parameters:

transferDomainRequest - The TransferDomain request includes the following elements.

Returns:

Result of the TransferDomain operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

DomainLimitExceededException - The number of domains has exceeded the allowed threshold for the account.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

See Also:

AWS API Documentation

transferDomainToAnotherAwsAccount

TransferDomainToAnotherAwsAccountResult transferDomainToAnotherAwsAccount(TransferDomainToAnotherAwsAccountRequest transferDomainToAnotherAwsAccountRequest)

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.

Parameters:

transferDomainToAnotherAwsAccountRequest - The TransferDomainToAnotherAwsAccount request includes the following elements.

Returns:

Result of the TransferDomainToAnotherAwsAccount operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

DuplicateRequestException - The request is already in progress for the domain.

See Also:

AWS API Documentation

updateDomainContact

UpdateDomainContactResult updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest)

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.

Parameters:

updateDomainContactRequest - The UpdateDomainContact request includes the following elements.

Returns:

Result of the UpdateDomainContact operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

updateDomainContactPrivacy

UpdateDomainContactPrivacyResult updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest)

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

Parameters:

updateDomainContactPrivacyRequest - The UpdateDomainContactPrivacy request includes the following elements.

Returns:

Result of the UpdateDomainContactPrivacy operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

updateDomainNameservers

UpdateDomainNameserversResult updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest)

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.

Parameters:

updateDomainNameserversRequest - 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.

Returns:

Result of the UpdateDomainNameservers operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

DuplicateRequestException - The request is already in progress for the domain.

TLDRulesViolationException - The top-level domain does not support this operation.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

updateTagsForDomain

UpdateTagsForDomainResult updateTagsForDomain(UpdateTagsForDomainRequest updateTagsForDomainRequest)

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.

Parameters:

updateTagsForDomainRequest - The UpdateTagsForDomainRequest includes the following elements.

Returns:

Result of the UpdateTagsForDomain operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

OperationLimitExceededException - The number of operations or jobs running exceeded the allowed threshold for the account.

UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).

See Also:

AWS API Documentation

viewBilling

ViewBillingResult viewBilling(ViewBillingRequest viewBillingRequest)

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

Parameters:

viewBillingRequest - The ViewBilling request includes the following elements.

Returns:

Result of the ViewBilling operation returned by the service.

Throws:

InvalidInputException - The requested item is not acceptable. For example, for APIs that accept a domain name, the request might specify a domain name that doesn't belong to the account that submitted the request. For AcceptDomainTransferFromAnotherAwsAccount, the password might be invalid.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.