AbstractAmazonRoute53Domains (AWS Java SDK for Amazon Route53 1.10.37 API)

java.lang.Object
- com.amazonaws.services.route53domains.AbstractAmazonRoute53Domains

All Implemented Interfaces:

AmazonRoute53Domains

Direct Known Subclasses:

AbstractAmazonRoute53DomainsAsync
```
public class AbstractAmazonRoute53Domains
extends Object
implements AmazonRoute53Domains
```
Abstract implementation of AmazonRoute53Domains. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAmazonRoute53Domains()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAmazonRoute53Domains()`

Method Summary

Methods
Modifier and Type	Method and Description
`CheckDomainAvailabilityResult`	`checkDomainAvailability(CheckDomainAvailabilityRequest request)` This operation checks the availability of one domain name.
`DeleteTagsForDomainResult`	`deleteTagsForDomain(DeleteTagsForDomainRequest request)` This operation deletes the specified tags for a domain.
`DisableDomainAutoRenewResult`	`disableDomainAutoRenew(DisableDomainAutoRenewRequest request)` This operation disables automatic renewal of domain registration for the specified domain.
`DisableDomainTransferLockResult`	`disableDomainTransferLock(DisableDomainTransferLockRequest request)` This operation removes the transfer lock on the domain (specifically the `clientTransferProhibited` status) to allow domain transfers.
`EnableDomainAutoRenewResult`	`enableDomainAutoRenew(EnableDomainAutoRenewRequest request)` This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires.
`EnableDomainTransferLockResult`	`enableDomainTransferLock(EnableDomainTransferLockRequest request)` This operation sets the transfer lock on the domain (specifically the `clientTransferProhibited` status) to prevent domain transfers.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDomainDetailResult`	`getDomainDetail(GetDomainDetailRequest request)` This operation returns detailed information about the domain.
`GetOperationDetailResult`	`getOperationDetail(GetOperationDetailRequest request)` This operation returns the current status of an operation that is not completed.
`ListDomainsResult`	`listDomains()` Simplified method form for invoking the ListDomains operation.
`ListDomainsResult`	`listDomains(ListDomainsRequest request)` This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
`ListOperationsResult`	`listOperations()` Simplified method form for invoking the ListOperations operation.
`ListOperationsResult`	`listOperations(ListOperationsRequest request)` This operation returns the operation IDs of operations that are not yet complete.
`ListTagsForDomainResult`	`listTagsForDomain(ListTagsForDomainRequest request)` This operation returns all of the tags that are associated with the specified domain.
`RegisterDomainResult`	`registerDomain(RegisterDomainRequest request)` This operation registers a domain.
`RetrieveDomainAuthCodeResult`	`retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest request)` This operation returns the AuthCode for the domain.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://route53domains.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonRoute53Domains.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TransferDomainResult`	`transferDomain(TransferDomainRequest request)` This operation transfers a domain from another registrar to Amazon Route 53.
`UpdateDomainContactResult`	`updateDomainContact(UpdateDomainContactRequest request)` This operation updates the contact information for a particular domain.
`UpdateDomainContactPrivacyResult`	`updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest request)` This operation updates the specified domain contact's privacy setting.
`UpdateDomainNameserversResult`	`updateDomainNameservers(UpdateDomainNameserversRequest request)` This operation replaces the current set of name servers for the domain with the specified set of name servers.
`UpdateTagsForDomainResult`	`updateTagsForDomain(UpdateTagsForDomainRequest request)` This operation adds or updates tags for a specified domain.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAmazonRoute53Domains
```
protected AbstractAmazonRoute53Domains()
```
- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from 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 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.
    
    Specified by:
    
    setEndpoint in interface AmazonRoute53Domains
    
    Parameters:
    endpoint - The endpoint (ex: "route53domains.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://route53domains.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonRoute53Domains
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AmazonRoute53Domains
    
    Parameters:
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    See Also:
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - checkDomainAvailability
```
public CheckDomainAvailabilityResult checkDomainAvailability(CheckDomainAvailabilityRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    checkDomainAvailability in interface AmazonRoute53Domains
    
    Parameters:
    request - The CheckDomainAvailability request contains the following elements.
    
    Returns:
    Result of the CheckDomainAvailability operation returned by the service.
  - deleteTagsForDomain
```
public DeleteTagsForDomainResult deleteTagsForDomain(DeleteTagsForDomainRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    This operation deletes the specified tags for a domain.
    
    All tag operations are eventually consistent; subsequent operations may not immediately represent all issued operations.
    
    Specified by:
    
    deleteTagsForDomain in interface AmazonRoute53Domains
    
    Parameters:
    request - The DeleteTagsForDomainRequest includes the following elements.
    
    Returns:
    Result of the DeleteTagsForDomain operation returned by the service.
  - disableDomainAutoRenew
```
public DisableDomainAutoRenewResult disableDomainAutoRenew(DisableDomainAutoRenewRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    disableDomainAutoRenew in interface AmazonRoute53Domains
    
    Returns:
    Result of the DisableDomainAutoRenew operation returned by the service.
  - disableDomainTransferLock
```
public DisableDomainTransferLockResult disableDomainTransferLock(DisableDomainTransferLockRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    disableDomainTransferLock in interface AmazonRoute53Domains
    
    Parameters:
    request - The DisableDomainTransferLock request includes the following element.
    
    Returns:
    Result of the DisableDomainTransferLock operation returned by the service.
  - enableDomainAutoRenew
```
public EnableDomainAutoRenewResult enableDomainAutoRenew(EnableDomainAutoRenewRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    enableDomainAutoRenew in interface AmazonRoute53Domains
    
    Returns:
    Result of the EnableDomainAutoRenew operation returned by the service.
  - enableDomainTransferLock
```
public EnableDomainTransferLockResult enableDomainTransferLock(EnableDomainTransferLockRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    enableDomainTransferLock in interface AmazonRoute53Domains
    
    Parameters:
    request - The EnableDomainTransferLock request includes the following element.
    
    Returns:
    Result of the EnableDomainTransferLock operation returned by the service.
  - getDomainDetail
```
public GetDomainDetailResult getDomainDetail(GetDomainDetailRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.
    
    Specified by:
    
    getDomainDetail in interface AmazonRoute53Domains
    
    Parameters:
    request - The GetDomainDetail request includes the following element.
    
    Returns:
    Result of the GetDomainDetail operation returned by the service.
  - getOperationDetail
```
public GetOperationDetailResult getOperationDetail(GetOperationDetailRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    This operation returns the current status of an operation that is not completed.
    
    Specified by:
    
    getOperationDetail in interface AmazonRoute53Domains
    
    Parameters:
    request - The GetOperationDetail request includes the following element.
    
    Returns:
    Result of the GetOperationDetail operation returned by the service.
  - listDomains
```
public ListDomainsResult listDomains(ListDomainsRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
    
    Specified by:
    
    listDomains in interface AmazonRoute53Domains
    
    Parameters:
    request - The ListDomains request includes the following elements.
    
    Returns:
    Result of the ListDomains operation returned by the service.
  - listDomains
```
public ListDomainsResult listDomains()
```
    Description copied from interface: AmazonRoute53Domains
    
    Simplified method form for invoking the ListDomains operation.
    
    Specified by:
    
    listDomains in interface AmazonRoute53Domains
    
    See Also:
    AmazonRoute53Domains.listDomains(ListDomainsRequest)
  - listOperations
```
public ListOperationsResult listOperations(ListOperationsRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    This operation returns the operation IDs of operations that are not yet complete.
    
    Specified by:
    
    listOperations in interface AmazonRoute53Domains
    
    Parameters:
    request - The ListOperations request includes the following elements.
    
    Returns:
    Result of the ListOperations operation returned by the service.
  - listOperations
```
public ListOperationsResult listOperations()
```
    Description copied from interface: AmazonRoute53Domains
    
    Simplified method form for invoking the ListOperations operation.
    
    Specified by:
    
    listOperations in interface AmazonRoute53Domains
    
    See Also:
    AmazonRoute53Domains.listOperations(ListOperationsRequest)
  - listTagsForDomain
```
public ListTagsForDomainResult listTagsForDomain(ListTagsForDomainRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    listTagsForDomain in interface AmazonRoute53Domains
    
    Parameters:
    request - The ListTagsForDomainRequest includes the following elements.
    
    Returns:
    Result of the ListTagsForDomain operation returned by the service.
  - registerDomain
```
public RegisterDomainResult registerDomain(RegisterDomainRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    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.
    Specified by:
    
    registerDomain in interface AmazonRoute53Domains
    
    Parameters:
    request - The RegisterDomain request includes the following elements.
    
    Returns:
    Result of the RegisterDomain operation returned by the service.
  - retrieveDomainAuthCode
```
public RetrieveDomainAuthCodeResult retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
    
    Specified by:
    
    retrieveDomainAuthCode in interface AmazonRoute53Domains
    
    Parameters:
    request - The RetrieveDomainAuthCode request includes the following element.
    
    Returns:
    Result of the RetrieveDomainAuthCode operation returned by the service.
  - transferDomain
```
public TransferDomainResult transferDomain(TransferDomainRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    transferDomain in interface AmazonRoute53Domains
    
    Parameters:
    request - The TransferDomain request includes the following elements.
    
    Returns:
    Result of the TransferDomain operation returned by the service.
  - updateDomainContact
```
public UpdateDomainContactResult updateDomainContact(UpdateDomainContactRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    updateDomainContact in interface AmazonRoute53Domains
    
    Parameters:
    request - The UpdateDomainContact request includes the following elements.
    
    Returns:
    Result of the UpdateDomainContact operation returned by the service.
  - updateDomainContactPrivacy
```
public UpdateDomainContactPrivacyResult updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    updateDomainContactPrivacy in interface AmazonRoute53Domains
    
    Parameters:
    request - The UpdateDomainContactPrivacy request includes the following elements.
    
    Returns:
    Result of the UpdateDomainContactPrivacy operation returned by the service.
  - updateDomainNameservers
```
public UpdateDomainNameserversResult updateDomainNameservers(UpdateDomainNameserversRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    updateDomainNameservers in interface AmazonRoute53Domains
    
    Parameters:
    request - The UpdateDomainNameserver request includes the following elements.
    
    Returns:
    Result of the UpdateDomainNameservers operation returned by the service.
  - updateTagsForDomain
```
public UpdateTagsForDomainResult updateTagsForDomain(UpdateTagsForDomainRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    updateTagsForDomain in interface AmazonRoute53Domains
    
    Parameters:
    request - The UpdateTagsForDomainRequest includes the following elements.
    
    Returns:
    Result of the UpdateTagsForDomain operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonRoute53Domains
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonRoute53Domains
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonRoute53Domains
    
    Parameters:
    request - The originally executed request.
    
    Returns:
    The response metadata for the specified request, or null if none is available.

Class AbstractAmazonRoute53Domains

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAmazonRoute53Domains

Method Detail

setEndpoint

setRegion

checkDomainAvailability

deleteTagsForDomain

disableDomainAutoRenew

disableDomainTransferLock

enableDomainAutoRenew

enableDomainTransferLock

getDomainDetail

getOperationDetail

listDomains

listDomains

listOperations

listOperations

listTagsForDomain

registerDomain

retrieveDomainAuthCode

transferDomain

updateDomainContact

updateDomainContactPrivacy

updateDomainNameservers

updateTagsForDomain

shutdown

getCachedResponseMetadata