Interface TaxSettingsAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any 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.
You can use the tax setting API to programmatically set, modify, and delete the tax registration number (TRN), associated business legal name, and address (Collectively referred to as "TRN information"). You can also programmatically view TRN information and tax addresses ("Tax profiles").
You can use this API to automate your TRN information settings instead of manually using the console.
Service Endpoint
-
https://tax.us-east-1.amazonaws.com
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbatchDeleteTaxRegistration(Consumer<BatchDeleteTaxRegistrationRequest.Builder> batchDeleteTaxRegistrationRequest) Deletes tax registration for multiple accounts in batch.batchDeleteTaxRegistration(BatchDeleteTaxRegistrationRequest batchDeleteTaxRegistrationRequest) Deletes tax registration for multiple accounts in batch.batchPutTaxRegistration(Consumer<BatchPutTaxRegistrationRequest.Builder> batchPutTaxRegistrationRequest) Adds or updates tax registration for multiple accounts in batch.batchPutTaxRegistration(BatchPutTaxRegistrationRequest batchPutTaxRegistrationRequest) Adds or updates tax registration for multiple accounts in batch.builder()Create a builder that can be used to configure and create aTaxSettingsAsyncClient.static TaxSettingsAsyncClientcreate()Create aTaxSettingsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.deleteTaxRegistration(Consumer<DeleteTaxRegistrationRequest.Builder> deleteTaxRegistrationRequest) Deletes tax registration for a single account.deleteTaxRegistration(DeleteTaxRegistrationRequest deleteTaxRegistrationRequest) Deletes tax registration for a single account.getTaxRegistration(Consumer<GetTaxRegistrationRequest.Builder> getTaxRegistrationRequest) Retrieves tax registration for a single account.getTaxRegistration(GetTaxRegistrationRequest getTaxRegistrationRequest) Retrieves tax registration for a single account.getTaxRegistrationDocument(Consumer<GetTaxRegistrationDocumentRequest.Builder> getTaxRegistrationDocumentRequest) Downloads your tax documents to the Amazon S3 bucket that you specify in your request.getTaxRegistrationDocument(GetTaxRegistrationDocumentRequest getTaxRegistrationDocumentRequest) Downloads your tax documents to the Amazon S3 bucket that you specify in your request.listTaxRegistrations(Consumer<ListTaxRegistrationsRequest.Builder> listTaxRegistrationsRequest) Retrieves the tax registration of accounts listed in a consolidated billing family.listTaxRegistrations(ListTaxRegistrationsRequest listTaxRegistrationsRequest) Retrieves the tax registration of accounts listed in a consolidated billing family.default ListTaxRegistrationsPublisherlistTaxRegistrationsPaginator(Consumer<ListTaxRegistrationsRequest.Builder> listTaxRegistrationsRequest) This is a variant oflistTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)operation.default ListTaxRegistrationsPublisherlistTaxRegistrationsPaginator(ListTaxRegistrationsRequest listTaxRegistrationsRequest) This is a variant oflistTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)operation.putTaxRegistration(Consumer<PutTaxRegistrationRequest.Builder> putTaxRegistrationRequest) Adds or updates tax registration for a single account.putTaxRegistration(PutTaxRegistrationRequest putTaxRegistrationRequest) Adds or updates tax registration for a single account.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
batchDeleteTaxRegistration
default CompletableFuture<BatchDeleteTaxRegistrationResponse> batchDeleteTaxRegistration(BatchDeleteTaxRegistrationRequest batchDeleteTaxRegistrationRequest) Deletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch.
This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.
- Parameters:
batchDeleteTaxRegistrationRequest-- Returns:
- A Java Future containing the result of the BatchDeleteTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchDeleteTaxRegistration
default CompletableFuture<BatchDeleteTaxRegistrationResponse> batchDeleteTaxRegistration(Consumer<BatchDeleteTaxRegistrationRequest.Builder> batchDeleteTaxRegistrationRequest) Deletes tax registration for multiple accounts in batch. This can be used to delete tax registrations for up to five accounts in one batch.
This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.
This is a convenience which creates an instance of the
BatchDeleteTaxRegistrationRequest.Builderavoiding the need to create one manually viaBatchDeleteTaxRegistrationRequest.builder()- Parameters:
batchDeleteTaxRegistrationRequest- AConsumerthat will call methods onBatchDeleteTaxRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchDeleteTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchPutTaxRegistration
default CompletableFuture<BatchPutTaxRegistrationResponse> batchPutTaxRegistration(BatchPutTaxRegistrationRequest batchPutTaxRegistrationRequest) Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.
To call this API operation for specific countries, see the following country-specific requirements.
Bangladesh
-
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject.
Brazil
-
You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.
-
For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.
Georgia
-
The valid
personTypevalues arePhysical PersonandBusiness.
Kenya
-
You must specify the
personTypein thekenyaAdditionalInfofield of theadditionalTaxInformationobject. -
If the
personTypeisPhysical Person, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Malaysia
-
If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.
-
By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.
-
Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.
-
If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.
-
Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.
-
Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.
Taxable service and service tax codes:
Consultancy - 9907061674
Training or coaching service - 9907071685
IT service - 9907101676
Digital services and electronic medium - 9907121690
Nepal
-
The sector valid values are
BusinessandIndividual.
Saudi Arabia
-
For
address, you must specifyaddressLine3.
South Korea
-
You must specify the
certifiedEmailIdandlegalNamein theTaxRegistrationEntryobject. Use Korean characters forlegalName. -
You must specify the
businessRepresentativeName,itemOfBusiness, andlineOfBusinessin thesouthKoreaAdditionalInfofield of theadditionalTaxInformationobject. Use Korean characters for these fields. -
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject. -
For the
addressobject, use Korean characters foraddressLine1,addressLine2city,postalCode, andstateOrRegion.
Spain
-
You must specify the
registrationTypein thespainAdditionalInfofield of theadditionalTaxInformationobject. -
If the
registrationTypeisLocal, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Turkey
-
You must specify the
sectorin thetaxRegistrationEntryobject. -
If your
sectorisBusiness,Individual, orGovernment:-
Specify the
taxOffice. If yoursectorisIndividual, don't enter this value. -
(Optional) Specify the
kepEmailId. If yoursectorisIndividual, don't enter this value. -
Note: In the Tax Settings page of the Billing console,
Governmentappears as Public institutions
-
-
If your
sectorisBusinessand you're subject to KDV tax, you must specify your industry in theindustriesfield. -
For
address, you must specifydistrictOrCounty.
Ukraine
-
The sector valid values are
BusinessandIndividual.
- Parameters:
batchPutTaxRegistrationRequest-- Returns:
- A Java Future containing the result of the BatchPutTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
batchPutTaxRegistration
default CompletableFuture<BatchPutTaxRegistrationResponse> batchPutTaxRegistration(Consumer<BatchPutTaxRegistrationRequest.Builder> batchPutTaxRegistrationRequest) Adds or updates tax registration for multiple accounts in batch. This can be used to add or update tax registrations for up to five accounts in one batch. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.
To call this API operation for specific countries, see the following country-specific requirements.
Bangladesh
-
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject.
Brazil
-
You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.
-
For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.
Georgia
-
The valid
personTypevalues arePhysical PersonandBusiness.
Kenya
-
You must specify the
personTypein thekenyaAdditionalInfofield of theadditionalTaxInformationobject. -
If the
personTypeisPhysical Person, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Malaysia
-
If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.
-
By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.
-
Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.
-
If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.
-
Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.
-
Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.
Taxable service and service tax codes:
Consultancy - 9907061674
Training or coaching service - 9907071685
IT service - 9907101676
Digital services and electronic medium - 9907121690
Nepal
-
The sector valid values are
BusinessandIndividual.
Saudi Arabia
-
For
address, you must specifyaddressLine3.
South Korea
-
You must specify the
certifiedEmailIdandlegalNamein theTaxRegistrationEntryobject. Use Korean characters forlegalName. -
You must specify the
businessRepresentativeName,itemOfBusiness, andlineOfBusinessin thesouthKoreaAdditionalInfofield of theadditionalTaxInformationobject. Use Korean characters for these fields. -
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject. -
For the
addressobject, use Korean characters foraddressLine1,addressLine2city,postalCode, andstateOrRegion.
Spain
-
You must specify the
registrationTypein thespainAdditionalInfofield of theadditionalTaxInformationobject. -
If the
registrationTypeisLocal, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Turkey
-
You must specify the
sectorin thetaxRegistrationEntryobject. -
If your
sectorisBusiness,Individual, orGovernment:-
Specify the
taxOffice. If yoursectorisIndividual, don't enter this value. -
(Optional) Specify the
kepEmailId. If yoursectorisIndividual, don't enter this value. -
Note: In the Tax Settings page of the Billing console,
Governmentappears as Public institutions
-
-
If your
sectorisBusinessand you're subject to KDV tax, you must specify your industry in theindustriesfield. -
For
address, you must specifydistrictOrCounty.
Ukraine
-
The sector valid values are
BusinessandIndividual.
This is a convenience which creates an instance of the
BatchPutTaxRegistrationRequest.Builderavoiding the need to create one manually viaBatchPutTaxRegistrationRequest.builder()- Parameters:
batchPutTaxRegistrationRequest- AConsumerthat will call methods onBatchPutTaxRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the BatchPutTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deleteTaxRegistration
default CompletableFuture<DeleteTaxRegistrationResponse> deleteTaxRegistration(DeleteTaxRegistrationRequest deleteTaxRegistrationRequest) Deletes tax registration for a single account.
This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.
- Parameters:
deleteTaxRegistrationRequest-- Returns:
- A Java Future containing the result of the DeleteTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteTaxRegistration
default CompletableFuture<DeleteTaxRegistrationResponse> deleteTaxRegistration(Consumer<DeleteTaxRegistrationRequest.Builder> deleteTaxRegistrationRequest) Deletes tax registration for a single account.
This API operation can't be used to delete your tax registration in Brazil. Use the Payment preferences page in the Billing and Cost Management console instead.
This is a convenience which creates an instance of the
DeleteTaxRegistrationRequest.Builderavoiding the need to create one manually viaDeleteTaxRegistrationRequest.builder()- Parameters:
deleteTaxRegistrationRequest- AConsumerthat will call methods onDeleteTaxRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTaxRegistration
default CompletableFuture<GetTaxRegistrationResponse> getTaxRegistration(GetTaxRegistrationRequest getTaxRegistrationRequest) Retrieves tax registration for a single account.
- Parameters:
getTaxRegistrationRequest-- Returns:
- A Java Future containing the result of the GetTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTaxRegistration
default CompletableFuture<GetTaxRegistrationResponse> getTaxRegistration(Consumer<GetTaxRegistrationRequest.Builder> getTaxRegistrationRequest) Retrieves tax registration for a single account.
This is a convenience which creates an instance of the
GetTaxRegistrationRequest.Builderavoiding the need to create one manually viaGetTaxRegistrationRequest.builder()- Parameters:
getTaxRegistrationRequest- AConsumerthat will call methods onGetTaxRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTaxRegistrationDocument
default CompletableFuture<GetTaxRegistrationDocumentResponse> getTaxRegistrationDocument(GetTaxRegistrationDocumentRequest getTaxRegistrationDocumentRequest) Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
- Parameters:
getTaxRegistrationDocumentRequest-- Returns:
- A Java Future containing the result of the GetTaxRegistrationDocument 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTaxRegistrationDocument
default CompletableFuture<GetTaxRegistrationDocumentResponse> getTaxRegistrationDocument(Consumer<GetTaxRegistrationDocumentRequest.Builder> getTaxRegistrationDocumentRequest) Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
This is a convenience which creates an instance of the
GetTaxRegistrationDocumentRequest.Builderavoiding the need to create one manually viaGetTaxRegistrationDocumentRequest.builder()- Parameters:
getTaxRegistrationDocumentRequest- AConsumerthat will call methods onGetTaxRegistrationDocumentRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetTaxRegistrationDocument 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTaxRegistrations
default CompletableFuture<ListTaxRegistrationsResponse> listTaxRegistrations(ListTaxRegistrationsRequest listTaxRegistrationsRequest) Retrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).
- Parameters:
listTaxRegistrationsRequest-- Returns:
- A Java Future containing the result of the ListTaxRegistrations 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTaxRegistrations
default CompletableFuture<ListTaxRegistrationsResponse> listTaxRegistrations(Consumer<ListTaxRegistrationsRequest.Builder> listTaxRegistrationsRequest) Retrieves the tax registration of accounts listed in a consolidated billing family. This can be used to retrieve up to 100 accounts' tax registrations in one call (default 50).
This is a convenience which creates an instance of the
ListTaxRegistrationsRequest.Builderavoiding the need to create one manually viaListTaxRegistrationsRequest.builder()- Parameters:
listTaxRegistrationsRequest- AConsumerthat will call methods onListTaxRegistrationsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTaxRegistrations 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTaxRegistrationsPaginator
default ListTaxRegistrationsPublisher listTaxRegistrationsPaginator(ListTaxRegistrationsRequest listTaxRegistrationsRequest) This is a variant of
listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsPublisher publisher = client.listTaxRegistrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsPublisher publisher = client.listTaxRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse response) { //... }; });Please notice that the configuration of maxResults 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
listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)operation.- Parameters:
listTaxRegistrationsRequest-- Returns:
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTaxRegistrationsPaginator
default ListTaxRegistrationsPublisher listTaxRegistrationsPaginator(Consumer<ListTaxRegistrationsRequest.Builder> listTaxRegistrationsRequest) This is a variant of
listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)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
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsPublisher publisher = client.listTaxRegistrationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsPublisher publisher = client.listTaxRegistrationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse response) { //... }; });Please notice that the configuration of maxResults 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
listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)operation.
This is a convenience which creates an instance of the
ListTaxRegistrationsRequest.Builderavoiding the need to create one manually viaListTaxRegistrationsRequest.builder()- Parameters:
listTaxRegistrationsRequest- AConsumerthat will call methods onListTaxRegistrationsRequest.Builderto create a request.- Returns:
- 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ResourceNotFoundException The exception thrown when the input doesn't have a resource associated to it.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putTaxRegistration
default CompletableFuture<PutTaxRegistrationResponse> putTaxRegistration(PutTaxRegistrationRequest putTaxRegistrationRequest) Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.
To call this API operation for specific countries, see the following country-specific requirements.
Bangladesh
-
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject.
Brazil
-
You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.
-
For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.
Georgia
-
The valid
personTypevalues arePhysical PersonandBusiness.
Kenya
-
You must specify the
personTypein thekenyaAdditionalInfofield of theadditionalTaxInformationobject. -
If the
personTypeisPhysical Person, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Malaysia
-
If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.
-
By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.
-
Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.
-
If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.
-
Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.
-
Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.
Taxable service and service tax codes:
Consultancy - 9907061674
Training or coaching service - 9907071685
IT service - 9907101676
Digital services and electronic medium - 9907121690
Nepal
-
The sector valid values are
BusinessandIndividual.
Saudi Arabia
-
For
address, you must specifyaddressLine3.
South Korea
-
You must specify the
certifiedEmailIdandlegalNamein theTaxRegistrationEntryobject. Use Korean characters forlegalName. -
You must specify the
businessRepresentativeName,itemOfBusiness, andlineOfBusinessin thesouthKoreaAdditionalInfofield of theadditionalTaxInformationobject. Use Korean characters for these fields. -
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject. -
For the
addressobject, use Korean characters foraddressLine1,addressLine2city,postalCode, andstateOrRegion.
Spain
-
You must specify the
registrationTypein thespainAdditionalInfofield of theadditionalTaxInformationobject. -
If the
registrationTypeisLocal, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Turkey
-
You must specify the
sectorin thetaxRegistrationEntryobject. -
If your
sectorisBusiness,Individual, orGovernment:-
Specify the
taxOffice. If yoursectorisIndividual, don't enter this value. -
(Optional) Specify the
kepEmailId. If yoursectorisIndividual, don't enter this value. -
Note: In the Tax Settings page of the Billing console,
Governmentappears as Public institutions
-
-
If your
sectorisBusinessand you're subject to KDV tax, you must specify your industry in theindustriesfield. -
For
address, you must specifydistrictOrCounty.
Ukraine
-
The sector valid values are
BusinessandIndividual.
- Parameters:
putTaxRegistrationRequest-- Returns:
- A Java Future containing the result of the PutTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putTaxRegistration
default CompletableFuture<PutTaxRegistrationResponse> putTaxRegistration(Consumer<PutTaxRegistrationRequest.Builder> putTaxRegistrationRequest) Adds or updates tax registration for a single account. You can't set a TRN if there's a pending TRN. You'll need to delete the pending TRN first.
To call this API operation for specific countries, see the following country-specific requirements.
Bangladesh
-
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject.
Brazil
-
You must complete the tax registration process in the Payment preferences page in the Billing and Cost Management console. After your TRN and billing address are verified, you can call this API operation.
-
For Amazon Web Services accounts created through Organizations, you can call this API operation when you don't have a billing address.
Georgia
-
The valid
personTypevalues arePhysical PersonandBusiness.
Kenya
-
You must specify the
personTypein thekenyaAdditionalInfofield of theadditionalTaxInformationobject. -
If the
personTypeisPhysical Person, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Malaysia
-
If you use this operation to set a tax registration number (TRN) in Malaysia, only resellers with a valid sales and service tax (SST) number are required to provide tax registration information.
-
By using this API operation to set a TRN in Malaysia, Amazon Web Services will regard you as self-declaring that you're an authorized business reseller registered with the Royal Malaysia Customs Department (RMCD) and have a valid SST number.
-
Amazon Web Services reserves the right to seek additional information and/or take other actions to support your self-declaration as appropriate.
-
If you're not a reseller of Amazon Web Services, we don't recommend that you use this operation to set the TRN in Malaysia.
-
Only use this API operation to upload the TRNs for accounts through which you're reselling Amazon Web Services.
-
Amazon Web Services is currently registered under the following service tax codes. You must include at least one of the service tax codes in the service tax code strings to declare yourself as an authorized registered business reseller.
Taxable service and service tax codes:
Consultancy - 9907061674
Training or coaching service - 9907071685
IT service - 9907101676
Digital services and electronic medium - 9907121690
Nepal
-
The sector valid values are
BusinessandIndividual.
Saudi Arabia
-
For
address, you must specifyaddressLine3.
South Korea
-
You must specify the
certifiedEmailIdandlegalNamein theTaxRegistrationEntryobject. Use Korean characters forlegalName. -
You must specify the
businessRepresentativeName,itemOfBusiness, andlineOfBusinessin thesouthKoreaAdditionalInfofield of theadditionalTaxInformationobject. Use Korean characters for these fields. -
You must specify the tax registration certificate document in the
taxRegistrationDocumentsfield of theVerificationDetailsobject. -
For the
addressobject, use Korean characters foraddressLine1,addressLine2city,postalCode, andstateOrRegion.
Spain
-
You must specify the
registrationTypein thespainAdditionalInfofield of theadditionalTaxInformationobject. -
If the
registrationTypeisLocal, you must specify the tax registration certificate document in thetaxRegistrationDocumentsfield of theVerificationDetailsobject.
Turkey
-
You must specify the
sectorin thetaxRegistrationEntryobject. -
If your
sectorisBusiness,Individual, orGovernment:-
Specify the
taxOffice. If yoursectorisIndividual, don't enter this value. -
(Optional) Specify the
kepEmailId. If yoursectorisIndividual, don't enter this value. -
Note: In the Tax Settings page of the Billing console,
Governmentappears as Public institutions
-
-
If your
sectorisBusinessand you're subject to KDV tax, you must specify your industry in theindustriesfield. -
For
address, you must specifydistrictOrCounty.
Ukraine
-
The sector valid values are
BusinessandIndividual.
This is a convenience which creates an instance of the
PutTaxRegistrationRequest.Builderavoiding the need to create one manually viaPutTaxRegistrationRequest.builder()- Parameters:
putTaxRegistrationRequest- AConsumerthat will call methods onPutTaxRegistrationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the PutTaxRegistration 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 invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The exception when the input doesn't pass validation for at least one of the input parameters.
- ConflictException The exception when the input is creating conflict with the given state.
- InternalServerException The exception thrown when an unexpected error occurs when processing a request.
- 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.
- TaxSettingsException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aTaxSettingsAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aTaxSettingsAsyncClient.
-