Interface TaxSettingsClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TaxSettingsClient extends AwsClient
Service client for accessing Tax Settings. This can be created using the staticbuilder()method.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
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
batchDeleteTaxRegistration
default BatchDeleteTaxRegistrationResponse batchDeleteTaxRegistration(BatchDeleteTaxRegistrationRequest batchDeleteTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the BatchDeleteTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteTaxRegistration
default BatchDeleteTaxRegistrationResponse batchDeleteTaxRegistration(Consumer<BatchDeleteTaxRegistrationRequest.Builder> batchDeleteTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the BatchDeleteTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetTaxExemptions
default BatchGetTaxExemptionsResponse batchGetTaxExemptions(BatchGetTaxExemptionsRequest batchGetTaxExemptionsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Get the active tax exemptions for a given list of accounts.
- Parameters:
batchGetTaxExemptionsRequest-- Returns:
- Result of the BatchGetTaxExemptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchGetTaxExemptions
default BatchGetTaxExemptionsResponse batchGetTaxExemptions(Consumer<BatchGetTaxExemptionsRequest.Builder> batchGetTaxExemptionsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Get the active tax exemptions for a given list of accounts.
This is a convenience which creates an instance of the
BatchGetTaxExemptionsRequest.Builderavoiding the need to create one manually viaBatchGetTaxExemptionsRequest.builder()- Parameters:
batchGetTaxExemptionsRequest- AConsumerthat will call methods onBatchGetTaxExemptionsRequest.Builderto create a request.- Returns:
- Result of the BatchGetTaxExemptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutTaxRegistration
default BatchPutTaxRegistrationResponse batchPutTaxRegistration(BatchPutTaxRegistrationRequest batchPutTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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
-
The sector valid values are
BusinessandIndividual. -
RegistrationTypevalid values areNRICfor individual, and TIN and sales and service tax (SST) for Business. -
For individual, you can specify the
taxInformationNumberinMalaysiaAdditionalInfowith NRIC type, and a validMyKador NRIC number. -
For business, you must specify a
businessRegistrationNumberinMalaysiaAdditionalInfowith a TIN type and tax identification number. -
For business resellers, you must specify a
businessRegistrationNumberandtaxInformationNumberinMalaysiaAdditionalInfowith a sales and service tax (SST) type and a valid SST number. -
For business resellers with service codes, you must specify
businessRegistrationNumber,taxInformationNumber, and distinctserviceTaxCodesinMalaysiaAdditionalInfowith a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration 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.
-
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:
- Result of the BatchPutTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchPutTaxRegistration
default BatchPutTaxRegistrationResponse batchPutTaxRegistration(Consumer<BatchPutTaxRegistrationRequest.Builder> batchPutTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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
-
The sector valid values are
BusinessandIndividual. -
RegistrationTypevalid values areNRICfor individual, and TIN and sales and service tax (SST) for Business. -
For individual, you can specify the
taxInformationNumberinMalaysiaAdditionalInfowith NRIC type, and a validMyKador NRIC number. -
For business, you must specify a
businessRegistrationNumberinMalaysiaAdditionalInfowith a TIN type and tax identification number. -
For business resellers, you must specify a
businessRegistrationNumberandtaxInformationNumberinMalaysiaAdditionalInfowith a sales and service tax (SST) type and a valid SST number. -
For business resellers with service codes, you must specify
businessRegistrationNumber,taxInformationNumber, and distinctserviceTaxCodesinMalaysiaAdditionalInfowith a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration 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.
-
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:
- Result of the BatchPutTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
deleteSupplementalTaxRegistration
default DeleteSupplementalTaxRegistrationResponse deleteSupplementalTaxRegistration(DeleteSupplementalTaxRegistrationRequest deleteSupplementalTaxRegistrationRequest) throws ValidationException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Deletes a supplemental tax registration for a single account.
- Parameters:
deleteSupplementalTaxRegistrationRequest-- Returns:
- Result of the DeleteSupplementalTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteSupplementalTaxRegistration
default DeleteSupplementalTaxRegistrationResponse deleteSupplementalTaxRegistration(Consumer<DeleteSupplementalTaxRegistrationRequest.Builder> deleteSupplementalTaxRegistrationRequest) throws ValidationException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Deletes a supplemental tax registration for a single account.
This is a convenience which creates an instance of the
DeleteSupplementalTaxRegistrationRequest.Builderavoiding the need to create one manually viaDeleteSupplementalTaxRegistrationRequest.builder()- Parameters:
deleteSupplementalTaxRegistrationRequest- AConsumerthat will call methods onDeleteSupplementalTaxRegistrationRequest.Builderto create a request.- Returns:
- Result of the DeleteSupplementalTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTaxRegistration
default DeleteTaxRegistrationResponse deleteTaxRegistration(DeleteTaxRegistrationRequest deleteTaxRegistrationRequest) throws ValidationException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the DeleteTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTaxRegistration
default DeleteTaxRegistrationResponse deleteTaxRegistration(Consumer<DeleteTaxRegistrationRequest.Builder> deleteTaxRegistrationRequest) throws ValidationException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the DeleteTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxExemptionTypes
default GetTaxExemptionTypesResponse getTaxExemptionTypes(GetTaxExemptionTypesRequest getTaxExemptionTypesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Get supported tax exemption types.
- Parameters:
getTaxExemptionTypesRequest-- Returns:
- Result of the GetTaxExemptionTypes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxExemptionTypes
default GetTaxExemptionTypesResponse getTaxExemptionTypes(Consumer<GetTaxExemptionTypesRequest.Builder> getTaxExemptionTypesRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Get supported tax exemption types.
This is a convenience which creates an instance of the
GetTaxExemptionTypesRequest.Builderavoiding the need to create one manually viaGetTaxExemptionTypesRequest.builder()- Parameters:
getTaxExemptionTypesRequest- AConsumerthat will call methods onGetTaxExemptionTypesRequest.Builderto create a request.- Returns:
- Result of the GetTaxExemptionTypes operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxInheritance
default GetTaxInheritanceResponse getTaxInheritance(GetTaxInheritanceRequest getTaxInheritanceRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
The get account tax inheritance status.
- Parameters:
getTaxInheritanceRequest-- Returns:
- Result of the GetTaxInheritance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxInheritance
default GetTaxInheritanceResponse getTaxInheritance(Consumer<GetTaxInheritanceRequest.Builder> getTaxInheritanceRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
The get account tax inheritance status.
This is a convenience which creates an instance of the
GetTaxInheritanceRequest.Builderavoiding the need to create one manually viaGetTaxInheritanceRequest.builder()- Parameters:
getTaxInheritanceRequest- AConsumerthat will call methods onGetTaxInheritanceRequest.Builderto create a request.- Returns:
- Result of the GetTaxInheritance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxRegistration
default GetTaxRegistrationResponse getTaxRegistration(GetTaxRegistrationRequest getTaxRegistrationRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Retrieves tax registration for a single account.
- Parameters:
getTaxRegistrationRequest-- Returns:
- Result of the GetTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxRegistration
default GetTaxRegistrationResponse getTaxRegistration(Consumer<GetTaxRegistrationRequest.Builder> getTaxRegistrationRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the GetTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxRegistrationDocument
default GetTaxRegistrationDocumentResponse getTaxRegistrationDocument(GetTaxRegistrationDocumentRequest getTaxRegistrationDocumentRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Downloads your tax documents to the Amazon S3 bucket that you specify in your request.
- Parameters:
getTaxRegistrationDocumentRequest-- Returns:
- Result of the GetTaxRegistrationDocument operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getTaxRegistrationDocument
default GetTaxRegistrationDocumentResponse getTaxRegistrationDocument(Consumer<GetTaxRegistrationDocumentRequest.Builder> getTaxRegistrationDocumentRequest) throws ValidationException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the GetTaxRegistrationDocument operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSupplementalTaxRegistrations
default ListSupplementalTaxRegistrationsResponse listSupplementalTaxRegistrations(ListSupplementalTaxRegistrationsRequest listSupplementalTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Retrieves supplemental tax registrations for a single account.
- Parameters:
listSupplementalTaxRegistrationsRequest-- Returns:
- Result of the ListSupplementalTaxRegistrations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSupplementalTaxRegistrations
default ListSupplementalTaxRegistrationsResponse listSupplementalTaxRegistrations(Consumer<ListSupplementalTaxRegistrationsRequest.Builder> listSupplementalTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Retrieves supplemental tax registrations for a single account.
This is a convenience which creates an instance of the
ListSupplementalTaxRegistrationsRequest.Builderavoiding the need to create one manually viaListSupplementalTaxRegistrationsRequest.builder()- Parameters:
listSupplementalTaxRegistrationsRequest- AConsumerthat will call methods onListSupplementalTaxRegistrationsRequest.Builderto create a request.- Returns:
- Result of the ListSupplementalTaxRegistrations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSupplementalTaxRegistrationsPaginator
default ListSupplementalTaxRegistrationsIterable listSupplementalTaxRegistrationsPaginator(ListSupplementalTaxRegistrationsRequest listSupplementalTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
This is a variant of
listSupplementalTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListSupplementalTaxRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.taxsettings.paginators.ListSupplementalTaxRegistrationsIterable responses = client.listSupplementalTaxRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.taxsettings.paginators.ListSupplementalTaxRegistrationsIterable responses = client .listSupplementalTaxRegistrationsPaginator(request); for (software.amazon.awssdk.services.taxsettings.model.ListSupplementalTaxRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.taxsettings.paginators.ListSupplementalTaxRegistrationsIterable responses = client.listSupplementalTaxRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);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
listSupplementalTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListSupplementalTaxRegistrationsRequest)operation.- Parameters:
listSupplementalTaxRegistrationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listSupplementalTaxRegistrationsPaginator
default ListSupplementalTaxRegistrationsIterable listSupplementalTaxRegistrationsPaginator(Consumer<ListSupplementalTaxRegistrationsRequest.Builder> listSupplementalTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
This is a variant of
listSupplementalTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListSupplementalTaxRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.taxsettings.paginators.ListSupplementalTaxRegistrationsIterable responses = client.listSupplementalTaxRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.taxsettings.paginators.ListSupplementalTaxRegistrationsIterable responses = client .listSupplementalTaxRegistrationsPaginator(request); for (software.amazon.awssdk.services.taxsettings.model.ListSupplementalTaxRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.taxsettings.paginators.ListSupplementalTaxRegistrationsIterable responses = client.listSupplementalTaxRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);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
listSupplementalTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListSupplementalTaxRegistrationsRequest)operation.
This is a convenience which creates an instance of the
ListSupplementalTaxRegistrationsRequest.Builderavoiding the need to create one manually viaListSupplementalTaxRegistrationsRequest.builder()- Parameters:
listSupplementalTaxRegistrationsRequest- AConsumerthat will call methods onListSupplementalTaxRegistrationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxExemptions
default ListTaxExemptionsResponse listTaxExemptions(ListTaxExemptionsRequest listTaxExemptionsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Retrieves the tax exemption of accounts listed in a consolidated billing family.
- Parameters:
listTaxExemptionsRequest-- Returns:
- Result of the ListTaxExemptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxExemptions
default ListTaxExemptionsResponse listTaxExemptions(Consumer<ListTaxExemptionsRequest.Builder> listTaxExemptionsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Retrieves the tax exemption of accounts listed in a consolidated billing family.
This is a convenience which creates an instance of the
ListTaxExemptionsRequest.Builderavoiding the need to create one manually viaListTaxExemptionsRequest.builder()- Parameters:
listTaxExemptionsRequest- AConsumerthat will call methods onListTaxExemptionsRequest.Builderto create a request.- Returns:
- Result of the ListTaxExemptions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxExemptionsPaginator
default ListTaxExemptionsIterable listTaxExemptionsPaginator(ListTaxExemptionsRequest listTaxExemptionsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
This is a variant of
listTaxExemptions(software.amazon.awssdk.services.taxsettings.model.ListTaxExemptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxExemptionsIterable responses = client.listTaxExemptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.taxsettings.paginators.ListTaxExemptionsIterable responses = client .listTaxExemptionsPaginator(request); for (software.amazon.awssdk.services.taxsettings.model.ListTaxExemptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxExemptionsIterable responses = client.listTaxExemptionsPaginator(request); responses.iterator().forEachRemaining(....);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
listTaxExemptions(software.amazon.awssdk.services.taxsettings.model.ListTaxExemptionsRequest)operation.- Parameters:
listTaxExemptionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxExemptionsPaginator
default ListTaxExemptionsIterable listTaxExemptionsPaginator(Consumer<ListTaxExemptionsRequest.Builder> listTaxExemptionsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
This is a variant of
listTaxExemptions(software.amazon.awssdk.services.taxsettings.model.ListTaxExemptionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxExemptionsIterable responses = client.listTaxExemptionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.taxsettings.paginators.ListTaxExemptionsIterable responses = client .listTaxExemptionsPaginator(request); for (software.amazon.awssdk.services.taxsettings.model.ListTaxExemptionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxExemptionsIterable responses = client.listTaxExemptionsPaginator(request); responses.iterator().forEachRemaining(....);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
listTaxExemptions(software.amazon.awssdk.services.taxsettings.model.ListTaxExemptionsRequest)operation.
This is a convenience which creates an instance of the
ListTaxExemptionsRequest.Builderavoiding the need to create one manually viaListTaxExemptionsRequest.builder()- Parameters:
listTaxExemptionsRequest- AConsumerthat will call methods onListTaxExemptionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxRegistrations
default ListTaxRegistrationsResponse listTaxRegistrations(ListTaxRegistrationsRequest listTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the ListTaxRegistrations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxRegistrations
default ListTaxRegistrationsResponse listTaxRegistrations(Consumer<ListTaxRegistrationsRequest.Builder> listTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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:
- Result of the ListTaxRegistrations operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxRegistrationsPaginator
default ListTaxRegistrationsIterable listTaxRegistrationsPaginator(ListTaxRegistrationsRequest listTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
This is a variant of
listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client .listTaxRegistrationsPaginator(request); for (software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTaxRegistrationsPaginator
default ListTaxRegistrationsIterable listTaxRegistrationsPaginator(Consumer<ListTaxRegistrationsRequest.Builder> listTaxRegistrationsRequest) throws ValidationException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
This is a variant of
listTaxRegistrations(software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client .listTaxRegistrationsPaginator(request); for (software.amazon.awssdk.services.taxsettings.model.ListTaxRegistrationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.taxsettings.paginators.ListTaxRegistrationsIterable responses = client.listTaxRegistrationsPaginator(request); responses.iterator().forEachRemaining(....);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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putSupplementalTaxRegistration
default PutSupplementalTaxRegistrationResponse putSupplementalTaxRegistration(PutSupplementalTaxRegistrationRequest putSupplementalTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Stores supplemental tax registration for a single account.
- Parameters:
putSupplementalTaxRegistrationRequest-- Returns:
- Result of the PutSupplementalTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putSupplementalTaxRegistration
default PutSupplementalTaxRegistrationResponse putSupplementalTaxRegistration(Consumer<PutSupplementalTaxRegistrationRequest.Builder> putSupplementalTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Stores supplemental tax registration for a single account.
This is a convenience which creates an instance of the
PutSupplementalTaxRegistrationRequest.Builderavoiding the need to create one manually viaPutSupplementalTaxRegistrationRequest.builder()- Parameters:
putSupplementalTaxRegistrationRequest- AConsumerthat will call methods onPutSupplementalTaxRegistrationRequest.Builderto create a request.- Returns:
- Result of the PutSupplementalTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putTaxExemption
default PutTaxExemptionResponse putTaxExemption(PutTaxExemptionRequest putTaxExemptionRequest) throws ValidationException, AccessDeniedException, CaseCreationLimitExceededException, ResourceNotFoundException, AttachmentUploadException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.
- Parameters:
putTaxExemptionRequest-- Returns:
- Result of the PutTaxExemption operation returned by the service.
- Throws:
ValidationException- The exception when the input doesn't pass validation for at least one of the input parameters.AccessDeniedException- The access is denied for the Amazon Web Services Support API.CaseCreationLimitExceededException- You've exceeded the Amazon Web Services Support case creation limit for your account.ResourceNotFoundException- The exception thrown when the input doesn't have a resource associated to it.AttachmentUploadException- Failed to upload the tax exemption document to Amazon Web Services Support case.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.AwsServiceException- See Also:
- AWS API Documentation
-
putTaxExemption
default PutTaxExemptionResponse putTaxExemption(Consumer<PutTaxExemptionRequest.Builder> putTaxExemptionRequest) throws ValidationException, AccessDeniedException, CaseCreationLimitExceededException, ResourceNotFoundException, AttachmentUploadException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.
This is a convenience which creates an instance of the
PutTaxExemptionRequest.Builderavoiding the need to create one manually viaPutTaxExemptionRequest.builder()- Parameters:
putTaxExemptionRequest- AConsumerthat will call methods onPutTaxExemptionRequest.Builderto create a request.- Returns:
- Result of the PutTaxExemption operation returned by the service.
- Throws:
ValidationException- The exception when the input doesn't pass validation for at least one of the input parameters.AccessDeniedException- The access is denied for the Amazon Web Services Support API.CaseCreationLimitExceededException- You've exceeded the Amazon Web Services Support case creation limit for your account.ResourceNotFoundException- The exception thrown when the input doesn't have a resource associated to it.AttachmentUploadException- Failed to upload the tax exemption document to Amazon Web Services Support case.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.AwsServiceException- See Also:
- AWS API Documentation
-
putTaxInheritance
default PutTaxInheritanceResponse putTaxInheritance(PutTaxInheritanceRequest putTaxInheritanceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
The updated tax inheritance status.
- Parameters:
putTaxInheritanceRequest-- Returns:
- Result of the PutTaxInheritance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putTaxInheritance
default PutTaxInheritanceResponse putTaxInheritance(Consumer<PutTaxInheritanceRequest.Builder> putTaxInheritanceRequest) throws ValidationException, ConflictException, ResourceNotFoundException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
The updated tax inheritance status.
This is a convenience which creates an instance of the
PutTaxInheritanceRequest.Builderavoiding the need to create one manually viaPutTaxInheritanceRequest.builder()- Parameters:
putTaxInheritanceRequest- AConsumerthat will call methods onPutTaxInheritanceRequest.Builderto create a request.- Returns:
- Result of the PutTaxInheritance operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putTaxRegistration
default PutTaxRegistrationResponse putTaxRegistration(PutTaxRegistrationRequest putTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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
-
The sector valid values are
BusinessandIndividual. -
RegistrationTypevalid values areNRICfor individual, and TIN and sales and service tax (SST) for Business. -
For individual, you can specify the
taxInformationNumberinMalaysiaAdditionalInfowith NRIC type, and a validMyKador NRIC number. -
For business, you must specify a
businessRegistrationNumberinMalaysiaAdditionalInfowith a TIN type and tax identification number. -
For business resellers, you must specify a
businessRegistrationNumberandtaxInformationNumberinMalaysiaAdditionalInfowith a sales and service tax (SST) type and a valid SST number. -
For business resellers with service codes, you must specify
businessRegistrationNumber,taxInformationNumber, and distinctserviceTaxCodesinMalaysiaAdditionalInfowith a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration 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.
-
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:
- Result of the PutTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
putTaxRegistration
default PutTaxRegistrationResponse putTaxRegistration(Consumer<PutTaxRegistrationRequest.Builder> putTaxRegistrationRequest) throws ValidationException, ConflictException, InternalServerException, AwsServiceException, SdkClientException, TaxSettingsException
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
-
The sector valid values are
BusinessandIndividual. -
RegistrationTypevalid values areNRICfor individual, and TIN and sales and service tax (SST) for Business. -
For individual, you can specify the
taxInformationNumberinMalaysiaAdditionalInfowith NRIC type, and a validMyKador NRIC number. -
For business, you must specify a
businessRegistrationNumberinMalaysiaAdditionalInfowith a TIN type and tax identification number. -
For business resellers, you must specify a
businessRegistrationNumberandtaxInformationNumberinMalaysiaAdditionalInfowith a sales and service tax (SST) type and a valid SST number. -
For business resellers with service codes, you must specify
businessRegistrationNumber,taxInformationNumber, and distinctserviceTaxCodesinMalaysiaAdditionalInfowith a SST type and valid sales and service tax (SST) number. By using this API operation, Amazon Web Services registers your self-declaration 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.
-
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:
- Result of the PutTaxRegistration operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
create
static TaxSettingsClient create()
Create aTaxSettingsClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static TaxSettingsClientBuilder builder()
Create a builder that can be used to configure and create aTaxSettingsClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default TaxSettingsServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-