Skip to content

TaxSettingsClient#

Index > TaxSettings > TaxSettingsClient

Auto-generated documentation for TaxSettings type annotations stubs module mypy-boto3-taxsettings.

TaxSettingsClient#

Type annotations and code completion for boto3.client("taxsettings"). boto3 documentation

# TaxSettingsClient usage example

from boto3.session import Session
from mypy_boto3_taxsettings.client import TaxSettingsClient

def get_taxsettings_client() -> TaxSettingsClient:
    return Session().client("taxsettings")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("taxsettings").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("taxsettings")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.AttachmentUploadException,
    client.exceptions.CaseCreationLimitExceededException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_taxsettings.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

batch_delete_tax_registration#

Deletes tax registration for multiple accounts in batch.

Type annotations and code completion for boto3.client("taxsettings").batch_delete_tax_registration method. boto3 documentation

# batch_delete_tax_registration method definition

def batch_delete_tax_registration(
    self,
    *,
    accountIds: Sequence[str],
) -> BatchDeleteTaxRegistrationResponseTypeDef:  # (1)
    ...
  1. See BatchDeleteTaxRegistrationResponseTypeDef 
# batch_delete_tax_registration method usage example with argument unpacking

kwargs: BatchDeleteTaxRegistrationRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.batch_delete_tax_registration(**kwargs)
  1. See BatchDeleteTaxRegistrationRequestRequestTypeDef

batch_get_tax_exemptions#

Get the active tax exemptions for a given list of accounts.

Type annotations and code completion for boto3.client("taxsettings").batch_get_tax_exemptions method. boto3 documentation

# batch_get_tax_exemptions method definition

def batch_get_tax_exemptions(
    self,
    *,
    accountIds: Sequence[str],
) -> BatchGetTaxExemptionsResponseTypeDef:  # (1)
    ...
  1. See BatchGetTaxExemptionsResponseTypeDef 
# batch_get_tax_exemptions method usage example with argument unpacking

kwargs: BatchGetTaxExemptionsRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
}

parent.batch_get_tax_exemptions(**kwargs)
  1. See BatchGetTaxExemptionsRequestRequestTypeDef

batch_put_tax_registration#

Adds or updates tax registration for multiple accounts in batch.

Type annotations and code completion for boto3.client("taxsettings").batch_put_tax_registration method. boto3 documentation

# batch_put_tax_registration method definition

def batch_put_tax_registration(
    self,
    *,
    accountIds: Sequence[str],
    taxRegistrationEntry: TaxRegistrationEntryTypeDef,  # (1)
) -> BatchPutTaxRegistrationResponseTypeDef:  # (2)
    ...
  1. See TaxRegistrationEntryTypeDef
  2. See BatchPutTaxRegistrationResponseTypeDef 
# batch_put_tax_registration method usage example with argument unpacking

kwargs: BatchPutTaxRegistrationRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
    "taxRegistrationEntry": ...,
}

parent.batch_put_tax_registration(**kwargs)
  1. See BatchPutTaxRegistrationRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("taxsettings").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("taxsettings").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

delete_supplemental_tax_registration#

Deletes a supplemental tax registration for a single account.

Type annotations and code completion for boto3.client("taxsettings").delete_supplemental_tax_registration method. boto3 documentation

# delete_supplemental_tax_registration method definition

def delete_supplemental_tax_registration(
    self,
    *,
    authorityId: str,
) -> Dict[str, Any]:
    ...
# delete_supplemental_tax_registration method usage example with argument unpacking

kwargs: DeleteSupplementalTaxRegistrationRequestRequestTypeDef = {  # (1)
    "authorityId": ...,
}

parent.delete_supplemental_tax_registration(**kwargs)
  1. See DeleteSupplementalTaxRegistrationRequestRequestTypeDef

delete_tax_registration#

Deletes tax registration for a single account.

Type annotations and code completion for boto3.client("taxsettings").delete_tax_registration method. boto3 documentation

# delete_tax_registration method definition

def delete_tax_registration(
    self,
    *,
    accountId: str = ...,
) -> Dict[str, Any]:
    ...
