All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.route53domains.AmazonRoute53Domains Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Route53 module holds the client classes that are used for communicating with Amazon Route53 Service

There is a newer version: 1.11.98
Show newest version
/*
 * Copyright 2010-2016 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 com.amazonaws.*;
import com.amazonaws.regions.*;

import com.amazonaws.services.route53domains.model.*;

/**
 * Interface for accessing Amazon Route 53 Domains.
 */
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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912 *

* 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. */ 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) */ void setRegion(Region region); /** *

* 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @sample AmazonRoute53Domains.CheckDomainAvailability */ CheckDomainAvailabilityResult checkDomainAvailability( CheckDomainAvailabilityRequest checkDomainAvailabilityRequest); /** *

* This operation deletes the specified tags for a domain. *

*

* All tag operations are eventually consistent; subsequent operations may * 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.DeleteTagsForDomain */ DeleteTagsForDomainResult deleteTagsForDomain( DeleteTagsForDomainRequest deleteTagsForDomainRequest); /** *

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

* Caution! Amazon Route 53 doesn't have a manual renewal process, so * if you disable automatic renewal, registration for the domain will not be * renewed when the expiration date passes, and you will lose control of the * domain name. * * @param disableDomainAutoRenewRequest * @return Result of the DisableDomainAutoRenew operation returned by the * service. * @throws InvalidInputException * The requested item is not acceptable. For example, for an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @sample AmazonRoute53Domains.DisableDomainAutoRenew */ 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.DisableDomainTransferLock */ DisableDomainTransferLockResult disableDomainTransferLock( DisableDomainTransferLockRequest disableDomainTransferLockRequest); /** *

* This operation configures Amazon Route 53 to automatically renew the * specified domain before the domain registration expires. The cost of * renewing your domain registration is billed to your AWS account. *

*

* The period during which you can renew a domain name varies by TLD. For a * list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our * registrar partner, Gandi. Route 53 requires that you renew before the end * of the renewal period that is listed on the Gandi website so we can * complete processing before the deadline. *

* * @param enableDomainAutoRenewRequest * @return Result of the EnableDomainAutoRenew operation returned by the * service. * @throws InvalidInputException * The requested item is not acceptable. For example, for an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @throws TLDRulesViolationException * The top-level domain does not support this operation. * @sample AmazonRoute53Domains.EnableDomainAutoRenew */ 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 * The EnableDomainTransferLock request includes the following * element. * @return Result of the EnableDomainTransferLock operation returned by the * service. * @throws InvalidInputException * The requested item is not acceptable. For example, for an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.EnableDomainTransferLock */ 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.GetContactReachabilityStatus */ GetContactReachabilityStatusResult getContactReachabilityStatus( GetContactReachabilityStatusRequest getContactReachabilityStatusRequest); /** *

* This operation returns detailed information about the domain. The * domain's contact information 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @sample AmazonRoute53Domains.GetDomainDetail */ GetDomainDetailResult getDomainDetail( GetDomainDetailRequest getDomainDetailRequest); /** *

* 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @sample AmazonRoute53Domains.GetOperationDetail */ GetOperationDetailResult getOperationDetail( GetOperationDetailRequest getOperationDetailRequest); /** *

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

* * @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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @sample AmazonRoute53Domains.ListDomains */ ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest); /** * Simplified method form for invoking the ListDomains operation. * * @see #listDomains(ListDomainsRequest) */ ListDomainsResult listDomains(); /** *

* This operation returns the operation IDs of operations that are not yet * complete. *

* * @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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @sample AmazonRoute53Domains.ListOperations */ ListOperationsResult listOperations( ListOperationsRequest listOperationsRequest); /** * Simplified method form for invoking the ListOperations operation. * * @see #listOperations(ListOperationsRequest) */ ListOperationsResult listOperations(); /** *

* This operation returns all of the tags that are associated with the * specified domain. *

*

* All tag operations are eventually consistent; subsequent operations may * 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.ListTagsForDomain */ ListTagsForDomainResult listTagsForDomain( ListTagsForDomainRequest listTagsForDomainRequest); /** *

* This operation registers a domain. Domains are registered by the AWS * registrar partner, Gandi. For some top-level domains (TLDs), this * operation requires extra parameters. *

*

* When you register a domain, Amazon Route 53 does the following: *

*
    *
  • Creates a Amazon Route 53 hosted zone that has the same name as the * domain. Amazon Route 53 assigns four name servers to your hosted zone and * automatically updates your domain registration with the names of these * name servers.
  • *
  • Enables autorenew, so your domain registration will renew * automatically each year. We'll notify you in advance of the renewal date * so you can choose whether to renew the registration.
  • *
  • Optionally enables privacy protection, so WHOIS queries return * contact information for our registrar partner, Gandi, instead of the * information you entered for registrant, admin, and tech contacts.
  • *
  • If registration is successful, returns an operation ID that you can * use to track the progress and completion of the action. If the request is * not completed successfully, the domain registrant is notified by email.
  • *
  • Charges your AWS account an amount based on the top-level domain. For * more information, see Amazon Route 53 * Pricing.
  • *
* * @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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @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 */ RegisterDomainResult registerDomain( RegisterDomainRequest registerDomainRequest); /** *

* 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.ResendContactReachabilityEmail */ ResendContactReachabilityEmailResult resendContactReachabilityEmail( ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest); /** *

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

* * @param retrieveDomainAuthCodeRequest * The RetrieveDomainAuthCode request includes the following element. * @return Result of the RetrieveDomainAuthCode operation returned by the * service. * @throws InvalidInputException * The requested item is not acceptable. For example, for an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @sample AmazonRoute53Domains.RetrieveDomainAuthCode */ RetrieveDomainAuthCodeResult retrieveDomainAuthCode( RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest); /** *

* This operation transfers a domain from another registrar to Amazon Route * 53. When the transfer is complete, the domain is registered with the AWS * registrar partner, Gandi. *

*

* For transfer requirements, a detailed procedure, and information about * viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the * Amazon Route 53 Developer Guide. *

*

* If the registrar for your domain is also the DNS service provider for the * domain, we highly recommend that you consider transferring your DNS * service to Amazon Route 53 or to another DNS service provider before you * transfer your registration. Some registrars provide free DNS service when * you purchase a domain registration. When you transfer the registration, * the previous registrar will not renew your domain registration and could * end your DNS service at any time. *

* Caution! 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @throws UnsupportedTLDException * Amazon Route 53 does not support this top-level domain. * @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 */ TransferDomainResult transferDomain( TransferDomainRequest transferDomainRequest); /** *

* This operation updates the contact information for a particular domain. * Information for at least one contact (registrant, administrator, or * technical) must be supplied for update. *

*

* If the update is successful, this method returns an operation ID that you * can use to track the progress and completion of the action. If the * request is not completed successfully, the domain registrant will be * notified by email. *

* * @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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.UpdateDomainContact */ UpdateDomainContactResult updateDomainContact( UpdateDomainContactRequest updateDomainContactRequest); /** *

* This operation updates the specified domain contact's privacy setting. * When the privacy option is enabled, personal information such as postal * or email address is hidden from the results of a public WHOIS query. The * privacy services are provided by the AWS registrar, Gandi. For more * information, see the Gandi privacy features. *

*

* This operation only affects the privacy of the specified contact type * (registrant, administrator, or tech). Successful acceptance returns an * operation ID that you can use with GetOperationDetail 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 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.UpdateDomainContactPrivacy */ 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 * The UpdateDomainNameserver request includes the following * elements. * @return Result of the UpdateDomainNameservers operation returned by the * service. * @throws InvalidInputException * The requested item is not acceptable. For example, for an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.UpdateDomainNameservers */ UpdateDomainNameserversResult updateDomainNameservers( UpdateDomainNameserversRequest updateDomainNameserversRequest); /** *

* This operation adds or updates tags for a specified domain. *

*

* All tag operations are eventually consistent; subsequent operations may * 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 an * OperationId it may refer to the ID of an operation that is * already completed. For a domain name, it may not be a valid * domain name or belong to the requester account. * @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. * @sample AmazonRoute53Domains.UpdateTagsForDomain */ UpdateTagsForDomainResult updateTagsForDomain( UpdateTagsForDomainRequest updateTagsForDomainRequest); /** * 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); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy