@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonRoute53Domains
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptDomainTransferFromAnotherAwsAccountResult |
acceptDomainTransferFromAnotherAwsAccount(AcceptDomainTransferFromAnotherAwsAccountRequest acceptDomainTransferFromAnotherAwsAccountRequest)
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services
account.
|
AssociateDelegationSignerToDomainResult |
associateDelegationSignerToDomain(AssociateDelegationSignerToDomainRequest associateDelegationSignerToDomainRequest)
Creates a delegation signer (DS) record in the registry zone for this domain name.
|
CancelDomainTransferToAnotherAwsAccountResult |
cancelDomainTransferToAnotherAwsAccount(CancelDomainTransferToAnotherAwsAccountRequest cancelDomainTransferToAnotherAwsAccountRequest)
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services
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.
|
DeleteDomainResult |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
This operation deletes the specified domain.
|
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. |
DisassociateDelegationSignerFromDomainResult |
disassociateDelegationSignerFromDomain(DisassociateDelegationSignerFromDomainRequest disassociateDelegationSignerFromDomainRequest)
Deletes a delegation signer (DS) record in the registry zone for this domain name.
|
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 Amazon
Web Services 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 Amazon Web Services
account if no filtering conditions are used.
|
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.
|
ListPricesResult |
listPrices(ListPricesRequest listPricesRequest)
Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
|
ListTagsForDomainResult |
listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest)
This operation returns all of the tags that are associated with the specified domain.
|
PushDomainResult |
pushDomain(PushDomainRequest pushDomainRequest)
Moves a domain from Amazon Web Services to another registrar.
|
RegisterDomainResult |
registerDomain(RegisterDomainRequest registerDomainRequest)
This operation registers a domain.
|
RejectDomainTransferFromAnotherAwsAccountResult |
rejectDomainTransferFromAnotherAwsAccount(RejectDomainTransferFromAnotherAwsAccountRequest rejectDomainTransferFromAnotherAwsAccountRequest)
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services
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.
|
ResendOperationAuthorizationResult |
resendOperationAuthorization(ResendOperationAuthorizationRequest resendOperationAuthorizationRequest)
Resend the form of authorization email for this operation.
|
RetrieveDomainAuthCodeResult |
retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest)
This operation returns the authorization code 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 Amazon Web Services account to another Amazon Web Services 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 Amazon Web Services account for a specified period
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
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.
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.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)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.
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.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)AcceptDomainTransferFromAnotherAwsAccountResult acceptDomainTransferFromAnotherAwsAccount(AcceptDomainTransferFromAnotherAwsAccountRequest acceptDomainTransferFromAnotherAwsAccountRequest)
Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise CLI will throw an error from domain transfer input that includes single quotes.
Use either ListOperations
or
GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
Domain Transfer from Aws Account 111122223333 has been cancelled.
acceptDomainTransferFromAnotherAwsAccountRequest - The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.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.UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).AssociateDelegationSignerToDomainResult associateDelegationSignerToDomain(AssociateDelegationSignerToDomainRequest associateDelegationSignerToDomainRequest)
Creates a delegation signer (DS) record in the registry zone for this domain name.
Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may render your domain name unavailable on the internet if the steps are completed in the wrong order, or with incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC signing in the Route 53 developer guide.
associateDelegationSignerToDomainRequest - DuplicateRequestException - The request is already in progress for the domain.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.TLDRulesViolationException - The top-level domain does not support this operation.UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).DnssecLimitExceededException - This error is returned if you call AssociateDelegationSignerToDomain when the specified
domain has reached the maximum number of DS records. You can't add any additional DS records unless you
delete an existing one first.CancelDomainTransferToAnotherAwsAccountResult cancelDomainTransferToAnotherAwsAccount(CancelDomainTransferToAnotherAwsAccountRequest cancelDomainTransferToAnotherAwsAccountRequest)
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount.
Use either ListOperations
or
GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
Domain Transfer from Aws Account 111122223333 has been cancelled.
cancelDomainTransferToAnotherAwsAccountRequest - The CancelDomainTransferToAnotherAwsAccount request includes the following element.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).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.
checkDomainAvailabilityRequest - The CheckDomainAvailability request contains the following elements.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).CheckDomainTransferabilityResult checkDomainTransferability(CheckDomainTransferabilityRequest checkDomainTransferabilityRequest)
Checks whether a domain name can be transferred to Amazon Route 53.
checkDomainTransferabilityRequest - The CheckDomainTransferability request contains the following elements.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).DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name registration.
To transfer the domain registration to another registrar, use the transfer process that’s provided by the registrar to which you want to transfer the registration. Otherwise, the following apply:
You can’t get a refund for the cost of a deleted domain registration.
The registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).
When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will
come from noreply@domainnameverification.net or noreply@registrar.amazon.com.
deleteDomainRequest - 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.UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).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.
deleteTagsForDomainRequest - The DeleteTagsForDomainRequest includes the following elements.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).DisableDomainAutoRenewResult disableDomainAutoRenew(DisableDomainAutoRenewRequest disableDomainAutoRenewRequest)
This operation disables automatic renewal of domain registration for the specified domain.
disableDomainAutoRenewRequest - 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).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.
disableDomainTransferLockRequest - The DisableDomainTransferLock request includes the following element.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).DisassociateDelegationSignerFromDomainResult disassociateDelegationSignerFromDomain(DisassociateDelegationSignerFromDomainRequest disassociateDelegationSignerFromDomainRequest)
Deletes a delegation signer (DS) record in the registry zone for this domain name.
disassociateDelegationSignerFromDomainRequest - DuplicateRequestException - The request is already in progress for the domain.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.TLDRulesViolationException - The top-level domain does not support this operation.UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).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 Amazon Web Services account.
The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see Domains That You Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period so we can complete processing before the deadline.
enableDomainAutoRenewRequest - 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.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.
enableDomainTransferLockRequest - A request to set the transfer lock for the specified domain.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).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.
getContactReachabilityStatusRequest - 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).GetDomainDetailResult getDomainDetail(GetDomainDetailRequest getDomainDetailRequest)
This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. Contact information for the domain is also returned as part of the output.
getDomainDetailRequest - The GetDomainDetail request includes the following element.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).GetDomainSuggestionsResult getDomainSuggestions(GetDomainSuggestionsRequest getDomainSuggestionsRequest)
The GetDomainSuggestions operation returns a list of suggested domain names.
getDomainSuggestionsRequest - 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).GetOperationDetailResult getOperationDetail(GetOperationDetailRequest getOperationDetailRequest)
This operation returns the current status of an operation that is not completed.
getOperationDetailRequest - The
GetOperationDetail request includes the following element.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.ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest)
This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account if no filtering conditions are used.
listDomainsRequest - The ListDomains request includes the following elements.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.ListDomainsResult listDomains()
listDomains(ListDomainsRequest)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.
This command runs only in the us-east-1 Region.
listOperationsRequest - The ListOperations request includes the following elements.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.ListOperationsResult listOperations()
listOperations(ListOperationsRequest)ListPricesResult listPrices(ListPricesRequest listPricesRequest)
Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
Registration
Transfer
Owner change
Domain renewal
Domain restoration
listPricesRequest - 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).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.
listTagsForDomainRequest - The ListTagsForDomainRequest includes the following elements.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).PushDomainResult pushDomain(PushDomainRequest pushDomainRequest)
Moves a domain from Amazon Web Services to another registrar.
Supported actions:
Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be transferred to another registrar.
pushDomainRequest - 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).RegisterDomainResult registerDomain(RegisterDomainRequest registerDomainRequest)
This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters.
When you register a domain, Amazon Route 53 does the following:
Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
Enables auto renew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
Optionally enables privacy protection, so WHOIS queries return contact for the registrar or the phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner." If you don't enable privacy protection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all 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 Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
registerDomainRequest - The RegisterDomain request includes the following elements.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.RejectDomainTransferFromAnotherAwsAccountResult rejectDomainTransferFromAnotherAwsAccount(RejectDomainTransferFromAnotherAwsAccountRequest rejectDomainTransferFromAnotherAwsAccountRequest)
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
Use either ListOperations
or
GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
Domain Transfer from Aws Account 111122223333 has been cancelled.
rejectDomainTransferFromAnotherAwsAccountRequest - The RejectDomainTransferFromAnotherAwsAccount request includes the following element.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).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 Amazon Web Services account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
renewDomainRequest - A RenewDomain request includes the number of years that you want to renew for and the current
expiration year.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.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.
resendContactReachabilityEmailRequest - 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).ResendOperationAuthorizationResult resendOperationAuthorization(ResendOperationAuthorizationRequest resendOperationAuthorizationRequest)
Resend the form of authorization email for this operation.
resendOperationAuthorizationRequest - 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.RetrieveDomainAuthCodeResult retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest)
This operation returns the authorization code for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
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.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).TransferDomainResult transferDomain(TransferDomainRequest transferDomainRequest)
Transfers a domain from another registrar to Amazon Route 53.
For more information about transferring domains, see the following topics:
For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring to Route 53, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
For information about how to transfer a domain to another domain registrar, see Transferring a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner contact after the transfer is complete. For more information, see UpdateDomainContact.
If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you transfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.
If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.
If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
transferDomainRequest - The TransferDomain request includes the following elements.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.TransferDomainToAnotherAwsAccountResult transferDomainToAnotherAwsAccount(TransferDomainToAnotherAwsAccountRequest transferDomainToAnotherAwsAccountRequest)
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:
The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.
When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see Migrating a Hosted Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide.
Use either ListOperations
or
GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
Domain Transfer from Aws Account 111122223333 has been cancelled.
transferDomainToAnotherAwsAccountRequest - The TransferDomainToAnotherAwsAccount request includes the following elements.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.UnsupportedTLDException - Amazon Route 53 does not support this top-level domain (TLD).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 operation. If the request is not completed successfully, the domain registrant will be notified by email.
updateDomainContactRequest - The UpdateDomainContact request includes the following elements.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).UpdateDomainContactPrivacyResult updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest)
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your contact information is replaced with contact information for the registrar or with the phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner."
While some domains may allow different privacy settings per contact, we recommend specifying the same privacy setting for all contacts.
This operation affects only the contact information for the specified contact type (administrative, registrant, or technical). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
By disabling the privacy service via API, you consent to the publication of the contact information provided for
this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have
the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection
using either UpdateDomainContactPrivacy or the Route 53 console. Enabling privacy protection removes
the contact information provided for this domain from the WHOIS database. For more information on our privacy
practices, see https://aws.amazon.com/privacy/.
updateDomainContactPrivacyRequest - The UpdateDomainContactPrivacy request includes the following elements.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).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.
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.
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).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.
updateTagsForDomainRequest - The UpdateTagsForDomainRequest includes the following elements.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).ViewBillingResult viewBilling(ViewBillingRequest viewBillingRequest)
Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
viewBillingRequest - The ViewBilling request includes the following elements.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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.