# delete_tax_registration method usage example with argument unpacking

kwargs: DeleteTaxRegistrationRequestRequestTypeDef = {  # (1)
    "accountId": ...,
}

parent.delete_tax_registration(**kwargs)
  1. See DeleteTaxRegistrationRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("taxsettings").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_tax_exemption_types#

Get supported tax exemption types.

Type annotations and code completion for boto3.client("taxsettings").get_tax_exemption_types method. boto3 documentation

# get_tax_exemption_types method definition

def get_tax_exemption_types(
    self,
) -> GetTaxExemptionTypesResponseTypeDef:  # (1)
    ...
  1. See GetTaxExemptionTypesResponseTypeDef

get_tax_inheritance#

The get account tax inheritance status.

Type annotations and code completion for boto3.client("taxsettings").get_tax_inheritance method. boto3 documentation

# get_tax_inheritance method definition

def get_tax_inheritance(
    self,
) -> GetTaxInheritanceResponseTypeDef:  # (1)
    ...
  1. See GetTaxInheritanceResponseTypeDef

get_tax_registration#

Retrieves tax registration for a single account.

Type annotations and code completion for boto3.client("taxsettings").get_tax_registration method. boto3 documentation

# get_tax_registration method definition

def get_tax_registration(
    self,
    *,
    accountId: str = ...,
) -> GetTaxRegistrationResponseTypeDef:  # (1)
    ...
  1. See GetTaxRegistrationResponseTypeDef 
# get_tax_registration method usage example with argument unpacking

kwargs: GetTaxRegistrationRequestRequestTypeDef = {  # (1)
    "accountId": ...,
}

parent.get_tax_registration(**kwargs)
  1. See GetTaxRegistrationRequestRequestTypeDef

get_tax_registration_document#

Downloads your tax documents to the Amazon S3 bucket that you specify in your request.

Type annotations and code completion for boto3.client("taxsettings").get_tax_registration_document method. boto3 documentation

# get_tax_registration_document method definition

def get_tax_registration_document(
    self,
    *,
    taxDocumentMetadata: TaxDocumentMetadataTypeDef,  # (1)
    destinationS3Location: DestinationS3LocationTypeDef = ...,  # (2)
) -> GetTaxRegistrationDocumentResponseTypeDef:  # (3)
    ...
  1. See TaxDocumentMetadataTypeDef
  2. See DestinationS3LocationTypeDef
  3. See GetTaxRegistrationDocumentResponseTypeDef 
# get_tax_registration_document method usage example with argument unpacking

kwargs: GetTaxRegistrationDocumentRequestRequestTypeDef = {  # (1)
    "taxDocumentMetadata": ...,
}

parent.get_tax_registration_document(**kwargs)
  1. See GetTaxRegistrationDocumentRequestRequestTypeDef

list_supplemental_tax_registrations#

Retrieves supplemental tax registrations for a single account.

Type annotations and code completion for boto3.client("taxsettings").list_supplemental_tax_registrations method. boto3 documentation

# list_supplemental_tax_registrations method definition

def list_supplemental_tax_registrations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListSupplementalTaxRegistrationsResponseTypeDef:  # (1)
    ...
  1. See ListSupplementalTaxRegistrationsResponseTypeDef 
# list_supplemental_tax_registrations method usage example with argument unpacking

kwargs: ListSupplementalTaxRegistrationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_supplemental_tax_registrations(**kwargs)
  1. See ListSupplementalTaxRegistrationsRequestRequestTypeDef

list_tax_exemptions#

Retrieves the tax exemption of accounts listed in a consolidated billing family.

Type annotations and code completion for boto3.client("taxsettings").list_tax_exemptions method. boto3 documentation

# list_tax_exemptions method definition

def list_tax_exemptions(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTaxExemptionsResponseTypeDef:  # (1)
    ...
  1. See ListTaxExemptionsResponseTypeDef 
# list_tax_exemptions method usage example with argument unpacking

kwargs: ListTaxExemptionsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_tax_exemptions(**kwargs)
  1. See ListTaxExemptionsRequestRequestTypeDef

list_tax_registrations#

Retrieves the tax registration of accounts listed in a consolidated billing family.

Type annotations and code completion for boto3.client("taxsettings").list_tax_registrations method. boto3 documentation

# list_tax_registrations method definition

def list_tax_registrations(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTaxRegistrationsResponseTypeDef:  # (1)
    ...
  1. See ListTaxRegistrationsResponseTypeDef 
# list_tax_registrations method usage example with argument unpacking

kwargs: ListTaxRegistrationsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_tax_registrations(**kwargs)
  1. See ListTaxRegistrationsRequestRequestTypeDef

put_supplemental_tax_registration#

Stores supplemental tax registration for a single account.

Type annotations and code completion for boto3.client("taxsettings").put_supplemental_tax_registration method. boto3 documentation

# put_supplemental_tax_registration method definition

def put_supplemental_tax_registration(
    self,
    *,
    taxRegistrationEntry: SupplementalTaxRegistrationEntryTypeDef,  # (1)
) -> PutSupplementalTaxRegistrationResponseTypeDef:  # (2)
    ...
  1. See SupplementalTaxRegistrationEntryTypeDef
  2. See PutSupplementalTaxRegistrationResponseTypeDef 
# put_supplemental_tax_registration method usage example with argument unpacking

kwargs: PutSupplementalTaxRegistrationRequestRequestTypeDef = {  # (1)
    "taxRegistrationEntry": ...,
}

parent.put_supplemental_tax_registration(**kwargs)
  1. See PutSupplementalTaxRegistrationRequestRequestTypeDef

put_tax_exemption#

Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.

Type annotations and code completion for boto3.client("taxsettings").put_tax_exemption method. boto3 documentation

# put_tax_exemption method definition

def put_tax_exemption(
    self,
    *,
    accountIds: Sequence[str],
    authority: AuthorityTypeDef,  # (1)
    exemptionCertificate: ExemptionCertificateTypeDef,  # (2)
    exemptionType: str,
) -> PutTaxExemptionResponseTypeDef:  # (3)
    ...
  1. See AuthorityTypeDef
  2. See ExemptionCertificateTypeDef
  3. See PutTaxExemptionResponseTypeDef 
# put_tax_exemption method usage example with argument unpacking

kwargs: PutTaxExemptionRequestRequestTypeDef = {  # (1)
    "accountIds": ...,
    "authority": ...,
    "exemptionCertificate": ...,
    "exemptionType": ...,
}

parent.put_tax_exemption(**kwargs)
  1. See PutTaxExemptionRequestRequestTypeDef

put_tax_inheritance#

The updated tax inheritance status.

Type annotations and code completion for boto3.client("taxsettings").put_tax_inheritance method. boto3 documentation

# put_tax_inheritance method definition

def put_tax_inheritance(
    self,
    *,
    heritageStatus: HeritageStatusType = ...,  # (1)
) -> Dict[str, Any]:
    ...
  1. See HeritageStatusType 
# put_tax_inheritance method usage example with argument unpacking

kwargs: PutTaxInheritanceRequestRequestTypeDef = {  # (1)
    "heritageStatus": ...,
}

parent.put_tax_inheritance(**kwargs)
  1. See PutTaxInheritanceRequestRequestTypeDef

put_tax_registration#

Adds or updates tax registration for a single account.

Type annotations and code completion for boto3.client("taxsettings").put_tax_registration method. boto3 documentation

# put_tax_registration method definition

def put_tax_registration(
    self,
    *,
    taxRegistrationEntry: TaxRegistrationEntryTypeDef,  # (1)
    accountId: str = ...,
) -> PutTaxRegistrationResponseTypeDef:  # (2)
    ...
  1. See TaxRegistrationEntryTypeDef
  2. See PutTaxRegistrationResponseTypeDef 
# put_tax_registration method usage example with argument unpacking

kwargs: PutTaxRegistrationRequestRequestTypeDef = {  # (1)
    "taxRegistrationEntry": ...,
}

parent.put_tax_registration(**kwargs)
  1. See PutTaxRegistrationRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("taxsettings").get_paginator method with overloads.