software.amazon.awssdk.services.route53domains.Route53DomainsAsyncClient Maven / Gradle / Ivy
Show all versions of route53domains Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.route53domains;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.route53domains.model.AcceptDomainTransferFromAnotherAwsAccountRequest;
import software.amazon.awssdk.services.route53domains.model.AcceptDomainTransferFromAnotherAwsAccountResponse;
import software.amazon.awssdk.services.route53domains.model.AssociateDelegationSignerToDomainRequest;
import software.amazon.awssdk.services.route53domains.model.AssociateDelegationSignerToDomainResponse;
import software.amazon.awssdk.services.route53domains.model.CancelDomainTransferToAnotherAwsAccountRequest;
import software.amazon.awssdk.services.route53domains.model.CancelDomainTransferToAnotherAwsAccountResponse;
import software.amazon.awssdk.services.route53domains.model.CheckDomainAvailabilityRequest;
import software.amazon.awssdk.services.route53domains.model.CheckDomainAvailabilityResponse;
import software.amazon.awssdk.services.route53domains.model.CheckDomainTransferabilityRequest;
import software.amazon.awssdk.services.route53domains.model.CheckDomainTransferabilityResponse;
import software.amazon.awssdk.services.route53domains.model.DeleteDomainRequest;
import software.amazon.awssdk.services.route53domains.model.DeleteDomainResponse;
import software.amazon.awssdk.services.route53domains.model.DeleteTagsForDomainRequest;
import software.amazon.awssdk.services.route53domains.model.DeleteTagsForDomainResponse;
import software.amazon.awssdk.services.route53domains.model.DisableDomainAutoRenewRequest;
import software.amazon.awssdk.services.route53domains.model.DisableDomainAutoRenewResponse;
import software.amazon.awssdk.services.route53domains.model.DisableDomainTransferLockRequest;
import software.amazon.awssdk.services.route53domains.model.DisableDomainTransferLockResponse;
import software.amazon.awssdk.services.route53domains.model.DisassociateDelegationSignerFromDomainRequest;
import software.amazon.awssdk.services.route53domains.model.DisassociateDelegationSignerFromDomainResponse;
import software.amazon.awssdk.services.route53domains.model.EnableDomainAutoRenewRequest;
import software.amazon.awssdk.services.route53domains.model.EnableDomainAutoRenewResponse;
import software.amazon.awssdk.services.route53domains.model.EnableDomainTransferLockRequest;
import software.amazon.awssdk.services.route53domains.model.EnableDomainTransferLockResponse;
import software.amazon.awssdk.services.route53domains.model.GetContactReachabilityStatusRequest;
import software.amazon.awssdk.services.route53domains.model.GetContactReachabilityStatusResponse;
import software.amazon.awssdk.services.route53domains.model.GetDomainDetailRequest;
import software.amazon.awssdk.services.route53domains.model.GetDomainDetailResponse;
import software.amazon.awssdk.services.route53domains.model.GetDomainSuggestionsRequest;
import software.amazon.awssdk.services.route53domains.model.GetDomainSuggestionsResponse;
import software.amazon.awssdk.services.route53domains.model.GetOperationDetailRequest;
import software.amazon.awssdk.services.route53domains.model.GetOperationDetailResponse;
import software.amazon.awssdk.services.route53domains.model.ListDomainsRequest;
import software.amazon.awssdk.services.route53domains.model.ListDomainsResponse;
import software.amazon.awssdk.services.route53domains.model.ListOperationsRequest;
import software.amazon.awssdk.services.route53domains.model.ListOperationsResponse;
import software.amazon.awssdk.services.route53domains.model.ListPricesRequest;
import software.amazon.awssdk.services.route53domains.model.ListPricesResponse;
import software.amazon.awssdk.services.route53domains.model.ListTagsForDomainRequest;
import software.amazon.awssdk.services.route53domains.model.ListTagsForDomainResponse;
import software.amazon.awssdk.services.route53domains.model.PushDomainRequest;
import software.amazon.awssdk.services.route53domains.model.PushDomainResponse;
import software.amazon.awssdk.services.route53domains.model.RegisterDomainRequest;
import software.amazon.awssdk.services.route53domains.model.RegisterDomainResponse;
import software.amazon.awssdk.services.route53domains.model.RejectDomainTransferFromAnotherAwsAccountRequest;
import software.amazon.awssdk.services.route53domains.model.RejectDomainTransferFromAnotherAwsAccountResponse;
import software.amazon.awssdk.services.route53domains.model.RenewDomainRequest;
import software.amazon.awssdk.services.route53domains.model.RenewDomainResponse;
import software.amazon.awssdk.services.route53domains.model.ResendContactReachabilityEmailRequest;
import software.amazon.awssdk.services.route53domains.model.ResendContactReachabilityEmailResponse;
import software.amazon.awssdk.services.route53domains.model.ResendOperationAuthorizationRequest;
import software.amazon.awssdk.services.route53domains.model.ResendOperationAuthorizationResponse;
import software.amazon.awssdk.services.route53domains.model.RetrieveDomainAuthCodeRequest;
import software.amazon.awssdk.services.route53domains.model.RetrieveDomainAuthCodeResponse;
import software.amazon.awssdk.services.route53domains.model.TransferDomainRequest;
import software.amazon.awssdk.services.route53domains.model.TransferDomainResponse;
import software.amazon.awssdk.services.route53domains.model.TransferDomainToAnotherAwsAccountRequest;
import software.amazon.awssdk.services.route53domains.model.TransferDomainToAnotherAwsAccountResponse;
import software.amazon.awssdk.services.route53domains.model.UpdateDomainContactPrivacyRequest;
import software.amazon.awssdk.services.route53domains.model.UpdateDomainContactPrivacyResponse;
import software.amazon.awssdk.services.route53domains.model.UpdateDomainContactRequest;
import software.amazon.awssdk.services.route53domains.model.UpdateDomainContactResponse;
import software.amazon.awssdk.services.route53domains.model.UpdateDomainNameserversRequest;
import software.amazon.awssdk.services.route53domains.model.UpdateDomainNameserversResponse;
import software.amazon.awssdk.services.route53domains.model.UpdateTagsForDomainRequest;
import software.amazon.awssdk.services.route53domains.model.UpdateTagsForDomainResponse;
import software.amazon.awssdk.services.route53domains.model.ViewBillingRequest;
import software.amazon.awssdk.services.route53domains.model.ViewBillingResponse;
import software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher;
import software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher;
import software.amazon.awssdk.services.route53domains.paginators.ListPricesPublisher;
import software.amazon.awssdk.services.route53domains.paginators.ViewBillingPublisher;
/**
* Service client for accessing Amazon Route 53 Domains asynchronously. This can be created using the static
* {@link #builder()} method.The asynchronous client performs non-blocking I/O when configured with any
* {@code SdkAsyncHttpClient} supported in the SDK. However, full non-blocking is not guaranteed as the async client may
* perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
* call.
*
*
* Amazon Route 53 API actions let you register domain names and perform related operations.
*
*/
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface Route53DomainsAsyncClient extends AwsClient {
String SERVICE_NAME = "route53domains";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "route53domains";
/**
*
* Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services
* account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
*
*
* If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise
* CLI will throw an error from domain transfer input that includes single quotes.
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
* @param acceptDomainTransferFromAnotherAwsAccountRequest
* The AcceptDomainTransferFromAnotherAwsAccount request includes the following elements.
* @return A Java Future containing the result of the AcceptDomainTransferFromAnotherAwsAccount operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - DomainLimitExceededException The number of domains has 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.
*
* @sample Route53DomainsAsyncClient.AcceptDomainTransferFromAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture acceptDomainTransferFromAnotherAwsAccount(
AcceptDomainTransferFromAnotherAwsAccountRequest acceptDomainTransferFromAnotherAwsAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Accepts the transfer of a domain from another Amazon Web Services account to the currentAmazon Web Services
* account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
*
*
* If you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input instead of text because otherwise
* CLI will throw an error from domain transfer input that includes single quotes.
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
*
* This is a convenience which creates an instance of the
* {@link AcceptDomainTransferFromAnotherAwsAccountRequest.Builder} avoiding the need to create one manually via
* {@link AcceptDomainTransferFromAnotherAwsAccountRequest#builder()}
*
*
* @param acceptDomainTransferFromAnotherAwsAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.AcceptDomainTransferFromAnotherAwsAccountRequest.Builder}
* to create a request. The AcceptDomainTransferFromAnotherAwsAccount request includes the following
* elements.
* @return A Java Future containing the result of the AcceptDomainTransferFromAnotherAwsAccount operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - DomainLimitExceededException The number of domains has 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.
*
* @sample Route53DomainsAsyncClient.AcceptDomainTransferFromAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture acceptDomainTransferFromAnotherAwsAccount(
Consumer acceptDomainTransferFromAnotherAwsAccountRequest) {
return acceptDomainTransferFromAnotherAwsAccount(AcceptDomainTransferFromAnotherAwsAccountRequest.builder()
.applyMutation(acceptDomainTransferFromAnotherAwsAccountRequest).build());
}
/**
*
* Creates a delegation signer (DS) record in the registry zone for this domain name.
*
*
* Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may
* render your domain name unavailable on the internet if the steps are completed in the wrong order, or with
* incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC
* signing in the Route 53 developer guide.
*
*
* @param associateDelegationSignerToDomainRequest
* @return A Java Future containing the result of the AssociateDelegationSignerToDomain operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DuplicateRequestException The request is already in progress for the domain.
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - TldRulesViolationException The top-level domain does not support this operation.
* - UnsupportedTldException Amazon Route 53 does not support this top-level domain (TLD).
* - DnssecLimitExceededException This error is returned if you call
*
AssociateDelegationSignerToDomain
when the specified domain has reached the maximum number
* of DS records. You can't add any additional DS records unless you delete an existing one first.
* - 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.
*
* @sample Route53DomainsAsyncClient.AssociateDelegationSignerToDomain
* @see AWS API Documentation
*/
default CompletableFuture associateDelegationSignerToDomain(
AssociateDelegationSignerToDomainRequest associateDelegationSignerToDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a delegation signer (DS) record in the registry zone for this domain name.
*
*
* Note that creating DS record at the registry impacts DNSSEC validation of your DNS records. This action may
* render your domain name unavailable on the internet if the steps are completed in the wrong order, or with
* incorrect timing. For more information about DNSSEC signing, see Configuring DNSSEC
* signing in the Route 53 developer guide.
*
*
*
* This is a convenience which creates an instance of the {@link AssociateDelegationSignerToDomainRequest.Builder}
* avoiding the need to create one manually via {@link AssociateDelegationSignerToDomainRequest#builder()}
*
*
* @param associateDelegationSignerToDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.AssociateDelegationSignerToDomainRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the AssociateDelegationSignerToDomain operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DuplicateRequestException The request is already in progress for the domain.
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - TldRulesViolationException The top-level domain does not support this operation.
* - UnsupportedTldException Amazon Route 53 does not support this top-level domain (TLD).
* - DnssecLimitExceededException This error is returned if you call
*
AssociateDelegationSignerToDomain
when the specified domain has reached the maximum number
* of DS records. You can't add any additional DS records unless you delete an existing one first.
* - 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.
*
* @sample Route53DomainsAsyncClient.AssociateDelegationSignerToDomain
* @see AWS API Documentation
*/
default CompletableFuture associateDelegationSignerToDomain(
Consumer associateDelegationSignerToDomainRequest) {
return associateDelegationSignerToDomain(AssociateDelegationSignerToDomainRequest.builder()
.applyMutation(associateDelegationSignerToDomainRequest).build());
}
/**
*
* Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services
* account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
*
*
*
* You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount.
*
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
* @param cancelDomainTransferToAnotherAwsAccountRequest
* The CancelDomainTransferToAnotherAwsAccount request includes the following element.
* @return A Java Future containing the result of the CancelDomainTransferToAnotherAwsAccount operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.CancelDomainTransferToAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture cancelDomainTransferToAnotherAwsAccount(
CancelDomainTransferToAnotherAwsAccountRequest cancelDomainTransferToAnotherAwsAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services
* account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
*
*
*
* You must cancel the transfer before the other Amazon Web Services account accepts the transfer using AcceptDomainTransferFromAnotherAwsAccount.
*
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
*
* This is a convenience which creates an instance of the
* {@link CancelDomainTransferToAnotherAwsAccountRequest.Builder} avoiding the need to create one manually via
* {@link CancelDomainTransferToAnotherAwsAccountRequest#builder()}
*
*
* @param cancelDomainTransferToAnotherAwsAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.CancelDomainTransferToAnotherAwsAccountRequest.Builder}
* to create a request. The CancelDomainTransferToAnotherAwsAccount request includes the following element.
* @return A Java Future containing the result of the CancelDomainTransferToAnotherAwsAccount operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.CancelDomainTransferToAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture cancelDomainTransferToAnotherAwsAccount(
Consumer cancelDomainTransferToAnotherAwsAccountRequest) {
return cancelDomainTransferToAnotherAwsAccount(CancelDomainTransferToAnotherAwsAccountRequest.builder()
.applyMutation(cancelDomainTransferToAnotherAwsAccountRequest).build());
}
/**
*
* This operation checks the availability of one domain name. Note that if the availability status of a domain is
* pending, you must submit another request to determine the availability of the domain name.
*
*
* @param checkDomainAvailabilityRequest
* The CheckDomainAvailability request contains the following elements.
* @return A Java Future containing the result of the CheckDomainAvailability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.CheckDomainAvailability
* @see AWS API Documentation
*/
default CompletableFuture checkDomainAvailability(
CheckDomainAvailabilityRequest checkDomainAvailabilityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CheckDomainAvailabilityRequest.Builder} avoiding
* the need to create one manually via {@link CheckDomainAvailabilityRequest#builder()}
*
*
* @param checkDomainAvailabilityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.CheckDomainAvailabilityRequest.Builder} to
* create a request. The CheckDomainAvailability request contains the following elements.
* @return A Java Future containing the result of the CheckDomainAvailability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.CheckDomainAvailability
* @see AWS API Documentation
*/
default CompletableFuture checkDomainAvailability(
Consumer checkDomainAvailabilityRequest) {
return checkDomainAvailability(CheckDomainAvailabilityRequest.builder().applyMutation(checkDomainAvailabilityRequest)
.build());
}
/**
*
* Checks whether a domain name can be transferred to Amazon Route 53.
*
*
* @param checkDomainTransferabilityRequest
* The CheckDomainTransferability request contains the following elements.
* @return A Java Future containing the result of the CheckDomainTransferability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.CheckDomainTransferability
* @see AWS API Documentation
*/
default CompletableFuture checkDomainTransferability(
CheckDomainTransferabilityRequest checkDomainTransferabilityRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Checks whether a domain name can be transferred to Amazon Route 53.
*
*
*
* This is a convenience which creates an instance of the {@link CheckDomainTransferabilityRequest.Builder} avoiding
* the need to create one manually via {@link CheckDomainTransferabilityRequest#builder()}
*
*
* @param checkDomainTransferabilityRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.CheckDomainTransferabilityRequest.Builder} to
* create a request. The CheckDomainTransferability request contains the following elements.
* @return A Java Future containing the result of the CheckDomainTransferability operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.CheckDomainTransferability
* @see AWS API Documentation
*/
default CompletableFuture checkDomainTransferability(
Consumer checkDomainTransferabilityRequest) {
return checkDomainTransferability(CheckDomainTransferabilityRequest.builder()
.applyMutation(checkDomainTransferabilityRequest).build());
}
/**
*
* This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name
* registration.
*
*
* To transfer the domain registration to another registrar, use the transfer process that’s provided by the
* registrar to which you want to transfer the registration. Otherwise, the following apply:
*
*
* -
*
* You can’t get a refund for the cost of a deleted domain registration.
*
*
* -
*
* The registry for the top-level domain might hold the domain name for a brief time before releasing it for other
* users to register (varies by registry).
*
*
* -
*
* When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will
* come from [email protected]
or [email protected]
.
*
*
*
*
* @param deleteDomainRequest
* @return A Java Future containing the result of the DeleteDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - DuplicateRequestException The request is already in progress for the domain.
* - TldRulesViolationException The top-level domain does not support this operation.
* - 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.
*
* @sample Route53DomainsAsyncClient.DeleteDomain
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDomain(DeleteDomainRequest deleteDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation deletes the specified domain. This action is permanent. For more information, see Deleting a domain name
* registration.
*
*
* To transfer the domain registration to another registrar, use the transfer process that’s provided by the
* registrar to which you want to transfer the registration. Otherwise, the following apply:
*
*
* -
*
* You can’t get a refund for the cost of a deleted domain registration.
*
*
* -
*
* The registry for the top-level domain might hold the domain name for a brief time before releasing it for other
* users to register (varies by registry).
*
*
* -
*
* When the registration has been deleted, we'll send you a confirmation to the registrant contact. The email will
* come from [email protected]
or [email protected]
.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link DeleteDomainRequest.Builder} avoiding the need to
* create one manually via {@link DeleteDomainRequest#builder()}
*
*
* @param deleteDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.DeleteDomainRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the DeleteDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - DuplicateRequestException The request is already in progress for the domain.
* - TldRulesViolationException The top-level domain does not support this operation.
* - 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.
*
* @sample Route53DomainsAsyncClient.DeleteDomain
* @see AWS
* API Documentation
*/
default CompletableFuture deleteDomain(Consumer deleteDomainRequest) {
return deleteDomain(DeleteDomainRequest.builder().applyMutation(deleteDomainRequest).build());
}
/**
*
* This operation deletes the specified tags for a domain.
*
*
* All tag operations are eventually consistent; subsequent operations might not immediately represent all issued
* operations.
*
*
* @param deleteTagsForDomainRequest
* The DeleteTagsForDomainRequest includes the following elements.
* @return A Java Future containing the result of the DeleteTagsForDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.DeleteTagsForDomain
* @see AWS API Documentation
*/
default CompletableFuture deleteTagsForDomain(
DeleteTagsForDomainRequest deleteTagsForDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DeleteTagsForDomainRequest.Builder} avoiding the
* need to create one manually via {@link DeleteTagsForDomainRequest#builder()}
*
*
* @param deleteTagsForDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.DeleteTagsForDomainRequest.Builder} to create
* a request. The DeleteTagsForDomainRequest includes the following elements.
* @return A Java Future containing the result of the DeleteTagsForDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.DeleteTagsForDomain
* @see AWS API Documentation
*/
default CompletableFuture deleteTagsForDomain(
Consumer deleteTagsForDomainRequest) {
return deleteTagsForDomain(DeleteTagsForDomainRequest.builder().applyMutation(deleteTagsForDomainRequest).build());
}
/**
*
* This operation disables automatic renewal of domain registration for the specified domain.
*
*
* @param disableDomainAutoRenewRequest
* @return A Java Future containing the result of the DisableDomainAutoRenew operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.DisableDomainAutoRenew
* @see AWS API Documentation
*/
default CompletableFuture disableDomainAutoRenew(
DisableDomainAutoRenewRequest disableDomainAutoRenewRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation disables automatic renewal of domain registration for the specified domain.
*
*
*
* This is a convenience which creates an instance of the {@link DisableDomainAutoRenewRequest.Builder} avoiding the
* need to create one manually via {@link DisableDomainAutoRenewRequest#builder()}
*
*
* @param disableDomainAutoRenewRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.DisableDomainAutoRenewRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the DisableDomainAutoRenew operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.DisableDomainAutoRenew
* @see AWS API Documentation
*/
default CompletableFuture disableDomainAutoRenew(
Consumer disableDomainAutoRenewRequest) {
return disableDomainAutoRenew(DisableDomainAutoRenewRequest.builder().applyMutation(disableDomainAutoRenewRequest)
.build());
}
/**
*
* This operation removes the transfer lock on the domain (specifically the clientTransferProhibited
* status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to
* transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to
* track the progress and completion of the action. If the request is not completed successfully, the domain
* registrant will be notified by email.
*
*
* @param disableDomainTransferLockRequest
* The DisableDomainTransferLock request includes the following element.
* @return A Java Future containing the result of the DisableDomainTransferLock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.DisableDomainTransferLock
* @see AWS API Documentation
*/
default CompletableFuture disableDomainTransferLock(
DisableDomainTransferLockRequest disableDomainTransferLockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link DisableDomainTransferLockRequest.Builder} avoiding
* the need to create one manually via {@link DisableDomainTransferLockRequest#builder()}
*
*
* @param disableDomainTransferLockRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.DisableDomainTransferLockRequest.Builder} to
* create a request. The DisableDomainTransferLock request includes the following element.
* @return A Java Future containing the result of the DisableDomainTransferLock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.DisableDomainTransferLock
* @see AWS API Documentation
*/
default CompletableFuture disableDomainTransferLock(
Consumer disableDomainTransferLockRequest) {
return disableDomainTransferLock(DisableDomainTransferLockRequest.builder()
.applyMutation(disableDomainTransferLockRequest).build());
}
/**
*
* Deletes a delegation signer (DS) record in the registry zone for this domain name.
*
*
* @param disassociateDelegationSignerFromDomainRequest
* @return A Java Future containing the result of the DisassociateDelegationSignerFromDomain operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DuplicateRequestException The request is already in progress for the domain.
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - TldRulesViolationException The top-level domain does not support this operation.
* - 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.
*
* @sample Route53DomainsAsyncClient.DisassociateDelegationSignerFromDomain
* @see AWS API Documentation
*/
default CompletableFuture disassociateDelegationSignerFromDomain(
DisassociateDelegationSignerFromDomainRequest disassociateDelegationSignerFromDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a delegation signer (DS) record in the registry zone for this domain name.
*
*
*
* This is a convenience which creates an instance of the
* {@link DisassociateDelegationSignerFromDomainRequest.Builder} avoiding the need to create one manually via
* {@link DisassociateDelegationSignerFromDomainRequest#builder()}
*
*
* @param disassociateDelegationSignerFromDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.DisassociateDelegationSignerFromDomainRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the DisassociateDelegationSignerFromDomain operation returned by
* the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - DuplicateRequestException The request is already in progress for the domain.
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - TldRulesViolationException The top-level domain does not support this operation.
* - 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.
*
* @sample Route53DomainsAsyncClient.DisassociateDelegationSignerFromDomain
* @see AWS API Documentation
*/
default CompletableFuture disassociateDelegationSignerFromDomain(
Consumer disassociateDelegationSignerFromDomainRequest) {
return disassociateDelegationSignerFromDomain(DisassociateDelegationSignerFromDomainRequest.builder()
.applyMutation(disassociateDelegationSignerFromDomainRequest).build());
}
/**
*
* 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 Amazon Web Services
* account.
*
*
* The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies,
* see Domains That You
* Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you
* renew before the end of the renewal period so we can complete processing before the deadline.
*
*
* @param enableDomainAutoRenewRequest
* @return A Java Future containing the result of the EnableDomainAutoRenew operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.EnableDomainAutoRenew
* @see AWS API Documentation
*/
default CompletableFuture enableDomainAutoRenew(
EnableDomainAutoRenewRequest enableDomainAutoRenewRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 Amazon Web Services
* account.
*
*
* The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies,
* see Domains That You
* Can Register with Amazon Route 53 in the Amazon Route 53 Developer Guide. Route 53 requires that you
* renew before the end of the renewal period so we can complete processing before the deadline.
*
*
*
* This is a convenience which creates an instance of the {@link EnableDomainAutoRenewRequest.Builder} avoiding the
* need to create one manually via {@link EnableDomainAutoRenewRequest#builder()}
*
*
* @param enableDomainAutoRenewRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.EnableDomainAutoRenewRequest.Builder} to
* create a request.
* @return A Java Future containing the result of the EnableDomainAutoRenew operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.EnableDomainAutoRenew
* @see AWS API Documentation
*/
default CompletableFuture enableDomainAutoRenew(
Consumer enableDomainAutoRenewRequest) {
return enableDomainAutoRenew(EnableDomainAutoRenewRequest.builder().applyMutation(enableDomainAutoRenewRequest).build());
}
/**
*
* This operation sets the transfer lock on the domain (specifically the clientTransferProhibited
* status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the
* progress and completion of the action. If the request is not completed successfully, the domain registrant will
* be notified by email.
*
*
* @param enableDomainTransferLockRequest
* A request to set the transfer lock for the specified domain.
* @return A Java Future containing the result of the EnableDomainTransferLock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.EnableDomainTransferLock
* @see AWS API Documentation
*/
default CompletableFuture enableDomainTransferLock(
EnableDomainTransferLockRequest enableDomainTransferLockRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link EnableDomainTransferLockRequest.Builder} avoiding
* the need to create one manually via {@link EnableDomainTransferLockRequest#builder()}
*
*
* @param enableDomainTransferLockRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.EnableDomainTransferLockRequest.Builder} to
* create a request. A request to set the transfer lock for the specified domain.
* @return A Java Future containing the result of the EnableDomainTransferLock operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.EnableDomainTransferLock
* @see AWS API Documentation
*/
default CompletableFuture enableDomainTransferLock(
Consumer enableDomainTransferLockRequest) {
return enableDomainTransferLock(EnableDomainTransferLockRequest.builder().applyMutation(enableDomainTransferLockRequest)
.build());
}
/**
*
* For operations that require confirmation that the email address for the registrant contact is valid, such as
* registering a new domain, this operation returns information about whether the registrant contact has responded.
*
*
* If you want us to resend the email, use the ResendContactReachabilityEmail
operation.
*
*
* @param getContactReachabilityStatusRequest
* @return A Java Future containing the result of the GetContactReachabilityStatus operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetContactReachabilityStatus
* @see AWS API Documentation
*/
default CompletableFuture getContactReachabilityStatus(
GetContactReachabilityStatusRequest getContactReachabilityStatusRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link GetContactReachabilityStatusRequest.Builder}
* avoiding the need to create one manually via {@link GetContactReachabilityStatusRequest#builder()}
*
*
* @param getContactReachabilityStatusRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.GetContactReachabilityStatusRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the GetContactReachabilityStatus operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetContactReachabilityStatus
* @see AWS API Documentation
*/
default CompletableFuture getContactReachabilityStatus(
Consumer getContactReachabilityStatusRequest) {
return getContactReachabilityStatus(GetContactReachabilityStatusRequest.builder()
.applyMutation(getContactReachabilityStatusRequest).build());
}
/**
*
* This operation returns detailed information about a specified domain that is associated with the current Amazon
* Web Services account. Contact information for the domain is also returned as part of the output.
*
*
* @param getDomainDetailRequest
* The GetDomainDetail request includes the following element.
* @return A Java Future containing the result of the GetDomainDetail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetDomainDetail
* @see AWS API Documentation
*/
default CompletableFuture getDomainDetail(GetDomainDetailRequest getDomainDetailRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns detailed information about a specified domain that is associated with the current Amazon
* Web Services account. Contact information for the domain is also returned as part of the output.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainDetailRequest.Builder} avoiding the need
* to create one manually via {@link GetDomainDetailRequest#builder()}
*
*
* @param getDomainDetailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.GetDomainDetailRequest.Builder} to create a
* request. The GetDomainDetail request includes the following element.
* @return A Java Future containing the result of the GetDomainDetail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetDomainDetail
* @see AWS API Documentation
*/
default CompletableFuture getDomainDetail(
Consumer getDomainDetailRequest) {
return getDomainDetail(GetDomainDetailRequest.builder().applyMutation(getDomainDetailRequest).build());
}
/**
*
* The GetDomainSuggestions operation returns a list of suggested domain names.
*
*
* @param getDomainSuggestionsRequest
* @return A Java Future containing the result of the GetDomainSuggestions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetDomainSuggestions
* @see AWS API Documentation
*/
default CompletableFuture getDomainSuggestions(
GetDomainSuggestionsRequest getDomainSuggestionsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* The GetDomainSuggestions operation returns a list of suggested domain names.
*
*
*
* This is a convenience which creates an instance of the {@link GetDomainSuggestionsRequest.Builder} avoiding the
* need to create one manually via {@link GetDomainSuggestionsRequest#builder()}
*
*
* @param getDomainSuggestionsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.GetDomainSuggestionsRequest.Builder} to create
* a request.
* @return A Java Future containing the result of the GetDomainSuggestions operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetDomainSuggestions
* @see AWS API Documentation
*/
default CompletableFuture getDomainSuggestions(
Consumer getDomainSuggestionsRequest) {
return getDomainSuggestions(GetDomainSuggestionsRequest.builder().applyMutation(getDomainSuggestionsRequest).build());
}
/**
*
* This operation returns the current status of an operation that is not completed.
*
*
* @param getOperationDetailRequest
* The
* GetOperationDetail request includes the following element.
* @return A Java Future containing the result of the GetOperationDetail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetOperationDetail
* @see AWS API Documentation
*/
default CompletableFuture getOperationDetail(GetOperationDetailRequest getOperationDetailRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns the current status of an operation that is not completed.
*
*
*
* This is a convenience which creates an instance of the {@link GetOperationDetailRequest.Builder} avoiding the
* need to create one manually via {@link GetOperationDetailRequest#builder()}
*
*
* @param getOperationDetailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.GetOperationDetailRequest.Builder} to create a
* request. The GetOperationDetail request includes the following element.
* @return A Java Future containing the result of the GetOperationDetail operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.GetOperationDetail
* @see AWS API Documentation
*/
default CompletableFuture getOperationDetail(
Consumer getOperationDetailRequest) {
return getOperationDetail(GetOperationDetailRequest.builder().applyMutation(getOperationDetailRequest).build());
}
/**
*
* This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services
* account if no filtering conditions are used.
*
*
* @param listDomainsRequest
* The ListDomains request includes the following elements.
* @return A Java Future containing the result of the ListDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListDomains
* @see AWS
* API Documentation
*/
default CompletableFuture listDomains(ListDomainsRequest listDomainsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services
* account if no filtering conditions are used.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainsRequest.Builder} avoiding the need to
* create one manually via {@link ListDomainsRequest#builder()}
*
*
* @param listDomainsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListDomainsRequest.Builder} to create a
* request. The ListDomains request includes the following elements.
* @return A Java Future containing the result of the ListDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListDomains
* @see AWS
* API Documentation
*/
default CompletableFuture listDomains(Consumer listDomainsRequest) {
return listDomains(ListDomainsRequest.builder().applyMutation(listDomainsRequest).build());
}
/**
*
* This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services
* account if no filtering conditions are used.
*
*
* @return A Java Future containing the result of the ListDomains operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListDomains
* @see AWS
* API Documentation
*/
default CompletableFuture listDomains() {
return listDomains(ListDomainsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)} operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListDomains
* @see AWS
* API Documentation
*/
default ListDomainsPublisher listDomainsPaginator() {
return listDomainsPaginator(ListDomainsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)} operation.
*
*
* @param listDomainsRequest
* The ListDomains request includes the following elements.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListDomains
* @see AWS
* API Documentation
*/
default ListDomainsPublisher listDomainsPaginator(ListDomainsRequest listDomainsRequest) {
return new ListDomainsPublisher(this, listDomainsRequest);
}
/**
*
* This is a variant of
* {@link #listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListDomainsPublisher publisher = client.listDomainsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListDomainsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listDomains(software.amazon.awssdk.services.route53domains.model.ListDomainsRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListDomainsRequest.Builder} avoiding the need to
* create one manually via {@link ListDomainsRequest#builder()}
*
*
* @param listDomainsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListDomainsRequest.Builder} to create a
* request. The ListDomains request includes the following elements.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListDomains
* @see AWS
* API Documentation
*/
default ListDomainsPublisher listDomainsPaginator(Consumer listDomainsRequest) {
return listDomainsPaginator(ListDomainsRequest.builder().applyMutation(listDomainsRequest).build());
}
/**
*
* Returns information about all of the operations that return an operation ID and that have ever been performed on
* domains that were registered by the current account.
*
*
* This command runs only in the us-east-1 Region.
*
*
* @param listOperationsRequest
* The ListOperations request includes the following elements.
* @return A Java Future containing the result of the ListOperations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListOperations
* @see AWS
* API Documentation
*/
default CompletableFuture listOperations(ListOperationsRequest listOperationsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns information about all of the operations that return an operation ID and that have ever been performed on
* domains that were registered by the current account.
*
*
* This command runs only in the us-east-1 Region.
*
*
*
* This is a convenience which creates an instance of the {@link ListOperationsRequest.Builder} avoiding the need to
* create one manually via {@link ListOperationsRequest#builder()}
*
*
* @param listOperationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListOperationsRequest.Builder} to create a
* request. The ListOperations request includes the following elements.
* @return A Java Future containing the result of the ListOperations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListOperations
* @see AWS
* API Documentation
*/
default CompletableFuture listOperations(Consumer listOperationsRequest) {
return listOperations(ListOperationsRequest.builder().applyMutation(listOperationsRequest).build());
}
/**
*
* Returns information about all of the operations that return an operation ID and that have ever been performed on
* domains that were registered by the current account.
*
*
* This command runs only in the us-east-1 Region.
*
*
* @return A Java Future containing the result of the ListOperations operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListOperations
* @see AWS
* API Documentation
*/
default CompletableFuture listOperations() {
return listOperations(ListOperationsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListOperationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)}
* operation.
*
*
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListOperations
* @see AWS
* API Documentation
*/
default ListOperationsPublisher listOperationsPaginator() {
return listOperationsPaginator(ListOperationsRequest.builder().build());
}
/**
*
* This is a variant of
* {@link #listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListOperationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)}
* operation.
*
*
* @param listOperationsRequest
* The ListOperations request includes the following elements.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListOperations
* @see AWS
* API Documentation
*/
default ListOperationsPublisher listOperationsPaginator(ListOperationsRequest listOperationsRequest) {
return new ListOperationsPublisher(this, listOperationsRequest);
}
/**
*
* This is a variant of
* {@link #listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)} operation.
* The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListOperationsPublisher publisher = client.listOperationsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListOperationsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listOperations(software.amazon.awssdk.services.route53domains.model.ListOperationsRequest)}
* operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListOperationsRequest.Builder} avoiding the need to
* create one manually via {@link ListOperationsRequest#builder()}
*
*
* @param listOperationsRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListOperationsRequest.Builder} to create a
* request. The ListOperations request includes the following elements.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListOperations
* @see AWS
* API Documentation
*/
default ListOperationsPublisher listOperationsPaginator(Consumer listOperationsRequest) {
return listOperationsPaginator(ListOperationsRequest.builder().applyMutation(listOperationsRequest).build());
}
/**
*
* Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
*
*
* -
*
* Registration
*
*
* -
*
* Transfer
*
*
* -
*
* Owner change
*
*
* -
*
* Domain renewal
*
*
* -
*
* Domain restoration
*
*
*
*
* @param listPricesRequest
* @return A Java Future containing the result of the ListPrices operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListPrices
* @see AWS API
* Documentation
*/
default CompletableFuture listPrices(ListPricesRequest listPricesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
*
*
* -
*
* Registration
*
*
* -
*
* Transfer
*
*
* -
*
* Owner change
*
*
* -
*
* Domain renewal
*
*
* -
*
* Domain restoration
*
*
*
*
*
* This is a convenience which creates an instance of the {@link ListPricesRequest.Builder} avoiding the need to
* create one manually via {@link ListPricesRequest#builder()}
*
*
* @param listPricesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListPricesRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the ListPrices operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListPrices
* @see AWS API
* Documentation
*/
default CompletableFuture listPrices(Consumer listPricesRequest) {
return listPrices(ListPricesRequest.builder().applyMutation(listPricesRequest).build());
}
/**
*
* This is a variant of {@link #listPrices(software.amazon.awssdk.services.route53domains.model.ListPricesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListPricesPublisher publisher = client.listPricesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListPricesPublisher publisher = client.listPricesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListPricesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPrices(software.amazon.awssdk.services.route53domains.model.ListPricesRequest)} operation.
*
*
* @param listPricesRequest
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListPrices
* @see AWS API
* Documentation
*/
default ListPricesPublisher listPricesPaginator(ListPricesRequest listPricesRequest) {
return new ListPricesPublisher(this, listPricesRequest);
}
/**
*
* This is a variant of {@link #listPrices(software.amazon.awssdk.services.route53domains.model.ListPricesRequest)}
* operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
* SDK will internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListPricesPublisher publisher = client.listPricesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ListPricesPublisher publisher = client.listPricesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ListPricesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #listPrices(software.amazon.awssdk.services.route53domains.model.ListPricesRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ListPricesRequest.Builder} avoiding the need to
* create one manually via {@link ListPricesRequest#builder()}
*
*
* @param listPricesRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListPricesRequest.Builder} to create a
* request.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListPrices
* @see AWS API
* Documentation
*/
default ListPricesPublisher listPricesPaginator(Consumer listPricesRequest) {
return listPricesPaginator(ListPricesRequest.builder().applyMutation(listPricesRequest).build());
}
/**
*
* 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.
*
*
* @param listTagsForDomainRequest
* The ListTagsForDomainRequest includes the following elements.
* @return A Java Future containing the result of the ListTagsForDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListTagsForDomain
* @see AWS API Documentation
*/
default CompletableFuture listTagsForDomain(ListTagsForDomainRequest listTagsForDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ListTagsForDomainRequest.Builder} avoiding the need
* to create one manually via {@link ListTagsForDomainRequest#builder()}
*
*
* @param listTagsForDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ListTagsForDomainRequest.Builder} to create a
* request. The ListTagsForDomainRequest includes the following elements.
* @return A Java Future containing the result of the ListTagsForDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ListTagsForDomain
* @see AWS API Documentation
*/
default CompletableFuture listTagsForDomain(
Consumer listTagsForDomainRequest) {
return listTagsForDomain(ListTagsForDomainRequest.builder().applyMutation(listTagsForDomainRequest).build());
}
/**
*
* Moves a domain from Amazon Web Services to another registrar.
*
*
* Supported actions:
*
*
* -
*
* Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be
* transferred to another registrar.
*
*
*
*
* @param pushDomainRequest
* @return A Java Future containing the result of the PushDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.PushDomain
* @see AWS API
* Documentation
*/
default CompletableFuture pushDomain(PushDomainRequest pushDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Moves a domain from Amazon Web Services to another registrar.
*
*
* Supported actions:
*
*
* -
*
* Changes the IPS tags of a .uk domain, and pushes it to transit. Transit means that the domain is ready to be
* transferred to another registrar.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PushDomainRequest.Builder} avoiding the need to
* create one manually via {@link PushDomainRequest#builder()}
*
*
* @param pushDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.PushDomainRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the PushDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.PushDomain
* @see AWS API
* Documentation
*/
default CompletableFuture pushDomain(Consumer pushDomainRequest) {
return pushDomain(PushDomainRequest.builder().applyMutation(pushDomainRequest).build());
}
/**
*
* This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters.
*
*
* When you register a domain, Amazon Route 53 does the following:
*
*
* -
*
* Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your
* hosted zone and automatically updates your domain registration with the names of these name servers.
*
*
* -
*
* Enables auto renew, 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 for the registrar or the phrase
* "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner." If you don't enable privacy protection,
* WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
*
*
*
* While some domains may allow different privacy settings per contact, we recommend specifying the same privacy
* setting for all 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 Amazon Web Services account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.
*
*
*
*
* @param registerDomainRequest
* The RegisterDomain request includes the following elements.
* @return A Java Future containing the result of the RegisterDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RegisterDomain
* @see AWS
* API Documentation
*/
default CompletableFuture registerDomain(RegisterDomainRequest registerDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation registers a domain. For some top-level domains (TLDs), this operation requires extra parameters.
*
*
* When you register a domain, Amazon Route 53 does the following:
*
*
* -
*
* Creates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers to your
* hosted zone and automatically updates your domain registration with the names of these name servers.
*
*
* -
*
* Enables auto renew, 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 for the registrar or the phrase
* "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner." If you don't enable privacy protection,
* WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
*
*
*
* While some domains may allow different privacy settings per contact, we recommend specifying the same privacy
* setting for all 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 Amazon Web Services 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 {@link RegisterDomainRequest.Builder} avoiding the need to
* create one manually via {@link RegisterDomainRequest#builder()}
*
*
* @param registerDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.RegisterDomainRequest.Builder} to create a
* request. The RegisterDomain request includes the following elements.
* @return A Java Future containing the result of the RegisterDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RegisterDomain
* @see AWS
* API Documentation
*/
default CompletableFuture registerDomain(Consumer registerDomainRequest) {
return registerDomain(RegisterDomainRequest.builder().applyMutation(registerDomainRequest).build());
}
/**
*
* Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services
* account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
* @param rejectDomainTransferFromAnotherAwsAccountRequest
* The RejectDomainTransferFromAnotherAwsAccount request includes the following element.
* @return A Java Future containing the result of the RejectDomainTransferFromAnotherAwsAccount operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RejectDomainTransferFromAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture rejectDomainTransferFromAnotherAwsAccount(
RejectDomainTransferFromAnotherAwsAccountRequest rejectDomainTransferFromAnotherAwsAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services
* account. You initiate a transfer betweenAmazon Web Services accounts using TransferDomainToAnotherAwsAccount.
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
*
* This is a convenience which creates an instance of the
* {@link RejectDomainTransferFromAnotherAwsAccountRequest.Builder} avoiding the need to create one manually via
* {@link RejectDomainTransferFromAnotherAwsAccountRequest#builder()}
*
*
* @param rejectDomainTransferFromAnotherAwsAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.RejectDomainTransferFromAnotherAwsAccountRequest.Builder}
* to create a request. The RejectDomainTransferFromAnotherAwsAccount request includes the following element.
* @return A Java Future containing the result of the RejectDomainTransferFromAnotherAwsAccount operation returned
* by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RejectDomainTransferFromAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture rejectDomainTransferFromAnotherAwsAccount(
Consumer rejectDomainTransferFromAnotherAwsAccountRequest) {
return rejectDomainTransferFromAnotherAwsAccount(RejectDomainTransferFromAnotherAwsAccountRequest.builder()
.applyMutation(rejectDomainTransferFromAnotherAwsAccountRequest).build());
}
/**
*
* This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to
* your Amazon Web Services 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.
*
*
* @param renewDomainRequest
* A RenewDomain
request includes the number of years that you want to renew for and the current
* expiration year.
* @return A Java Future containing the result of the RenewDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RenewDomain
* @see AWS
* API Documentation
*/
default CompletableFuture renewDomain(RenewDomainRequest renewDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to
* your Amazon Web Services 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 {@link RenewDomainRequest.Builder} avoiding the need to
* create one manually via {@link RenewDomainRequest#builder()}
*
*
* @param renewDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.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.
* @return A Java Future containing the result of the RenewDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RenewDomain
* @see AWS
* API Documentation
*/
default CompletableFuture renewDomain(Consumer renewDomainRequest) {
return renewDomain(RenewDomainRequest.builder().applyMutation(renewDomainRequest).build());
}
/**
*
* For operations that require confirmation that the email address for the registrant contact is valid, such as
* registering a new domain, this operation resends the confirmation email to the current email address for the
* registrant contact.
*
*
* @param resendContactReachabilityEmailRequest
* @return A Java Future containing the result of the ResendContactReachabilityEmail operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ResendContactReachabilityEmail
* @see AWS API Documentation
*/
default CompletableFuture resendContactReachabilityEmail(
ResendContactReachabilityEmailRequest resendContactReachabilityEmailRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link ResendContactReachabilityEmailRequest.Builder}
* avoiding the need to create one manually via {@link ResendContactReachabilityEmailRequest#builder()}
*
*
* @param resendContactReachabilityEmailRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ResendContactReachabilityEmailRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the ResendContactReachabilityEmail operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ResendContactReachabilityEmail
* @see AWS API Documentation
*/
default CompletableFuture resendContactReachabilityEmail(
Consumer resendContactReachabilityEmailRequest) {
return resendContactReachabilityEmail(ResendContactReachabilityEmailRequest.builder()
.applyMutation(resendContactReachabilityEmailRequest).build());
}
/**
*
* 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.
*
*
* @return A Java Future containing the result of the ResendContactReachabilityEmail operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ResendContactReachabilityEmail
* @see AWS API Documentation
*/
default CompletableFuture resendContactReachabilityEmail() {
return resendContactReachabilityEmail(ResendContactReachabilityEmailRequest.builder().build());
}
/**
*
* Resend the form of authorization email for this operation.
*
*
* @param resendOperationAuthorizationRequest
* @return A Java Future containing the result of the ResendOperationAuthorization operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ResendOperationAuthorization
* @see AWS API Documentation
*/
default CompletableFuture resendOperationAuthorization(
ResendOperationAuthorizationRequest resendOperationAuthorizationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Resend the form of authorization email for this operation.
*
*
*
* This is a convenience which creates an instance of the {@link ResendOperationAuthorizationRequest.Builder}
* avoiding the need to create one manually via {@link ResendOperationAuthorizationRequest#builder()}
*
*
* @param resendOperationAuthorizationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ResendOperationAuthorizationRequest.Builder}
* to create a request.
* @return A Java Future containing the result of the ResendOperationAuthorization operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ResendOperationAuthorization
* @see AWS API Documentation
*/
default CompletableFuture resendOperationAuthorization(
Consumer resendOperationAuthorizationRequest) {
return resendOperationAuthorization(ResendOperationAuthorizationRequest.builder()
.applyMutation(resendOperationAuthorizationRequest).build());
}
/**
*
* This operation returns the authorization code for the domain. To transfer a domain to another registrar, you
* provide this value to the new registrar.
*
*
* @param 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.
* @return A Java Future containing the result of the RetrieveDomainAuthCode operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RetrieveDomainAuthCode
* @see AWS API Documentation
*/
default CompletableFuture retrieveDomainAuthCode(
RetrieveDomainAuthCodeRequest retrieveDomainAuthCodeRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation returns the authorization code 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 {@link RetrieveDomainAuthCodeRequest.Builder} avoiding the
* need to create one manually via {@link RetrieveDomainAuthCodeRequest#builder()}
*
*
* @param retrieveDomainAuthCodeRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.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.
* @return A Java Future containing the result of the RetrieveDomainAuthCode operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.RetrieveDomainAuthCode
* @see AWS API Documentation
*/
default CompletableFuture retrieveDomainAuthCode(
Consumer retrieveDomainAuthCodeRequest) {
return retrieveDomainAuthCode(RetrieveDomainAuthCodeRequest.builder().applyMutation(retrieveDomainAuthCodeRequest)
.build());
}
/**
*
* Transfers a domain from another registrar to Amazon Route 53.
*
*
* For more information about transferring domains, see the following topics:
*
*
* -
*
* For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're
* transferring to Route 53, see Transferring
* Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
*
*
* -
*
* For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
*
*
* -
*
* For information about how to transfer a domain to another domain registrar, see Transferring
* a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
*
*
*
*
*
* During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates
* to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner
* contact after the transfer is complete. For more information, see UpdateDomainContact.
*
*
*
* If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you
* transfer your DNS service to 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.
*
*
* @param transferDomainRequest
* The TransferDomain request includes the following elements.
* @return A Java Future containing the result of the TransferDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.TransferDomain
* @see AWS
* API Documentation
*/
default CompletableFuture transferDomain(TransferDomainRequest transferDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Transfers a domain from another registrar to Amazon Route 53.
*
*
* For more information about transferring domains, see the following topics:
*
*
* -
*
* For transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're
* transferring to Route 53, see Transferring
* Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
*
*
* -
*
* For information about how to transfer a domain from one Amazon Web Services account to another, see TransferDomainToAnotherAwsAccount.
*
*
* -
*
* For information about how to transfer a domain to another domain registrar, see Transferring
* a Domain from Amazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
*
*
*
*
*
* During the transfer of any country code top-level domains (ccTLDs) to Route 53, except for .cc and .tv, updates
* to the owner contact are ignored and the owner contact data from the registry is used. You can update the owner
* contact after the transfer is complete. For more information, see UpdateDomainContact.
*
*
*
* If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you
* transfer your DNS service to 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 {@link TransferDomainRequest.Builder} avoiding the need to
* create one manually via {@link TransferDomainRequest#builder()}
*
*
* @param transferDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.TransferDomainRequest.Builder} to create a
* request. The TransferDomain request includes the following elements.
* @return A Java Future containing the result of the TransferDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.TransferDomain
* @see AWS
* API Documentation
*/
default CompletableFuture transferDomain(Consumer transferDomainRequest) {
return transferDomain(TransferDomainRequest.builder().applyMutation(transferDomainRequest).build());
}
/**
*
* Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the
* following:
*
*
* -
*
* The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other
* account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
*
*
* -
*
* You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
*
*
* -
*
* The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.
*
*
*
*
*
* When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted
* zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are
* owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the
* hosted zone to another Amazon Web Services account, see Migrating a Hosted
* Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide.
*
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
* @param transferDomainToAnotherAwsAccountRequest
* The TransferDomainToAnotherAwsAccount request includes the following elements.
* @return A Java Future containing the result of the TransferDomainToAnotherAwsAccount operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - DuplicateRequestException The request is already in progress for the domain.
* - 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.
*
* @sample Route53DomainsAsyncClient.TransferDomainToAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture transferDomainToAnotherAwsAccount(
TransferDomainToAnotherAwsAccountRequest transferDomainToAnotherAwsAccountRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the
* following:
*
*
* -
*
* The Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other
* account doesn't accept the transfer within 3 days, we cancel the transfer. See AcceptDomainTransferFromAnotherAwsAccount.
*
*
* -
*
* You can cancel the transfer before the other account accepts it. See CancelDomainTransferToAnotherAwsAccount.
*
*
* -
*
* The other account can reject the transfer. See RejectDomainTransferFromAnotherAwsAccount.
*
*
*
*
*
* When you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted
* zone that is associated with the domain. DNS resolution isn't affected if the domain and the hosted zone are
* owned by separate accounts, so transferring the hosted zone is optional. For information about transferring the
* hosted zone to another Amazon Web Services account, see Migrating a Hosted
* Zone to a Different Amazon Web Services Account in the Amazon Route 53 Developer Guide.
*
*
*
* Use either ListOperations
* or
* GetOperationDetail to determine whether the operation succeeded. GetOperationDetail provides additional information, for example,
* Domain Transfer from Aws Account 111122223333 has been cancelled
.
*
*
*
* This is a convenience which creates an instance of the {@link TransferDomainToAnotherAwsAccountRequest.Builder}
* avoiding the need to create one manually via {@link TransferDomainToAnotherAwsAccountRequest#builder()}
*
*
* @param transferDomainToAnotherAwsAccountRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.TransferDomainToAnotherAwsAccountRequest.Builder}
* to create a request. The TransferDomainToAnotherAwsAccount request includes the following elements.
* @return A Java Future containing the result of the TransferDomainToAnotherAwsAccount operation returned by the
* service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - OperationLimitExceededException The number of operations or jobs running exceeded the allowed
* threshold for the account.
* - DuplicateRequestException The request is already in progress for the domain.
* - 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.
*
* @sample Route53DomainsAsyncClient.TransferDomainToAnotherAwsAccount
* @see AWS API Documentation
*/
default CompletableFuture transferDomainToAnotherAwsAccount(
Consumer transferDomainToAnotherAwsAccountRequest) {
return transferDomainToAnotherAwsAccount(TransferDomainToAnotherAwsAccountRequest.builder()
.applyMutation(transferDomainToAnotherAwsAccountRequest).build());
}
/**
*
* 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 operation. If the request is not completed successfully, the domain registrant will be notified
* by email.
*
*
* @param updateDomainContactRequest
* The UpdateDomainContact request includes the following elements.
* @return A Java Future containing the result of the UpdateDomainContact operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.UpdateDomainContact
* @see AWS API Documentation
*/
default CompletableFuture updateDomainContact(
UpdateDomainContactRequest updateDomainContactRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 operation. 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 {@link UpdateDomainContactRequest.Builder} avoiding the
* need to create one manually via {@link UpdateDomainContactRequest#builder()}
*
*
* @param updateDomainContactRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.UpdateDomainContactRequest.Builder} to create
* a request. The UpdateDomainContact request includes the following elements.
* @return A Java Future containing the result of the UpdateDomainContact operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.UpdateDomainContact
* @see AWS API Documentation
*/
default CompletableFuture updateDomainContact(
Consumer updateDomainContactRequest) {
return updateDomainContact(UpdateDomainContactRequest.builder().applyMutation(updateDomainContactRequest).build());
}
/**
*
* This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your
* contact information is replaced with contact information for the registrar or with the phrase
* "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner."
*
*
*
* While some domains may allow different privacy settings per contact, we recommend specifying the same privacy
* setting for all contacts.
*
*
*
* This operation affects only the contact information for the specified contact type (administrative, registrant,
* or technical). 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.
*
*
*
* By disabling the privacy service via API, you consent to the publication of the contact information provided for
* this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have
* the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection
* using either UpdateDomainContactPrivacy
or the Route 53 console. Enabling privacy protection removes
* the contact information provided for this domain from the WHOIS database. For more information on our privacy
* practices, see https://aws.amazon.com/privacy/.
*
*
*
* @param updateDomainContactPrivacyRequest
* The UpdateDomainContactPrivacy request includes the following elements.
* @return A Java Future containing the result of the UpdateDomainContactPrivacy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.UpdateDomainContactPrivacy
* @see AWS API Documentation
*/
default CompletableFuture updateDomainContactPrivacy(
UpdateDomainContactPrivacyRequest updateDomainContactPrivacyRequest) {
throw new UnsupportedOperationException();
}
/**
*
* This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, your
* contact information is replaced with contact information for the registrar or with the phrase
* "REDACTED FOR PRIVACY", or "On behalf of <domain name> owner."
*
*
*
* While some domains may allow different privacy settings per contact, we recommend specifying the same privacy
* setting for all contacts.
*
*
*
* This operation affects only the contact information for the specified contact type (administrative, registrant,
* or technical). 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.
*
*
*
* By disabling the privacy service via API, you consent to the publication of the contact information provided for
* this domain via the public WHOIS database. You certify that you are the registrant of this domain name and have
* the authority to make this decision. You may withdraw your consent at any time by enabling privacy protection
* using either UpdateDomainContactPrivacy
or the Route 53 console. Enabling privacy protection removes
* the contact information provided for this domain from the WHOIS database. For more information on our privacy
* practices, see https://aws.amazon.com/privacy/.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateDomainContactPrivacyRequest.Builder} avoiding
* the need to create one manually via {@link UpdateDomainContactPrivacyRequest#builder()}
*
*
* @param updateDomainContactPrivacyRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.UpdateDomainContactPrivacyRequest.Builder} to
* create a request. The UpdateDomainContactPrivacy request includes the following elements.
* @return A Java Future containing the result of the UpdateDomainContactPrivacy operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.UpdateDomainContactPrivacy
* @see AWS API Documentation
*/
default CompletableFuture updateDomainContactPrivacy(
Consumer updateDomainContactPrivacyRequest) {
return updateDomainContactPrivacy(UpdateDomainContactPrivacyRequest.builder()
.applyMutation(updateDomainContactPrivacyRequest).build());
}
/**
*
* This operation replaces the current set of name servers for the domain with the specified set of name servers. If
* you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted
* zone for the domain.
*
*
* If successful, this operation returns an operation ID that you can use to track the progress and completion of
* the action. If the request is not completed successfully, the domain registrant will be notified by email.
*
*
* @param updateDomainNameserversRequest
* 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.
* @return A Java Future containing the result of the UpdateDomainNameservers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
*
* @sample Route53DomainsAsyncClient.UpdateDomainNameservers
* @see AWS API Documentation
*/
default CompletableFuture updateDomainNameservers(
UpdateDomainNameserversRequest updateDomainNameserversRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateDomainNameserversRequest.Builder} avoiding
* the need to create one manually via {@link UpdateDomainNameserversRequest#builder()}
*
*
* @param updateDomainNameserversRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.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.
* @return A Java Future containing the result of the UpdateDomainNameservers operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
*
* @sample Route53DomainsAsyncClient.UpdateDomainNameservers
* @see AWS API Documentation
*/
default CompletableFuture updateDomainNameservers(
Consumer updateDomainNameserversRequest) {
return updateDomainNameservers(UpdateDomainNameserversRequest.builder().applyMutation(updateDomainNameserversRequest)
.build());
}
/**
*
* 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.
*
*
* @param updateTagsForDomainRequest
* The UpdateTagsForDomainRequest includes the following elements.
* @return A Java Future containing the result of the UpdateTagsForDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.UpdateTagsForDomain
* @see AWS API Documentation
*/
default CompletableFuture updateTagsForDomain(
UpdateTagsForDomainRequest updateTagsForDomainRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link UpdateTagsForDomainRequest.Builder} avoiding the
* need to create one manually via {@link UpdateTagsForDomainRequest#builder()}
*
*
* @param updateTagsForDomainRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.UpdateTagsForDomainRequest.Builder} to create
* a request. The UpdateTagsForDomainRequest includes the following elements.
* @return A Java Future containing the result of the UpdateTagsForDomain operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.UpdateTagsForDomain
* @see AWS API Documentation
*/
default CompletableFuture updateTagsForDomain(
Consumer updateTagsForDomainRequest) {
return updateTagsForDomain(UpdateTagsForDomainRequest.builder().applyMutation(updateTagsForDomainRequest).build());
}
/**
*
* Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
*
*
* @param viewBillingRequest
* The ViewBilling request includes the following elements.
* @return A Java Future containing the result of the ViewBilling operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ViewBilling
* @see AWS
* API Documentation
*/
default CompletableFuture viewBilling(ViewBillingRequest viewBillingRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
*
*
*
* This is a convenience which creates an instance of the {@link ViewBillingRequest.Builder} avoiding the need to
* create one manually via {@link ViewBillingRequest#builder()}
*
*
* @param viewBillingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ViewBillingRequest.Builder} to create a
* request. The ViewBilling request includes the following elements.
* @return A Java Future containing the result of the ViewBilling operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ViewBilling
* @see AWS
* API Documentation
*/
default CompletableFuture viewBilling(Consumer viewBillingRequest) {
return viewBilling(ViewBillingRequest.builder().applyMutation(viewBillingRequest).build());
}
/**
*
* This is a variant of
* {@link #viewBilling(software.amazon.awssdk.services.route53domains.model.ViewBillingRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ViewBillingPublisher publisher = client.viewBillingPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ViewBillingPublisher publisher = client.viewBillingPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ViewBillingResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #viewBilling(software.amazon.awssdk.services.route53domains.model.ViewBillingRequest)} operation.
*
*
* @param viewBillingRequest
* The ViewBilling request includes the following elements.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ViewBilling
* @see AWS
* API Documentation
*/
default ViewBillingPublisher viewBillingPaginator(ViewBillingRequest viewBillingRequest) {
return new ViewBillingPublisher(this, viewBillingRequest);
}
/**
*
* This is a variant of
* {@link #viewBilling(software.amazon.awssdk.services.route53domains.model.ViewBillingRequest)} operation. The
* return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
* internally handle making service calls for you.
*
*
* When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
* and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
* failures only after you start streaming the data. The subscribe method should be called as a request to start
* streaming data. For more info, see
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ViewBillingPublisher publisher = client.viewBillingPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.route53domains.paginators.ViewBillingPublisher publisher = client.viewBillingPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.route53domains.model.ViewBillingResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator.
* It only limits the number of results in each page.
*
*
* Note: If you prefer to have control on service calls, use the
* {@link #viewBilling(software.amazon.awssdk.services.route53domains.model.ViewBillingRequest)} operation.
*
*
*
* This is a convenience which creates an instance of the {@link ViewBillingRequest.Builder} avoiding the need to
* create one manually via {@link ViewBillingRequest#builder()}
*
*
* @param viewBillingRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.ViewBillingRequest.Builder} to create a
* request. The ViewBilling request includes the following elements.
* @return A custom publisher that can be subscribed to request a stream of response pages.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidInputException The requested item is not acceptable. For example, for APIs that accept a
* domain name, the request might specify a domain name that doesn't belong to the account that submitted
* the request. For
AcceptDomainTransferFromAnotherAwsAccount
, the password might be invalid.
* - 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.
*
* @sample Route53DomainsAsyncClient.ViewBilling
* @see AWS
* API Documentation
*/
default ViewBillingPublisher viewBillingPaginator(Consumer viewBillingRequest) {
return viewBillingPaginator(ViewBillingRequest.builder().applyMutation(viewBillingRequest).build());
}
@Override
default Route53DomainsServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link Route53DomainsAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static Route53DomainsAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link Route53DomainsAsyncClient}.
*/
static Route53DomainsAsyncClientBuilder builder() {
return new DefaultRoute53DomainsAsyncClientBuilder();
}
}