Struct Client

pub struct Client { /* private fields */ }

Client for Tax Settings

Client for invoking operations on Tax Settings. Each operation on Tax Settings is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_taxsettings::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_taxsettings::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteSupplementalTaxRegistration operation has a Client::delete_supplemental_tax_registration, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_supplemental_tax_registration()
    .authority_id("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn batch_delete_tax_registration( &self, ) -> BatchDeleteTaxRegistrationFluentBuilder

Constructs a fluent builder for the BatchDeleteTaxRegistration operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    List of unique account identifiers.

    
    
• On success, responds with BatchDeleteTaxRegistrationOutput with field(s):
  • errors(Vec::<BatchDeleteTaxRegistrationError>):

    The list of errors for the accounts the TRN information could not be deleted for.

• On failure, responds with SdkError<BatchDeleteTaxRegistrationError>

impl Client

pub fn batch_get_tax_exemptions(&self) -> BatchGetTaxExemptionsFluentBuilder

Constructs a fluent builder for the BatchGetTaxExemptions operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    List of unique account identifiers.

    
    
• On success, responds with BatchGetTaxExemptionsOutput with field(s):
  • tax_exemption_details_map(Option<HashMap::<String, TaxExemptionDetails>>):

    The tax exemption details map of accountId and tax exemption details.

  • failed_accounts(Option<Vec::<String>>):

    The list of accounts that failed to get tax exemptions.

• On failure, responds with SdkError<BatchGetTaxExemptionsError>

impl Client

pub fn batch_put_tax_registration(&self) -> BatchPutTaxRegistrationFluentBuilder

Constructs a fluent builder for the BatchPutTaxRegistration operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    List of unique account identifiers.

    
    
  • tax_registration_entry(TaxRegistrationEntry) / set_tax_registration_entry(Option<TaxRegistrationEntry>):
    required: true
    

    Your TRN information that will be stored to the accounts mentioned in putEntries.

    
    
• On success, responds with BatchPutTaxRegistrationOutput with field(s):
  • status(Option<TaxRegistrationStatus>):

    The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending or Rejected.

  • errors(Vec::<BatchPutTaxRegistrationError>):

    List of errors for the accounts the TRN information could not be added or updated to.

• On failure, responds with SdkError<BatchPutTaxRegistrationError>

impl Client

pub fn delete_supplemental_tax_registration( &self, ) -> DeleteSupplementalTaxRegistrationFluentBuilder

Constructs a fluent builder for the DeleteSupplementalTaxRegistration operation.

• The fluent builder is configurable:
  • authority_id(impl Into<String>) / set_authority_id(Option<String>):
    required: true
    

    The unique authority Id for the supplemental TRN information that needs to be deleted.

    
    
• On success, responds with DeleteSupplementalTaxRegistrationOutput
• On failure, responds with SdkError<DeleteSupplementalTaxRegistrationError>

impl Client

pub fn delete_tax_registration(&self) -> DeleteTaxRegistrationFluentBuilder

Constructs a fluent builder for the DeleteTaxRegistration operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Unique account identifier for the TRN information that needs to be deleted. If this isn’t passed, the account ID corresponding to the credentials of the API caller will be used for this parameter.

    
    
• On success, responds with DeleteTaxRegistrationOutput
• On failure, responds with SdkError<DeleteTaxRegistrationError>

impl Client

pub fn get_tax_exemption_types(&self) -> GetTaxExemptionTypesFluentBuilder

Constructs a fluent builder for the GetTaxExemptionTypes operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetTaxExemptionTypesOutput with field(s):
  • tax_exemption_types(Option<Vec::<TaxExemptionType>>):

    The supported types of tax exemptions.

• On failure, responds with SdkError<GetTaxExemptionTypesError>

impl Client

pub fn get_tax_inheritance(&self) -> GetTaxInheritanceFluentBuilder

Constructs a fluent builder for the GetTaxInheritance operation.

• The fluent builder takes no input, just send it.
• On success, responds with GetTaxInheritanceOutput with field(s):
  • heritage_status(Option<HeritageStatus>):

    The tax inheritance status.

• On failure, responds with SdkError<GetTaxInheritanceError>

impl Client

pub fn get_tax_registration(&self) -> GetTaxRegistrationFluentBuilder

Constructs a fluent builder for the GetTaxRegistration operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Your unique account identifier.

    
    
• On success, responds with GetTaxRegistrationOutput with field(s):
  • tax_registration(Option<TaxRegistration>):

    TRN information of the account mentioned in the request.

• On failure, responds with SdkError<GetTaxRegistrationError>

impl Client

pub fn get_tax_registration_document( &self, ) -> GetTaxRegistrationDocumentFluentBuilder

Constructs a fluent builder for the GetTaxRegistrationDocument operation.

• The fluent builder is configurable:
  • destination_s3_location(DestinationS3Location) / set_destination_s3_location(Option<DestinationS3Location>):
    required: false
    

    The Amazon S3 bucket that you specify to download your tax documents to.

    
    
  • tax_document_metadata(TaxDocumentMetadata) / set_tax_document_metadata(Option<TaxDocumentMetadata>):
    required: true
    

    The metadata for your tax document.

    
    
• On success, responds with GetTaxRegistrationDocumentOutput with field(s):
  • destination_file_path(Option<String>):

    The file path of the Amazon S3 bucket where you want to download your tax document to.

  • presigned_s3_url(Option<String>):

    The Amazon S3 presigned URL of the tax registration document.

• On failure, responds with SdkError<GetTaxRegistrationDocumentError>

impl Client

pub fn list_supplemental_tax_registrations( &self, ) -> ListSupplementalTaxRegistrationsFluentBuilder

Constructs a fluent builder for the ListSupplementalTaxRegistrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of taxRegistrations results you want in one response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
• On success, responds with ListSupplementalTaxRegistrationsOutput with field(s):
  • tax_registrations(Vec::<SupplementalTaxRegistration>):

    The list of supplemental tax registrations.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListSupplementalTaxRegistrationsError>

impl Client

pub fn list_tax_exemptions(&self) -> ListTaxExemptionsFluentBuilder

Constructs a fluent builder for the ListTaxExemptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The number of results you want in one response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
• On success, responds with ListTaxExemptionsOutput with field(s):
  • next_token(Option<String>):

    The token to retrieve the next set of results.

  • tax_exemption_details_map(Option<HashMap::<String, TaxExemptionDetails>>):

    The tax exemption details map of accountId and tax exemption details.

• On failure, responds with SdkError<ListTaxExemptionsError>

impl Client

pub fn list_tax_registrations(&self) -> ListTaxRegistrationsFluentBuilder

Constructs a fluent builder for the ListTaxRegistrations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    Number of accountDetails results you want in one response.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The token to retrieve the next set of results.

    
    
• On success, responds with ListTaxRegistrationsOutput with field(s):
  • account_details(Vec::<AccountDetails>):

    The list of account details. This contains account Ids and TRN Information for each of the linked accounts.

  • next_token(Option<String>):

    The token to retrieve the next set of results.

• On failure, responds with SdkError<ListTaxRegistrationsError>

impl Client

pub fn put_supplemental_tax_registration( &self, ) -> PutSupplementalTaxRegistrationFluentBuilder

Constructs a fluent builder for the PutSupplementalTaxRegistration operation.

• The fluent builder is configurable:
  • tax_registration_entry(SupplementalTaxRegistrationEntry) / set_tax_registration_entry(Option<SupplementalTaxRegistrationEntry>):
    required: true
    

    The supplemental TRN information that will be stored for the caller account ID.

    
    
• On success, responds with PutSupplementalTaxRegistrationOutput with field(s):
  • authority_id(String):

    Unique authority ID for the supplemental TRN information that was stored.

  • status(TaxRegistrationStatus):

    The status of the supplemental TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending, Rejected, or Deleted.

• On failure, responds with SdkError<PutSupplementalTaxRegistrationError>

impl Client

pub fn put_tax_exemption(&self) -> PutTaxExemptionFluentBuilder

Constructs a fluent builder for the PutTaxExemption operation.

• The fluent builder is configurable:
  • account_ids(impl Into<String>) / set_account_ids(Option<Vec::<String>>):
    required: true
    

    The list of unique account identifiers.

    
    
  • authority(Authority) / set_authority(Option<Authority>):
    required: true
    

    The address domain associate with the tax information.

    
    
  • exemption_type(impl Into<String>) / set_exemption_type(Option<String>):
    required: true
    

    The exemption type. Use the supported tax exemption type description.

    
    
  • exemption_certificate(ExemptionCertificate) / set_exemption_certificate(Option<ExemptionCertificate>):
    required: true
    

    The exemption certificate.

    
    
• On success, responds with PutTaxExemptionOutput with field(s):
  • case_id(Option<String>):

    The customer support case ID.

• On failure, responds with SdkError<PutTaxExemptionError>

impl Client

pub fn put_tax_inheritance(&self) -> PutTaxInheritanceFluentBuilder

Constructs a fluent builder for the PutTaxInheritance operation.

• The fluent builder is configurable:
  • heritage_status(HeritageStatus) / set_heritage_status(Option<HeritageStatus>):
    required: false
    

    The tax inheritance status.

    
    
• On success, responds with PutTaxInheritanceOutput
• On failure, responds with SdkError<PutTaxInheritanceError>

impl Client

pub fn put_tax_registration(&self) -> PutTaxRegistrationFluentBuilder

Constructs a fluent builder for the PutTaxRegistration operation.

• The fluent builder is configurable:
  • account_id(impl Into<String>) / set_account_id(Option<String>):
    required: false
    

    Your unique account identifier.

    
    
  • tax_registration_entry(TaxRegistrationEntry) / set_tax_registration_entry(Option<TaxRegistrationEntry>):
    required: true
    

    Your TRN information that will be stored to the account mentioned in accountId.

    
    
• On success, responds with PutTaxRegistrationOutput with field(s):
  • status(Option<TaxRegistrationStatus>):

    The status of your TRN stored in the system after processing. Based on the validation occurring on the TRN, the status can be Verified, Pending or Rejected.

• On failure, responds with SdkError<PutTaxRegistrationError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.