public class AmazonRoute53DomainsClient extends AmazonWebServiceClient implements AmazonRoute53Domains
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> |
jsonErrorUnmarshallers
List of exception unmarshallers for all AmazonRoute53Domains exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonRoute53DomainsClient()
Constructs a new client to invoke service methods on
AmazonRoute53Domains.
|
AmazonRoute53DomainsClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonRoute53Domains using the specified AWS account credentials.
|
AmazonRoute53DomainsClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonRoute53Domains using the specified AWS account credentials
and client configuration options.
|
AmazonRoute53DomainsClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonRoute53Domains using the specified AWS account credentials provider.
|
AmazonRoute53DomainsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonRoute53Domains using the specified AWS account credentials
provider and client configuration options.
|
AmazonRoute53DomainsClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonRoute53Domains using the specified AWS account credentials
provider, client configuration options and request metric collector.
|
AmazonRoute53DomainsClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonRoute53Domains.
|
Modifier and Type | Method and Description |
---|---|
CheckDomainAvailabilityResult |
checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest)
This operation checks the availability of one domain name.
|
DisableDomainTransferLockResult |
disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest)
This operation removes the transfer lock on the domain (specifically
the
clientTransferProhibited status) to allow domain
transfers. |
EnableDomainTransferLockResult |
enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest)
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited status) to prevent domain
transfers. |
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for
debugging issues where a service isn't acting as expected.
|
GetDomainDetailResult |
getDomainDetail(GetDomainDetailRequest getDomainDetailRequest)
This operation returns detailed information about the domain.
|
GetOperationDetailResult |
getOperationDetail(GetOperationDetailRequest getOperationDetailRequest)
This operation returns the current status of an operation that is not
completed.
|
ListDomainsResult |
listDomains()
This operation returns all the domain names registered with Amazon
Route 53 for the current AWS account.
|
ListDomainsResult |
listDomains(ListDomainsRequest listDomainsRequest)
This operation returns all the domain names registered with Amazon
Route 53 for the current AWS account.
|
ListOperationsResult |
listOperations()
This operation returns the operation IDs of operations that are not
yet complete.
|
ListOperationsResult |
listOperations(ListOperationsRequest listOperationsRequest)
This operation returns the operation IDs of operations that are not
yet complete.
|
RegisterDomainResult |
registerDomain(RegisterDomainRequest registerDomainRequest)
This operation registers a domain.
|
RetrieveDomainAuthCodeResult |
retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest)
This operation returns the AuthCode for the domain.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client.
|
void |
setEndpoint(String endpoint,
String serviceName,
String regionId)
An internal method that is not expected to be normally
called except for AWS internal development purposes.
|
TransferDomainResult |
transferDomain(TransferDomainRequest transferDomainRequest)
This operation transfers a domain from another registrar to Amazon
Route 53.
|
UpdateDomainContactResult |
updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest)
This operation updates the contact information for a particular
domain.
|
UpdateDomainContactPrivacyResult |
updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest)
This operation updates the specified domain contact's privacy
setting.
|
UpdateDomainNameserversResult |
updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest)
This operation replaces the current set of name servers for the
domain with the specified set of name servers.
|
addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setRegion, shutdown
protected List<com.amazonaws.transform.JsonErrorUnmarshaller> jsonErrorUnmarshallers
public AmazonRoute53DomainsClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonRoute53DomainsClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonRoute53Domains
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonRoute53DomainsClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonRoute53DomainsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonRoute53Domains
(ex: proxy settings, retry counts, etc.).public AmazonRoute53DomainsClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonRoute53DomainsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonRoute53Domains
(ex: proxy settings, retry counts, etc.).public AmazonRoute53DomainsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonRoute53Domains
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic UpdateDomainContactResult updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest)
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.
updateDomainContact
in interface AmazonRoute53Domains
updateDomainContactRequest
- Container for the necessary
parameters to execute the UpdateDomainContact service method on
AmazonRoute53Domains.InvalidInputException
DuplicateRequestException
TLDRulesViolationException
OperationLimitExceededException
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.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 CheckDomainAvailabilityResult checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest)
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.
checkDomainAvailability
in interface AmazonRoute53Domains
checkDomainAvailabilityRequest
- Container for the necessary
parameters to execute the CheckDomainAvailability service method on
AmazonRoute53Domains.UnsupportedTLDException
InvalidInputException
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.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)
This operation returns the operation IDs of operations that are not yet complete.
listOperations
in interface AmazonRoute53Domains
listOperationsRequest
- Container for the necessary parameters to
execute the ListOperations service method on AmazonRoute53Domains.InvalidInputException
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.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)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
listDomains
in interface AmazonRoute53Domains
listDomainsRequest
- Container for the necessary parameters to
execute the ListDomains service method on AmazonRoute53Domains.InvalidInputException
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.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)
This operation returns the current status of an operation that is not completed.
getOperationDetail
in interface AmazonRoute53Domains
getOperationDetailRequest
- Container for the necessary
parameters to execute the GetOperationDetail service method on
AmazonRoute53Domains.InvalidInputException
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.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 DisableDomainTransferLockResult disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest)
This operation removes the transfer lock on the domain (specifically
the clientTransferProhibited
status) to allow domain
transfers. We recommend you refrain from performing this action unless
you intend to transfer the domain to a different registrar. Successful
submission returns an operation ID that you can use to track the
progress and completion of the action. If the request is not completed
successfully, the domain registrant will be notified by email.
disableDomainTransferLock
in interface AmazonRoute53Domains
disableDomainTransferLockRequest
- Container for the necessary
parameters to execute the DisableDomainTransferLock service method on
AmazonRoute53Domains.InvalidInputException
DuplicateRequestException
TLDRulesViolationException
OperationLimitExceededException
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.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 UpdateDomainNameserversResult updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest)
This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
updateDomainNameservers
in interface AmazonRoute53Domains
updateDomainNameserversRequest
- Container for the necessary
parameters to execute the UpdateDomainNameservers service method on
AmazonRoute53Domains.InvalidInputException
DuplicateRequestException
TLDRulesViolationException
OperationLimitExceededException
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.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 EnableDomainTransferLockResult enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest)
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited
status) to prevent domain
transfers. Successful submission returns an operation ID that you can
use to track the progress and completion of the action. If the request
is not completed successfully, the domain registrant will be notified
by email.
enableDomainTransferLock
in interface AmazonRoute53Domains
enableDomainTransferLockRequest
- Container for the necessary
parameters to execute the EnableDomainTransferLock service method on
AmazonRoute53Domains.InvalidInputException
DuplicateRequestException
TLDRulesViolationException
OperationLimitExceededException
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.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)
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:
registerDomain
in interface AmazonRoute53Domains
registerDomainRequest
- Container for the necessary parameters to
execute the RegisterDomain service method on AmazonRoute53Domains.UnsupportedTLDException
InvalidInputException
DuplicateRequestException
TLDRulesViolationException
DomainLimitExceededException
OperationLimitExceededException
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.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)
This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.
getDomainDetail
in interface AmazonRoute53Domains
getDomainDetailRequest
- Container for the necessary parameters
to execute the GetDomainDetail service method on AmazonRoute53Domains.InvalidInputException
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.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 RetrieveDomainAuthCodeResult retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest)
This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
retrieveDomainAuthCode
in interface AmazonRoute53Domains
retrieveDomainAuthCodeRequest
- Container for the necessary
parameters to execute the RetrieveDomainAuthCode service method on
AmazonRoute53Domains.InvalidInputException
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.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)
This operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the AWS registrar, Gandi upon transfer.
To transfer a domain, you need to meet all the domain transfer criteria, including the following:
We recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted zone in Amazon Route 53 for your current domain before transferring your domain.
Note that upon transfer, the domain duration is extended for a year if not otherwise specified. Autorenew is enabled by default.
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 request is not completed successfully, the domain registrant will be notified by email.
Transferring domains charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing .
transferDomain
in interface AmazonRoute53Domains
transferDomainRequest
- Container for the necessary parameters to
execute the TransferDomain service method on AmazonRoute53Domains.UnsupportedTLDException
InvalidInputException
DuplicateRequestException
TLDRulesViolationException
DomainLimitExceededException
OperationLimitExceededException
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.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 UpdateDomainContactPrivacyResult updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest)
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.
updateDomainContactPrivacy
in interface AmazonRoute53Domains
updateDomainContactPrivacyRequest
- Container for the necessary
parameters to execute the UpdateDomainContactPrivacy service method on
AmazonRoute53Domains.InvalidInputException
DuplicateRequestException
TLDRulesViolationException
OperationLimitExceededException
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.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() throws AmazonServiceException, AmazonClientException
This operation returns the operation IDs of operations that are not yet complete.
listOperations
in interface AmazonRoute53Domains
InvalidInputException
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.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 AmazonServiceException, AmazonClientException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
listDomains
in interface AmazonRoute53Domains
InvalidInputException
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.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 void setEndpoint(String endpoint)
AmazonWebServiceClient
This method is not threadsafe. Endpoints 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.
Callers can pass in just the endpoint (ex: "ec2.amazonaws.com") or a full
URL, including the protocol (ex: "https://ec2.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
setEndpoint
in interface AmazonRoute53Domains
setEndpoint
in class AmazonWebServiceClient
endpoint
- The endpoint (ex: "ec2.amazonaws.com") or a full URL,
including the protocol (ex: "https://ec2.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
AmazonWebServiceClient
Overrides the default endpoint for this client ("http://dynamodb.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.
Callers can pass in just the endpoint (ex:
"dynamodb.us-east-1.amazonaws.com/") or a full URL, including the
protocol (ex: "http://dynamodb.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
setEndpoint
in class AmazonWebServiceClient
endpoint
- The endpoint (ex: "dynamodb.us-east-1.amazonaws.com/") or a
full URL, including the protocol (ex:
"http://dynamodb.us-east-1.amazonaws.com/") of the region
specific AWS endpoint this client will communicate with.serviceName
- This parameter is ignored.regionId
- The ID of the region in which this service resides AND the
overriding region for signing purposes.IllegalArgumentException
- If any problems are detected with the specified endpoint.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonRoute53Domains
request
- The originally executed requestCopyright © 2014. All rights reserved.