@Generated(value="software.amazon.awssdk:codegen") public interface Route53DomainsClient extends SdkClient
builder()
method.
Amazon Route 53 API actions let you register domain names and perform related operations.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static Route53DomainsClientBuilder |
builder()
Create a builder that can be used to configure and create a
Route53DomainsClient . |
default CheckDomainAvailabilityResponse |
checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest)
This operation checks the availability of one domain name.
|
default CheckDomainAvailabilityResponse |
checkDomainAvailability(Consumer<CheckDomainAvailabilityRequest.Builder> checkDomainAvailabilityRequest)
This operation checks the availability of one domain name.
|
default CheckDomainTransferabilityResponse |
checkDomainTransferability(CheckDomainTransferabilityRequest checkDomainTransferabilityRequest)
Checks whether a domain name can be transferred to Amazon Route 53.
|
default CheckDomainTransferabilityResponse |
checkDomainTransferability(Consumer<CheckDomainTransferabilityRequest.Builder> checkDomainTransferabilityRequest)
Checks whether a domain name can be transferred to Amazon Route 53.
|
static Route53DomainsClient |
create()
Create a
Route53DomainsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default DeleteTagsForDomainResponse |
deleteTagsForDomain(Consumer<DeleteTagsForDomainRequest.Builder> deleteTagsForDomainRequest)
This operation deletes the specified tags for a domain.
|
default DeleteTagsForDomainResponse |
deleteTagsForDomain(DeleteTagsForDomainRequest deleteTagsForDomainRequest)
This operation deletes the specified tags for a domain.
|
default DisableDomainAutoRenewResponse |
disableDomainAutoRenew(Consumer<DisableDomainAutoRenewRequest.Builder> disableDomainAutoRenewRequest)
This operation disables automatic renewal of domain registration for the specified domain.
|
default DisableDomainAutoRenewResponse |
disableDomainAutoRenew(DisableDomainAutoRenewRequest disableDomainAutoRenewRequest)
This operation disables automatic renewal of domain registration for the specified domain.
|
default DisableDomainTransferLockResponse |
disableDomainTransferLock(Consumer<DisableDomainTransferLockRequest.Builder> disableDomainTransferLockRequest)
This operation removes the transfer lock on the domain (specifically the
clientTransferProhibited
status) to allow domain transfers. |
default DisableDomainTransferLockResponse |
disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest)
This operation removes the transfer lock on the domain (specifically the
clientTransferProhibited
status) to allow domain transfers. |
default EnableDomainAutoRenewResponse |
enableDomainAutoRenew(Consumer<EnableDomainAutoRenewRequest.Builder> enableDomainAutoRenewRequest)
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain
registration expires.
|
default EnableDomainAutoRenewResponse |
enableDomainAutoRenew(EnableDomainAutoRenewRequest enableDomainAutoRenewRequest)
This operation configures Amazon Route 53 to automatically renew the specified domain before the domain
registration expires.
|
default EnableDomainTransferLockResponse |
enableDomainTransferLock(Consumer<EnableDomainTransferLockRequest.Builder> enableDomainTransferLockRequest)
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited
status) to prevent domain transfers. |
default EnableDomainTransferLockResponse |
enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest)
This operation sets the transfer lock on the domain (specifically the
clientTransferProhibited
status) to prevent domain transfers. |
default GetContactReachabilityStatusResponse |
getContactReachabilityStatus(Consumer<GetContactReachabilityStatusRequest.Builder> getContactReachabilityStatusRequest)
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.
|
default GetContactReachabilityStatusResponse |
getContactReachabilityStatus(GetContactReachabilityStatusRequest getContactReachabilityStatusRequest)
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.
|
default GetDomainDetailResponse |
getDomainDetail(Consumer<GetDomainDetailRequest.Builder> getDomainDetailRequest)
This operation returns detailed information about a specified domain that is associated with the current AWS
account.
|
default GetDomainDetailResponse |
getDomainDetail(GetDomainDetailRequest getDomainDetailRequest)
This operation returns detailed information about a specified domain that is associated with the current AWS
account.
|
default GetDomainSuggestionsResponse |
getDomainSuggestions(Consumer<GetDomainSuggestionsRequest.Builder> getDomainSuggestionsRequest)
The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a
domain name or simply a word or phrase (without spaces).
|
default GetDomainSuggestionsResponse |
getDomainSuggestions(GetDomainSuggestionsRequest getDomainSuggestionsRequest)
The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a
domain name or simply a word or phrase (without spaces).
|
default GetOperationDetailResponse |
getOperationDetail(Consumer<GetOperationDetailRequest.Builder> getOperationDetailRequest)
This operation returns the current status of an operation that is not completed.
|
default GetOperationDetailResponse |
getOperationDetail(GetOperationDetailRequest getOperationDetailRequest)
This operation returns the current status of an operation that is not completed.
|
default ListDomainsResponse |
listDomains()
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
|
default ListDomainsResponse |
listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
|
default ListDomainsResponse |
listDomains(ListDomainsRequest listDomainsRequest)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
|
default ListDomainsIterable |
listDomainsPaginator()
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
|
default ListDomainsIterable |
listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
|
default ListDomainsIterable |
listDomainsPaginator(ListDomainsRequest listDomainsRequest)
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
|
default ListOperationsResponse |
listOperations()
This operation returns the operation IDs of operations that are not yet complete.
|
default ListOperationsResponse |
listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest)
This operation returns the operation IDs of operations that are not yet complete.
|
default ListOperationsResponse |
listOperations(ListOperationsRequest listOperationsRequest)
This operation returns the operation IDs of operations that are not yet complete.
|
default ListOperationsIterable |
listOperationsPaginator()
This operation returns the operation IDs of operations that are not yet complete.
|
default ListOperationsIterable |
listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest)
This operation returns the operation IDs of operations that are not yet complete.
|
default ListOperationsIterable |
listOperationsPaginator(ListOperationsRequest listOperationsRequest)
This operation returns the operation IDs of operations that are not yet complete.
|
default ListTagsForDomainResponse |
listTagsForDomain(Consumer<ListTagsForDomainRequest.Builder> listTagsForDomainRequest)
This operation returns all of the tags that are associated with the specified domain.
|
default ListTagsForDomainResponse |
listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest)
This operation returns all of the tags that are associated with the specified domain.
|
default RegisterDomainResponse |
registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest)
This operation registers a domain.
|
default RegisterDomainResponse |
registerDomain(RegisterDomainRequest registerDomainRequest)
This operation registers a domain.
|
default RenewDomainResponse |
renewDomain(Consumer<RenewDomainRequest.Builder> renewDomainRequest)
This operation renews a domain for the specified number of years.
|
default RenewDomainResponse |
renewDomain(RenewDomainRequest renewDomainRequest)
This operation renews a domain for the specified number of years.
|
default ResendContactReachabilityEmailResponse |
resendContactReachabilityEmail()
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.
|
default ResendContactReachabilityEmailResponse |
resendContactReachabilityEmail(Consumer<ResendContactReachabilityEmailRequest.Builder> resendContactReachabilityEmailRequest)
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.
|
default ResendContactReachabilityEmailResponse |
resendContactReachabilityEmail(ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest)
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.
|
default RetrieveDomainAuthCodeResponse |
retrieveDomainAuthCode(Consumer<RetrieveDomainAuthCodeRequest.Builder> retrieveDomainAuthCodeRequest)
This operation returns the AuthCode for the domain.
|
default RetrieveDomainAuthCodeResponse |
retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest)
This operation returns the AuthCode for the domain.
|
static ServiceMetadata |
serviceMetadata() |
default TransferDomainResponse |
transferDomain(Consumer<TransferDomainRequest.Builder> transferDomainRequest)
This operation transfers a domain from another registrar to Amazon Route 53.
|
default TransferDomainResponse |
transferDomain(TransferDomainRequest transferDomainRequest)
This operation transfers a domain from another registrar to Amazon Route 53.
|
default UpdateDomainContactResponse |
updateDomainContact(Consumer<UpdateDomainContactRequest.Builder> updateDomainContactRequest)
This operation updates the contact information for a particular domain.
|
default UpdateDomainContactResponse |
updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest)
This operation updates the contact information for a particular domain.
|
default UpdateDomainContactPrivacyResponse |
updateDomainContactPrivacy(Consumer<UpdateDomainContactPrivacyRequest.Builder> updateDomainContactPrivacyRequest)
This operation updates the specified domain contact's privacy setting.
|
default UpdateDomainContactPrivacyResponse |
updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest)
This operation updates the specified domain contact's privacy setting.
|
default UpdateDomainNameserversResponse |
updateDomainNameservers(Consumer<UpdateDomainNameserversRequest.Builder> updateDomainNameserversRequest)
This operation replaces the current set of name servers for the domain with the specified set of name servers.
|
default UpdateDomainNameserversResponse |
updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest)
This operation replaces the current set of name servers for the domain with the specified set of name servers.
|
default UpdateTagsForDomainResponse |
updateTagsForDomain(Consumer<UpdateTagsForDomainRequest.Builder> updateTagsForDomainRequest)
This operation adds or updates tags for a specified domain.
|
default UpdateTagsForDomainResponse |
updateTagsForDomain(UpdateTagsForDomainRequest updateTagsForDomainRequest)
This operation adds or updates tags for a specified domain.
|
default ViewBillingResponse |
viewBilling(Consumer<ViewBillingRequest.Builder> viewBillingRequest)
Returns all the domain-related billing records for the current AWS account for a specified period
|
default ViewBillingResponse |
viewBilling(ViewBillingRequest viewBillingRequest)
Returns all the domain-related billing records for the current AWS account for a specified period
|
serviceName
close
static final String SERVICE_NAME
static Route53DomainsClient create()
Route53DomainsClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static Route53DomainsClientBuilder builder()
Route53DomainsClient
.default CheckDomainAvailabilityResponse checkDomainAvailability(CheckDomainAvailabilityRequest checkDomainAvailabilityRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
checkDomainAvailabilityRequest
- The CheckDomainAvailability request contains the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CheckDomainAvailabilityResponse checkDomainAvailability(Consumer<CheckDomainAvailabilityRequest.Builder> checkDomainAvailabilityRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
This is a convenience which creates an instance of the CheckDomainAvailabilityRequest.Builder
avoiding
the need to create one manually via CheckDomainAvailabilityRequest.builder()
checkDomainAvailabilityRequest
- A Consumer
that will call methods on CheckDomainAvailabilityRequest.Builder
to create a
request. The CheckDomainAvailability request contains the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CheckDomainTransferabilityResponse checkDomainTransferability(CheckDomainTransferabilityRequest checkDomainTransferabilityRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
Checks whether a domain name can be transferred to Amazon Route 53.
checkDomainTransferabilityRequest
- The CheckDomainTransferability request contains the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CheckDomainTransferabilityResponse checkDomainTransferability(Consumer<CheckDomainTransferabilityRequest.Builder> checkDomainTransferabilityRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
Checks whether a domain name can be transferred to Amazon Route 53.
This is a convenience which creates an instance of the CheckDomainTransferabilityRequest.Builder
avoiding
the need to create one manually via CheckDomainTransferabilityRequest.builder()
checkDomainTransferabilityRequest
- A Consumer
that will call methods on CheckDomainTransferabilityRequest.Builder
to create a
request. The CheckDomainTransferability request contains the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTagsForDomainResponse deleteTagsForDomain(DeleteTagsForDomainRequest deleteTagsForDomainRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
deleteTagsForDomainRequest
- The DeleteTagsForDomainRequest includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteTagsForDomainResponse deleteTagsForDomain(Consumer<DeleteTagsForDomainRequest.Builder> deleteTagsForDomainRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation deletes the specified tags for a domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
This is a convenience which creates an instance of the DeleteTagsForDomainRequest.Builder
avoiding the
need to create one manually via DeleteTagsForDomainRequest.builder()
deleteTagsForDomainRequest
- A Consumer
that will call methods on DeleteTagsForDomainRequest.Builder
to create a
request. The DeleteTagsForDomainRequest includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableDomainAutoRenewResponse disableDomainAutoRenew(DisableDomainAutoRenewRequest disableDomainAutoRenewRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation disables automatic renewal of domain registration for the specified domain.
disableDomainAutoRenewRequest
- InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableDomainAutoRenewResponse disableDomainAutoRenew(Consumer<DisableDomainAutoRenewRequest.Builder> disableDomainAutoRenewRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation disables automatic renewal of domain registration for the specified domain.
This is a convenience which creates an instance of the DisableDomainAutoRenewRequest.Builder
avoiding the
need to create one manually via DisableDomainAutoRenewRequest.builder()
disableDomainAutoRenewRequest
- A Consumer
that will call methods on DisableDomainAutoRenewRequest.Builder
to create a
request.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableDomainTransferLockResponse disableDomainTransferLock(DisableDomainTransferLockRequest disableDomainTransferLockRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
disableDomainTransferLockRequest
- The DisableDomainTransferLock request includes the following element.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DisableDomainTransferLockResponse disableDomainTransferLock(Consumer<DisableDomainTransferLockRequest.Builder> disableDomainTransferLockRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
This is a convenience which creates an instance of the DisableDomainTransferLockRequest.Builder
avoiding
the need to create one manually via DisableDomainTransferLockRequest.builder()
disableDomainTransferLockRequest
- A Consumer
that will call methods on DisableDomainTransferLockRequest.Builder
to create a
request. The DisableDomainTransferLock request includes the following element.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableDomainAutoRenewResponse enableDomainAutoRenew(EnableDomainAutoRenewRequest enableDomainAutoRenewRequest) throws InvalidInputException, UnsupportedTldException, TldRulesViolationException, AwsServiceException, SdkClientException, Route53DomainsException
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 associate, Gandi. Amazon 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.
enableDomainAutoRenewRequest
- InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).TldRulesViolationException
- The top-level domain does not support this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableDomainAutoRenewResponse enableDomainAutoRenew(Consumer<EnableDomainAutoRenewRequest.Builder> enableDomainAutoRenewRequest) throws InvalidInputException, UnsupportedTldException, TldRulesViolationException, AwsServiceException, SdkClientException, Route53DomainsException
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 associate, Gandi. Amazon 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.
This is a convenience which creates an instance of the EnableDomainAutoRenewRequest.Builder
avoiding the
need to create one manually via EnableDomainAutoRenewRequest.builder()
enableDomainAutoRenewRequest
- A Consumer
that will call methods on EnableDomainAutoRenewRequest.Builder
to create a
request.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).TldRulesViolationException
- The top-level domain does not support this operation.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableDomainTransferLockResponse enableDomainTransferLock(EnableDomainTransferLockRequest enableDomainTransferLockRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
enableDomainTransferLockRequest
- A request to set the transfer lock for the specified domain.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default EnableDomainTransferLockResponse enableDomainTransferLock(Consumer<EnableDomainTransferLockRequest.Builder> enableDomainTransferLockRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
This is a convenience which creates an instance of the EnableDomainTransferLockRequest.Builder
avoiding
the need to create one manually via EnableDomainTransferLockRequest.builder()
enableDomainTransferLockRequest
- A Consumer
that will call methods on EnableDomainTransferLockRequest.Builder
to create a
request. A request to set the transfer lock for the specified domain.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContactReachabilityStatusResponse getContactReachabilityStatus(GetContactReachabilityStatusRequest getContactReachabilityStatusRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
getContactReachabilityStatusRequest
- InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContactReachabilityStatusResponse getContactReachabilityStatus(Consumer<GetContactReachabilityStatusRequest.Builder> getContactReachabilityStatusRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
This is a convenience which creates an instance of the GetContactReachabilityStatusRequest.Builder
avoiding the need to create one manually via GetContactReachabilityStatusRequest.builder()
getContactReachabilityStatusRequest
- A Consumer
that will call methods on GetContactReachabilityStatusRequest.Builder
to create
a request.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDomainDetailResponse getDomainDetail(GetDomainDetailRequest getDomainDetailRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.
getDomainDetailRequest
- The GetDomainDetail request includes the following element.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDomainDetailResponse getDomainDetail(Consumer<GetDomainDetailRequest.Builder> getDomainDetailRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns detailed information about a specified domain that is associated with the current AWS account. Contact information for the domain is also returned as part of the output.
This is a convenience which creates an instance of the GetDomainDetailRequest.Builder
avoiding the need
to create one manually via GetDomainDetailRequest.builder()
getDomainDetailRequest
- A Consumer
that will call methods on GetDomainDetailRequest.Builder
to create a request.
The GetDomainDetail request includes the following element.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDomainSuggestionsResponse getDomainSuggestions(GetDomainSuggestionsRequest getDomainSuggestionsRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).
getDomainSuggestionsRequest
- InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDomainSuggestionsResponse getDomainSuggestions(Consumer<GetDomainSuggestionsRequest.Builder> getDomainSuggestionsRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
The GetDomainSuggestions operation returns a list of suggested domain names given a string, which can either be a domain name or simply a word or phrase (without spaces).
This is a convenience which creates an instance of the GetDomainSuggestionsRequest.Builder
avoiding the
need to create one manually via GetDomainSuggestionsRequest.builder()
getDomainSuggestionsRequest
- A Consumer
that will call methods on GetDomainSuggestionsRequest.Builder
to create a
request.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetOperationDetailResponse getOperationDetail(GetOperationDetailRequest getOperationDetailRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the current status of an operation that is not completed.
getOperationDetailRequest
- The GetOperationDetail request includes the following element.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetOperationDetailResponse getOperationDetail(Consumer<GetOperationDetailRequest.Builder> getOperationDetailRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the current status of an operation that is not completed.
This is a convenience which creates an instance of the GetOperationDetailRequest.Builder
avoiding the
need to create one manually via GetOperationDetailRequest.builder()
getOperationDetailRequest
- A Consumer
that will call methods on GetOperationDetailRequest.Builder
to create a
request. The GetOperationDetail request includes the following element.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsResponse listDomains() throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDomains(ListDomainsRequest)
,
AWS API
Documentationdefault ListDomainsResponse listDomains(ListDomainsRequest listDomainsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
listDomainsRequest
- The ListDomains request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsResponse listDomains(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
This is a convenience which creates an instance of the ListDomainsRequest.Builder
avoiding the need to
create one manually via ListDomainsRequest.builder()
listDomainsRequest
- A Consumer
that will call methods on ListDomainsRequest.Builder
to create a request. The
ListDomains request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsIterable listDomainsPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
This is a variant of
listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client .listDomainsPaginator(request); for (software.amazon.awssdk.services.route53domains.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)
operation.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDomainsPaginator(ListDomainsRequest)
,
AWS API
Documentationdefault ListDomainsIterable listDomainsPaginator(ListDomainsRequest listDomainsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
This is a variant of
listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client .listDomainsPaginator(request); for (software.amazon.awssdk.services.route53domains.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)
operation.
listDomainsRequest
- The ListDomains request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDomainsIterable listDomainsPaginator(Consumer<ListDomainsRequest.Builder> listDomainsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
This is a variant of
listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client .listDomainsPaginator(request); for (software.amazon.awssdk.services.route53domains.model.ListDomainsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.route53domains.paginators.ListDomainsIterable responses = client.listDomainsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)
operation.
This is a convenience which creates an instance of the ListDomainsRequest.Builder
avoiding the need to
create one manually via ListDomainsRequest.builder()
listDomainsRequest
- A Consumer
that will call methods on ListDomainsRequest.Builder
to create a request. The
ListDomains request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOperationsResponse listOperations() throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the operation IDs of operations that are not yet complete.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listOperations(ListOperationsRequest)
,
AWS
API Documentationdefault ListOperationsResponse listOperations(ListOperationsRequest listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the operation IDs of operations that are not yet complete.
listOperationsRequest
- The ListOperations request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOperationsResponse listOperations(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the operation IDs of operations that are not yet complete.
This is a convenience which creates an instance of the ListOperationsRequest.Builder
avoiding the need to
create one manually via ListOperationsRequest.builder()
listOperationsRequest
- A Consumer
that will call methods on ListOperationsRequest.Builder
to create a request.
The ListOperations request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOperationsIterable listOperationsPaginator() throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the operation IDs of operations that are not yet complete.
This is a variant of
listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client .listOperationsPaginator(request); for (software.amazon.awssdk.services.route53domains.model.ListOperationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)
operation.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listOperationsPaginator(ListOperationsRequest)
,
AWS
API Documentationdefault ListOperationsIterable listOperationsPaginator(ListOperationsRequest listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the operation IDs of operations that are not yet complete.
This is a variant of
listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client .listOperationsPaginator(request); for (software.amazon.awssdk.services.route53domains.model.ListOperationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)
operation.
listOperationsRequest
- The ListOperations request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListOperationsIterable listOperationsPaginator(Consumer<ListOperationsRequest.Builder> listOperationsRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the operation IDs of operations that are not yet complete.
This is a variant of
listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)
operation.
The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally
handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client .listOperationsPaginator(request); for (software.amazon.awssdk.services.route53domains.model.ListOperationsResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.route53domains.paginators.ListOperationsIterable responses = client.listOperationsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)
operation.
This is a convenience which creates an instance of the ListOperationsRequest.Builder
avoiding the need to
create one manually via ListOperationsRequest.builder()
listOperationsRequest
- A Consumer
that will call methods on ListOperationsRequest.Builder
to create a request.
The ListOperations request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForDomainResponse listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all of the tags that are associated with the specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
listTagsForDomainRequest
- The ListTagsForDomainRequest includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForDomainResponse listTagsForDomain(Consumer<ListTagsForDomainRequest.Builder> listTagsForDomainRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns all of the tags that are associated with the specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
This is a convenience which creates an instance of the ListTagsForDomainRequest.Builder
avoiding the need
to create one manually via ListTagsForDomainRequest.builder()
listTagsForDomainRequest
- A Consumer
that will call methods on ListTagsForDomainRequest.Builder
to create a request.
The ListTagsForDomainRequest includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterDomainResponse registerDomain(RegisterDomainRequest registerDomainRequest) throws InvalidInputException, UnsupportedTldException, DuplicateRequestException, TldRulesViolationException, DomainLimitExceededException, OperationLimitExceededException, AwsServiceException, SdkClientException, Route53DomainsException
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). 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 either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the 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.
registerDomainRequest
- The RegisterDomain request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.DomainLimitExceededException
- The number of domains has exceeded the allowed threshold for the account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RegisterDomainResponse registerDomain(Consumer<RegisterDomainRequest.Builder> registerDomainRequest) throws InvalidInputException, UnsupportedTldException, DuplicateRequestException, TldRulesViolationException, DomainLimitExceededException, OperationLimitExceededException, AwsServiceException, SdkClientException, Route53DomainsException
This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by our registrar associate, Gandi (for all other domains). 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 either for Amazon Registrar (for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy protection, WHOIS queries return the information that you entered for the 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.
This is a convenience which creates an instance of the RegisterDomainRequest.Builder
avoiding the need to
create one manually via RegisterDomainRequest.builder()
registerDomainRequest
- A Consumer
that will call methods on RegisterDomainRequest.Builder
to create a request.
The RegisterDomain request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.DomainLimitExceededException
- The number of domains has exceeded the allowed threshold for the account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RenewDomainResponse renewDomain(RenewDomainRequest renewDomainRequest) throws InvalidInputException, UnsupportedTldException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, AwsServiceException, SdkClientException, Route53DomainsException
This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
renewDomainRequest
- A RenewDomain
request includes the number of years that you want to renew for and the current
expiration year.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RenewDomainResponse renewDomain(Consumer<RenewDomainRequest.Builder> renewDomainRequest) throws InvalidInputException, UnsupportedTldException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, AwsServiceException, SdkClientException, Route53DomainsException
This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
We recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the expiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see Renewing Registration for a Domain in the Amazon Route 53 Developer Guide.
This is a convenience which creates an instance of the RenewDomainRequest.Builder
avoiding the need to
create one manually via RenewDomainRequest.builder()
renewDomainRequest
- A Consumer
that will call methods on RenewDomainRequest.Builder
to create a request. A
RenewDomain
request includes the number of years that you want to renew for and the current
expiration year.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResendContactReachabilityEmailResponse resendContactReachabilityEmail() throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
resendContactReachabilityEmail(ResendContactReachabilityEmailRequest)
,
AWS API Documentationdefault ResendContactReachabilityEmailResponse resendContactReachabilityEmail(ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
resendContactReachabilityEmailRequest
- InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ResendContactReachabilityEmailResponse resendContactReachabilityEmail(Consumer<ResendContactReachabilityEmailRequest.Builder> resendContactReachabilityEmailRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
This is a convenience which creates an instance of the ResendContactReachabilityEmailRequest.Builder
avoiding the need to create one manually via ResendContactReachabilityEmailRequest.builder()
resendContactReachabilityEmailRequest
- A Consumer
that will call methods on ResendContactReachabilityEmailRequest.Builder
to
create a request.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RetrieveDomainAuthCodeResponse retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
retrieveDomainAuthCodeRequest
- A request for the authorization code for the specified domain. To transfer a domain to another registrar,
you provide this value to the new registrar.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default RetrieveDomainAuthCodeResponse retrieveDomainAuthCode(Consumer<RetrieveDomainAuthCodeRequest.Builder> retrieveDomainAuthCodeRequest) throws InvalidInputException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.
This is a convenience which creates an instance of the RetrieveDomainAuthCodeRequest.Builder
avoiding the
need to create one manually via RetrieveDomainAuthCodeRequest.builder()
retrieveDomainAuthCodeRequest
- A Consumer
that will call methods on RetrieveDomainAuthCodeRequest.Builder
to create a
request. A request for the authorization code for the specified domain. To transfer a domain to another
registrar, you provide this value to the new registrar.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TransferDomainResponse transferDomain(TransferDomainRequest transferDomainRequest) throws InvalidInputException, UnsupportedTldException, DuplicateRequestException, TldRulesViolationException, DomainLimitExceededException, OperationLimitExceededException, AwsServiceException, SdkClientException, Route53DomainsException
This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
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.
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.
transferDomainRequest
- The TransferDomain request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.DomainLimitExceededException
- The number of domains has exceeded the allowed threshold for the account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TransferDomainResponse transferDomain(Consumer<TransferDomainRequest.Builder> transferDomainRequest) throws InvalidInputException, UnsupportedTldException, DuplicateRequestException, TldRulesViolationException, DomainLimitExceededException, OperationLimitExceededException, AwsServiceException, SdkClientException, Route53DomainsException
This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with Amazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
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.
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.
This is a convenience which creates an instance of the TransferDomainRequest.Builder
avoiding the need to
create one manually via TransferDomainRequest.builder()
transferDomainRequest
- A Consumer
that will call methods on TransferDomainRequest.Builder
to create a request.
The TransferDomain request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.DomainLimitExceededException
- The number of domains has exceeded the allowed threshold for the account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDomainContactResponse updateDomainContact(UpdateDomainContactRequest updateDomainContactRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
updateDomainContactRequest
- The UpdateDomainContact request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDomainContactResponse updateDomainContact(Consumer<UpdateDomainContactRequest.Builder> updateDomainContactRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation updates the contact information for a particular domain. You must specify information for at least one contact: registrant, administrator, or technical.
If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
This is a convenience which creates an instance of the UpdateDomainContactRequest.Builder
avoiding the
need to create one manually via UpdateDomainContactRequest.builder()
updateDomainContactRequest
- A Consumer
that will call methods on UpdateDomainContactRequest.Builder
to create a
request. The UpdateDomainContact request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDomainContactPrivacyResponse updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.
This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
updateDomainContactPrivacyRequest
- The UpdateDomainContactPrivacy request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDomainContactPrivacyResponse updateDomainContactPrivacy(Consumer<UpdateDomainContactPrivacyRequest.Builder> updateDomainContactPrivacyRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, contact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org domains) or with contact information for our registrar associate, Gandi.
This operation affects only the contact information for the specified contact type (registrant, administrator, or tech). If the request succeeds, Amazon Route 53 returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
This is a convenience which creates an instance of the UpdateDomainContactPrivacyRequest.Builder
avoiding
the need to create one manually via UpdateDomainContactPrivacyRequest.builder()
updateDomainContactPrivacyRequest
- A Consumer
that will call methods on UpdateDomainContactPrivacyRequest.Builder
to create a
request. The UpdateDomainContactPrivacy request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDomainNameserversResponse updateDomainNameservers(UpdateDomainNameserversRequest updateDomainNameserversRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
updateDomainNameserversRequest
- Replaces the current set of name servers for the domain with the specified set of name servers. If you use
Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted
zone for the domain.
If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateDomainNameserversResponse updateDomainNameservers(Consumer<UpdateDomainNameserversRequest.Builder> updateDomainNameserversRequest) throws InvalidInputException, DuplicateRequestException, TldRulesViolationException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
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.
This is a convenience which creates an instance of the UpdateDomainNameserversRequest.Builder
avoiding
the need to create one manually via UpdateDomainNameserversRequest.builder()
updateDomainNameserversRequest
- A Consumer
that will call methods on UpdateDomainNameserversRequest.Builder
to create a
request. 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.
InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.DuplicateRequestException
- The request is already in progress for the domain.TldRulesViolationException
- The top-level domain does not support this operation.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateTagsForDomainResponse updateTagsForDomain(UpdateTagsForDomainRequest updateTagsForDomainRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation adds or updates tags for a specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
updateTagsForDomainRequest
- The UpdateTagsForDomainRequest includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateTagsForDomainResponse updateTagsForDomain(Consumer<UpdateTagsForDomainRequest.Builder> updateTagsForDomainRequest) throws InvalidInputException, OperationLimitExceededException, UnsupportedTldException, AwsServiceException, SdkClientException, Route53DomainsException
This operation adds or updates tags for a specified domain.
All tag operations are eventually consistent; subsequent operations might not immediately represent all issued operations.
This is a convenience which creates an instance of the UpdateTagsForDomainRequest.Builder
avoiding the
need to create one manually via UpdateTagsForDomainRequest.builder()
updateTagsForDomainRequest
- A Consumer
that will call methods on UpdateTagsForDomainRequest.Builder
to create a
request. The UpdateTagsForDomainRequest includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.OperationLimitExceededException
- The number of operations or jobs running exceeded the allowed threshold for the account.UnsupportedTldException
- Amazon Route 53 does not support this top-level domain (TLD).SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ViewBillingResponse viewBilling(ViewBillingRequest viewBillingRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
Returns all the domain-related billing records for the current AWS account for a specified period
viewBillingRequest
- The ViewBilling request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ViewBillingResponse viewBilling(Consumer<ViewBillingRequest.Builder> viewBillingRequest) throws InvalidInputException, AwsServiceException, SdkClientException, Route53DomainsException
Returns all the domain-related billing records for the current AWS account for a specified period
This is a convenience which creates an instance of the ViewBillingRequest.Builder
avoiding the need to
create one manually via ViewBillingRequest.builder()
viewBillingRequest
- A Consumer
that will call methods on ViewBillingRequest.Builder
to create a request. The
ViewBilling request includes the following elements.InvalidInputException
- The requested item is not acceptable. For example, for an OperationId it might refer to the ID of an
operation that is already completed. For a domain name, it might not be a valid domain name or belong to
the requester account.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.Route53DomainsException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.