com.amazonaws.services.route53domains.AmazonRoute53Domains Maven / Gradle / Ivy
Show all versions of aws-java-sdk-route53 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.route53domains;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.route53domains.model.*;
/**
* Interface for accessing Amazon Route 53 Domains.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.route53domains.AbstractAmazonRoute53Domains} instead.
*
*
*
* Amazon Route 53 API actions let you register domain names and perform related operations.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonRoute53Domains {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "route53domains";
/**
* 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 {@link 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.
*
* @param 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 use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonRoute53Domains#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
* {@link 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.
*
* @param region
* The region this client will communicate with. See {@link 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 Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
* @param acceptDomainTransferFromAnotherAwsAccountRequest
* The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws DomainLimitExceededException
* The number of domains has exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.AcceptDomainTransferFromAnotherAwsAccount
* @see AWS API Documentation
*/
AcceptDomainTransferFromAnotherAwsAccountResult acceptDomainTransferFromAnotherAwsAccount(
AcceptDomainTransferFromAnotherAwsAccountRequest acceptDomainTransferFromAnotherAwsAccountRequest);
/**
*
* 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.
*
*
* @param associateDelegationSignerToDomainRequest
* @return Result of the AssociateDelegationSignerToDomain operation returned by the service.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @throws 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.
* @sample AmazonRoute53Domains.AssociateDelegationSignerToDomain
* @see AWS API Documentation
*/
AssociateDelegationSignerToDomainResult associateDelegationSignerToDomain(AssociateDelegationSignerToDomainRequest associateDelegationSignerToDomainRequest);
/**
*
* 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.
*
*
* @param cancelDomainTransferToAnotherAwsAccountRequest
* The CancelDomainTransferToAnotherAwsAccount request includes the following element.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.CancelDomainTransferToAnotherAwsAccount
* @see AWS API Documentation
*/
CancelDomainTransferToAnotherAwsAccountResult cancelDomainTransferToAnotherAwsAccount(
CancelDomainTransferToAnotherAwsAccountRequest cancelDomainTransferToAnotherAwsAccountRequest);
/**
*
* 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.
*
*
* @param checkDomainAvailabilityRequest
* The CheckDomainAvailability request contains the following elements.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.CheckDomainAvailability
* @see AWS API Documentation
*/
CheckDomainAvailabilityResult checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest);
/**
*
* Checks whether a domain name can be transferred to Amazon Route 53.
*
*
* @param checkDomainTransferabilityRequest
* The CheckDomainTransferability request contains the following elements.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.CheckDomainTransferability
* @see AWS API Documentation
*/
CheckDomainTransferabilityResult checkDomainTransferability(CheckDomainTransferabilityRequest checkDomainTransferabilityRequest);
/**
*
* 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 [email protected] or [email protected].
*
*
*
*
* @param deleteDomainRequest
* @return Result of the DeleteDomain 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.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.DeleteDomain
* @see AWS
* API Documentation
*/
DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest);
/**
*
* This operation deletes the specified tags for a domain.
*
*
* All tag operations are eventually consistent; subsequent operations might not immediately represent all issued
* operations.
*
*
* @param deleteTagsForDomainRequest
* The DeleteTagsForDomainRequest includes the following elements.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.DeleteTagsForDomain
* @see AWS API Documentation
*/
DeleteTagsForDomainResult deleteTagsForDomain(DeleteTagsForDomainRequest deleteTagsForDomainRequest);
/**
*
* This operation disables automatic renewal of domain registration for the specified domain.
*
*
* @param disableDomainAutoRenewRequest
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.DisableDomainAutoRenew
* @see AWS API Documentation
*/
DisableDomainAutoRenewResult disableDomainAutoRenew(DisableDomainAutoRenewRequest disableDomainAutoRenewRequest);
/**
*
* 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.
*
*
* @param disableDomainTransferLockRequest
* The DisableDomainTransferLock request includes the following element.
* @return 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.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.DisableDomainTransferLock
* @see AWS API Documentation
*/
DisableDomainTransferLockResult disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest);
/**
*
* Deletes a delegation signer (DS) record in the registry zone for this domain name.
*
*
* @param disassociateDelegationSignerFromDomainRequest
* @return Result of the DisassociateDelegationSignerFromDomain operation returned by the service.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.DisassociateDelegationSignerFromDomain
* @see AWS API Documentation
*/
DisassociateDelegationSignerFromDomainResult disassociateDelegationSignerFromDomain(
DisassociateDelegationSignerFromDomainRequest disassociateDelegationSignerFromDomainRequest);
/**
*
* 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.
*
*
* @param enableDomainAutoRenewRequest
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @sample AmazonRoute53Domains.EnableDomainAutoRenew
* @see AWS API Documentation
*/
EnableDomainAutoRenewResult enableDomainAutoRenew(EnableDomainAutoRenewRequest enableDomainAutoRenewRequest);
/**
*
* 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.
*
*
* @param enableDomainTransferLockRequest
* A request to set the transfer lock for the specified domain.
* @return 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.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.EnableDomainTransferLock
* @see AWS API Documentation
*/
EnableDomainTransferLockResult enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest);
/**
*
* 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.
*
*
* @param getContactReachabilityStatusRequest
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.GetContactReachabilityStatus
* @see AWS API Documentation
*/
GetContactReachabilityStatusResult getContactReachabilityStatus(GetContactReachabilityStatusRequest getContactReachabilityStatusRequest);
/**
*
* 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.
*
*
* @param getDomainDetailRequest
* The GetDomainDetail request includes the following element.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.GetDomainDetail
* @see AWS
* API Documentation
*/
GetDomainDetailResult getDomainDetail(GetDomainDetailRequest getDomainDetailRequest);
/**
*
* The GetDomainSuggestions operation returns a list of suggested domain names.
*
*
* @param getDomainSuggestionsRequest
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.GetDomainSuggestions
* @see AWS API Documentation
*/
GetDomainSuggestionsResult getDomainSuggestions(GetDomainSuggestionsRequest getDomainSuggestionsRequest);
/**
*
* This operation returns the current status of an operation that is not completed.
*
*
* @param getOperationDetailRequest
* The
* GetOperationDetail request includes the following element.
* @return 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.
* @sample AmazonRoute53Domains.GetOperationDetail
* @see AWS API Documentation
*/
GetOperationDetailResult getOperationDetail(GetOperationDetailRequest getOperationDetailRequest);
/**
*
* 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.
*
*
* @param listDomainsRequest
* The ListDomains request includes the following elements.
* @return 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.
* @sample AmazonRoute53Domains.ListDomains
* @see AWS API
* Documentation
*/
ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest);
/**
* Simplified method form for invoking the ListDomains operation.
*
* @see #listDomains(ListDomainsRequest)
*/
ListDomainsResult listDomains();
/**
*
* 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.
*
*
* @param listOperationsRequest
* The ListOperations request includes the following elements.
* @return 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.
* @sample AmazonRoute53Domains.ListOperations
* @see AWS
* API Documentation
*/
ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest);
/**
* Simplified method form for invoking the ListOperations operation.
*
* @see #listOperations(ListOperationsRequest)
*/
ListOperationsResult listOperations();
/**
*
* 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
*
*
*
*
* @param listPricesRequest
* @return Result of the ListPrices 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.ListPrices
* @see AWS API
* Documentation
*/
ListPricesResult listPrices(ListPricesRequest listPricesRequest);
/**
*
* 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.
*
*
* @param listTagsForDomainRequest
* The ListTagsForDomainRequest includes the following elements.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.ListTagsForDomain
* @see AWS API Documentation
*/
ListTagsForDomainResult listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest);
/**
*
* 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.
*
*
*
*
* @param pushDomainRequest
* @return Result of the PushDomain 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.PushDomain
* @see AWS API
* Documentation
*/
PushDomainResult pushDomain(PushDomainRequest pushDomainRequest);
/**
*
* 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.
*
*
*
*
* @param registerDomainRequest
* The RegisterDomain request includes the following elements.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws DomainLimitExceededException
* The number of domains has exceeded the allowed threshold for the account.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @sample AmazonRoute53Domains.RegisterDomain
* @see AWS
* API Documentation
*/
RegisterDomainResult registerDomain(RegisterDomainRequest registerDomainRequest);
/**
*
* 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.
*
*
* @param rejectDomainTransferFromAnotherAwsAccountRequest
* The RejectDomainTransferFromAnotherAwsAccount request includes the following element.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.RejectDomainTransferFromAnotherAwsAccount
* @see AWS API Documentation
*/
RejectDomainTransferFromAnotherAwsAccountResult rejectDomainTransferFromAnotherAwsAccount(
RejectDomainTransferFromAnotherAwsAccountRequest rejectDomainTransferFromAnotherAwsAccountRequest);
/**
*
* 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.
*
*
* @param renewDomainRequest
* A RenewDomain request includes the number of years that you want to renew for and the current
* expiration year.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @sample AmazonRoute53Domains.RenewDomain
* @see AWS API
* Documentation
*/
RenewDomainResult renewDomain(RenewDomainRequest renewDomainRequest);
/**
*
* 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.
*
*
* @param resendContactReachabilityEmailRequest
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.ResendContactReachabilityEmail
* @see AWS API Documentation
*/
ResendContactReachabilityEmailResult resendContactReachabilityEmail(ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest);
/**
*
* Resend the form of authorization email for this operation.
*
*
* @param resendOperationAuthorizationRequest
* @return Result of the ResendOperationAuthorization 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.
* @sample AmazonRoute53Domains.ResendOperationAuthorization
* @see AWS API Documentation
*/
ResendOperationAuthorizationResult resendOperationAuthorization(ResendOperationAuthorizationRequest resendOperationAuthorizationRequest);
/**
*
* This operation returns the authorization code for the domain. To transfer a domain to another registrar, you
* provide this value to the new registrar.
*
*
* @param 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.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.RetrieveDomainAuthCode
* @see AWS API Documentation
*/
RetrieveDomainAuthCodeResult retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest);
/**
*
* 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.
*
*
* @param transferDomainRequest
* The TransferDomain request includes the following elements.
* @return 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.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws DomainLimitExceededException
* The number of domains has exceeded the allowed threshold for the account.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @sample AmazonRoute53Domains.TransferDomain
* @see AWS
* API Documentation
*/
TransferDomainResult transferDomain(TransferDomainRequest transferDomainRequest);
/**
*
* 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.
*
*
* @param transferDomainToAnotherAwsAccountRequest
* The TransferDomainToAnotherAwsAccount request includes the following elements.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.TransferDomainToAnotherAwsAccount
* @see AWS API Documentation
*/
TransferDomainToAnotherAwsAccountResult transferDomainToAnotherAwsAccount(TransferDomainToAnotherAwsAccountRequest transferDomainToAnotherAwsAccountRequest);
/**
*
* 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.
*
*
* @param updateDomainContactRequest
* The UpdateDomainContact request includes the following elements.
* @return 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.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.UpdateDomainContact
* @see AWS API Documentation
*/
UpdateDomainContactResult updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest);
/**
*
* 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/.
*
*
*
* @param updateDomainContactPrivacyRequest
* The UpdateDomainContactPrivacy request includes the following elements.
* @return 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.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.UpdateDomainContactPrivacy
* @see AWS API Documentation
*/
UpdateDomainContactPrivacyResult updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest);
/**
*
* 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.
*
*
* @param 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.
* @return 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.
* @throws DuplicateRequestException
* The request is already in progress for the domain.
* @throws TLDRulesViolationException
* The top-level domain does not support this operation.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.UpdateDomainNameservers
* @see AWS API Documentation
*/
UpdateDomainNameserversResult updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest);
/**
*
* 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.
*
*
* @param updateTagsForDomainRequest
* The UpdateTagsForDomainRequest includes the following elements.
* @return 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.
* @throws OperationLimitExceededException
* The number of operations or jobs running exceeded the allowed threshold for the account.
* @throws UnsupportedTLDException
* Amazon Route 53 does not support this top-level domain (TLD).
* @sample AmazonRoute53Domains.UpdateTagsForDomain
* @see AWS API Documentation
*/
UpdateTagsForDomainResult updateTagsForDomain(UpdateTagsForDomainRequest updateTagsForDomainRequest);
/**
*
* Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
*
*
* @param viewBillingRequest
* The ViewBilling request includes the following elements.
* @return 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.
* @sample AmazonRoute53Domains.ViewBilling
* @see AWS API
* Documentation
*/
ViewBillingResult viewBilling(ViewBillingRequest viewBillingRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}