Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
  /*
   * Copyright 2010-2015 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;
 
Interface for accessing AmazonRoute53Domains.
 
 public interface AmazonRoute53Domains {

    
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 com.amazonaws.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.

Parameters:
endpoint The endpoint (ex: "route53domains.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://route53domains.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
Throws:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
 
     public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

 
     public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

This operation checks the availability of one domain name. You can access this API without authenticating. Note that if the availability status of a domain is pending, you must submit another request to determine the availability of the domain name.

Parameters:
checkDomainAvailabilityRequest Container for the necessary parameters to execute the CheckDomainAvailability service method on AmazonRoute53Domains.
Returns:
The response from the CheckDomainAvailability service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
updateDomainContactRequest Container for the necessary parameters to execute the UpdateDomainContact service method on AmazonRoute53Domains.
Returns:
The response from the UpdateDomainContact service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public UpdateDomainContactResult updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
enableDomainAutoRenewRequest Container for the necessary parameters to execute the EnableDomainAutoRenew service method on AmazonRoute53Domains.
Returns:
The response from the EnableDomainAutoRenew service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listOperationsRequest Container for the necessary parameters to execute the ListOperations service method on AmazonRoute53Domains.
Returns:
The response from the ListOperations service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public ListOperationsResult listOperations(ListOperationsRequest listOperationsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
listDomainsRequest Container for the necessary parameters to execute the ListDomains service method on AmazonRoute53Domains.
Returns:
The response from the ListDomains service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public ListDomainsResult listDomains(ListDomainsRequest listDomainsRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
getOperationDetailRequest Container for the necessary parameters to execute the GetOperationDetail service method on AmazonRoute53Domains.
Returns:
The response from the GetOperationDetail service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public GetOperationDetailResult getOperationDetail(GetOperationDetailRequest getOperationDetailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:
disableDomainTransferLockRequest Container for the necessary parameters to execute the DisableDomainTransferLock service method on AmazonRoute53Domains.
Returns:
The response from the DisableDomainTransferLock service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

Parameters:
enableDomainTransferLockRequest Container for the necessary parameters to execute the EnableDomainTransferLock service method on AmazonRoute53Domains.
Returns:
The response from the EnableDomainTransferLock service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

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

Parameters:
updateDomainNameserversRequest Container for the necessary parameters to execute the UpdateDomainNameservers service method on AmazonRoute53Domains.
Returns:
The response from the UpdateDomainNameservers service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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

NOTE: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.

Parameters:
disableDomainAutoRenewRequest Container for the necessary parameters to execute the DisableDomainAutoRenew service method on AmazonRoute53Domains.
Returns:
The response from the DisableDomainAutoRenew service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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 .

Parameters:
registerDomainRequest Container for the necessary parameters to execute the RegisterDomain service method on AmazonRoute53Domains.
Returns:
The response from the RegisterDomain service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.DomainLimitExceededException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public RegisterDomainResult registerDomain(RegisterDomainRequest registerDomainRequest
            throws AmazonServiceExceptionAmazonClientException;

    

This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.

Parameters:
getDomainDetailRequest Container for the necessary parameters to execute the GetDomainDetail service method on AmazonRoute53Domains.
Returns:
The response from the GetDomainDetail service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public GetDomainDetailResult getDomainDetail(GetDomainDetailRequest getDomainDetailRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
updateTagsForDomainRequest Container for the necessary parameters to execute the UpdateTagsForDomain service method on AmazonRoute53Domains.
Returns:
The response from the UpdateTagsForDomain service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public UpdateTagsForDomainResult updateTagsForDomain(UpdateTagsForDomainRequest updateTagsForDomainRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

Parameters:
retrieveDomainAuthCodeRequest Container for the necessary parameters to execute the RetrieveDomainAuthCode service method on AmazonRoute53Domains.
Returns:
The response from the RetrieveDomainAuthCode service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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.

NOTE: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.

Parameters:
transferDomainRequest Container for the necessary parameters to execute the TransferDomain service method on AmazonRoute53Domains.
Returns:
The response from the TransferDomain service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.DomainLimitExceededException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public TransferDomainResult transferDomain(TransferDomainRequest transferDomainRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
updateDomainContactPrivacyRequest Container for the necessary parameters to execute the UpdateDomainContactPrivacy service method on AmazonRoute53Domains.
Returns:
The response from the UpdateDomainContactPrivacy service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.DuplicateRequestException
com.amazonaws.services.route53domains.model.TLDRulesViolationException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
listTagsForDomainRequest Container for the necessary parameters to execute the ListTagsForDomain service method on AmazonRoute53Domains.
Returns:
The response from the ListTagsForDomain service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public ListTagsForDomainResult listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest
            throws AmazonServiceExceptionAmazonClientException;

    

This operation deletes the specified tags for a domain.

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

Parameters:
deleteTagsForDomainRequest Container for the necessary parameters to execute the DeleteTagsForDomain service method on AmazonRoute53Domains.
Returns:
The response from the DeleteTagsForDomain service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.UnsupportedTLDException
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.services.route53domains.model.OperationLimitExceededException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public DeleteTagsForDomainResult deleteTagsForDomain(DeleteTagsForDomainRequest deleteTagsForDomainRequest
            throws AmazonServiceExceptionAmazonClientException;

    

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

Returns:
The response from the ListOperations service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.

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

Returns:
The response from the ListDomains service method, as returned by AmazonRoute53Domains.
Throws:
com.amazonaws.services.route53domains.model.InvalidInputException
com.amazonaws.AmazonClientException If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonRoute53Domains indicating either a problem with the data in the request, or a server side issue.
    public ListDomainsResult listDomains() throws AmazonServiceExceptionAmazonClientException;
    
    
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.
    public 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.

Parameters:
request The originally executed request.
Returns:
The response metadata for the specified request, or null if none is available.
}
        
New to GrepCode? Check out our FAQ X