Class: Aws::TaxSettings::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb

Overview

An API client for TaxSettings. To construct a client, you need to configure a :region and :credentials.

client = Aws::TaxSettings::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::TaxSettings::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::TaxSettings::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



444
445
446
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 444

def initialize(*args)
  super
end

Instance Method Details

#batch_delete_tax_registration(params = {}) ⇒ Types::BatchDeleteTaxRegistrationResponse

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.

Examples:

Request syntax with placeholder values


resp = client.batch_delete_tax_registration({
  account_ids: ["AccountId"], # required
})

Response structure


resp.errors #=> Array
resp.errors[0]. #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>) —

    List of unique account identifiers.

Returns:

See Also:



487
488
489
490
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 487

def batch_delete_tax_registration(params = {}, options = {})
  req = build_request(:batch_delete_tax_registration, params)
  req.send_request(options)
end

#batch_put_tax_registration(params = {}) ⇒ Types::BatchPutTaxRegistrationResponse

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 taxRegistrationDocuments field of the VerificationDetails object.

^

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 personType values are Physical Person and Business.

^

Kenya

  • You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

  • If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Malaysia

  • The sector valid values are Business and Individual.

  • RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

  • For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

  • For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

  • For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

  • For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with 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 Business and Individual.

^

Saudi Arabia

  • For address, you must specify addressLine3.

^

South Korea

  • You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

  • You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

  • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

  • For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

Spain

  • You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

  • If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Turkey

  • You must specify the sector in the taxRegistrationEntry object.

  • If your sector is Business, Individual, or Government:

    • Specify the taxOffice. If your sector is Individual, don't enter this value.

    • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

    • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

  • If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

  • For address, you must specify districtOrCounty.

Ukraine

  • The sector valid values are Business and Individual.

^

Examples:

Request syntax with placeholder values


resp = client.batch_put_tax_registration({
  account_ids: ["AccountId"], # required
  tax_registration_entry: { # required
    additional_tax_information: {
      canada_additional_info: {
        canada_quebec_sales_tax_number: "CanadaQuebecSalesTaxNumberString",
        canada_retail_sales_tax_number: "CanadaRetailSalesTaxNumberString",
        is_reseller_account: false,
        provincial_sales_tax_id: "CanadaProvincialSalesTaxIdString",
      },
      estonia_additional_info: {
        registry_commercial_code: "RegistryCommercialCode", # required
      },
      georgia_additional_info: {
        person_type: "Legal Person", # required, accepts Legal Person, Physical Person, Business
      },
      israel_additional_info: {
        customer_type: "Business", # required, accepts Business, Individual
        dealer_type: "Authorized", # required, accepts Authorized, Non-authorized
      },
      italy_additional_info: {
        cig_number: "CigNumber",
        cup_number: "CupNumber",
        sdi_account_id: "SdiAccountId",
        tax_code: "TaxCode",
      },
      kenya_additional_info: {
        person_type: "Legal Person", # required, accepts Legal Person, Physical Person, Business
      },
      malaysia_additional_info: {
        business_registration_number: "BusinessRegistrationNumber",
        service_tax_codes: ["Consultancy"], # accepts Consultancy, Digital Service And Electronic Medium, IT Services, Training Or Coaching
        tax_information_number: "TaxInformationNumber",
      },
      poland_additional_info: {
        individual_registration_number: "IndividualRegistrationNumber",
        is_group_vat_enabled: false,
      },
      romania_additional_info: {
        tax_registration_number_type: "TaxRegistrationNumber", # required, accepts TaxRegistrationNumber, LocalRegistrationNumber
      },
      saudi_arabia_additional_info: {
        tax_registration_number_type: "TaxRegistrationNumber", # accepts TaxRegistrationNumber, TaxIdentificationNumber, CommercialRegistrationNumber
      },
      south_korea_additional_info: {
        business_representative_name: "BusinessRepresentativeName", # required
        item_of_business: "ItemOfBusiness", # required
        line_of_business: "LineOfBusiness", # required
      },
      spain_additional_info: {
        registration_type: "Intra-EU", # required, accepts Intra-EU, Local
      },
      turkey_additional_info: {
        industries: "CirculatingOrg", # accepts CirculatingOrg, ProfessionalOrg, Banks, Insurance, PensionAndBenefitFunds, DevelopmentAgencies
        kep_email_id: "KepEmailId",
        secondary_tax_id: "SecondaryTaxId",
        tax_office: "TaxOffice",
      },
      ukraine_additional_info: {
        ukraine_trn_type: "Business", # required, accepts Business, Individual
      },
    },
    certified_email_id: "CertifiedEmailId",
    legal_address: {
      address_line_1: "AddressLine1", # required
      address_line_2: "AddressLine2",
      address_line_3: "AddressLine3",
      city: "City", # required
      country_code: "CountryCode", # required
      district_or_county: "District",
      postal_code: "PostalCode", # required
      state_or_region: "State",
    },
    legal_name: "LegalName",
    registration_id: "RegistrationId", # required
    registration_type: "VAT", # required, accepts VAT, GST, CPF, CNPJ, SST, TIN, NRIC
    sector: "Business", # accepts Business, Individual, Government
    verification_details: {
      date_of_birth: "DateOfBirth",
      tax_registration_documents: [
        {
          s3_location: { # required
            bucket: "S3BucketName", # required
            key: "S3Key", # required
          },
        },
      ],
    },
  },
})

Response structure


resp.errors #=> Array
resp.errors[0]. #=> String
resp.errors[0].code #=> String
resp.errors[0].message #=> String
resp.status #=> String, one of "Verified", "Pending", "Deleted", "Rejected"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_ids (required, Array<String>) —

    List of unique account identifiers.

  • :tax_registration_entry (required, Types::TaxRegistrationEntry) —

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

Returns:

See Also:



765
766
767
768
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 765

def batch_put_tax_registration(params = {}, options = {})
  req = build_request(:batch_put_tax_registration, params)
  req.send_request(options)
end

#delete_supplemental_tax_registration(params = {}) ⇒ Struct

Deletes a supplemental tax registration for a single account.

Examples:

Request syntax with placeholder values


resp = client.delete_supplemental_tax_registration({
  authority_id: "GenericString", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :authority_id (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



788
789
790
791
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 788

def delete_supplemental_tax_registration(params = {}, options = {})
  req = build_request(:delete_supplemental_tax_registration, params)
  req.send_request(options)
end

#delete_tax_registration(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.delete_tax_registration({
  account_id: "AccountId",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (String) —

    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.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



822
823
824
825
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 822

def delete_tax_registration(params = {}, options = {})
  req = build_request(:delete_tax_registration, params)
  req.send_request(options)
end

#get_tax_registration(params = {}) ⇒ Types::GetTaxRegistrationResponse

Retrieves tax registration for a single account.

Examples:

Request syntax with placeholder values


resp = client.get_tax_registration({
  account_id: "AccountId",
})

Response structure


resp.tax_registration.additional_tax_information.brazil_additional_info.ccm_code #=> String
resp.tax_registration.additional_tax_information.brazil_additional_info.legal_nature_code #=> String
resp.tax_registration.additional_tax_information.canada_additional_info.canada_quebec_sales_tax_number #=> String
resp.tax_registration.additional_tax_information.canada_additional_info.canada_retail_sales_tax_number #=> String
resp.tax_registration.additional_tax_information.canada_additional_info. #=> Boolean
resp.tax_registration.additional_tax_information.canada_additional_info.provincial_sales_tax_id #=> String
resp.tax_registration.additional_tax_information.estonia_additional_info.registry_commercial_code #=> String
resp.tax_registration.additional_tax_information.georgia_additional_info.person_type #=> String, one of "Legal Person", "Physical Person", "Business"
resp.tax_registration.additional_tax_information.india_additional_info.pan #=> String
resp.tax_registration.additional_tax_information.israel_additional_info.customer_type #=> String, one of "Business", "Individual"
resp.tax_registration.additional_tax_information.israel_additional_info.dealer_type #=> String, one of "Authorized", "Non-authorized"
resp.tax_registration.additional_tax_information.italy_additional_info.cig_number #=> String
resp.tax_registration.additional_tax_information.italy_additional_info.cup_number #=> String
resp.tax_registration.additional_tax_information.italy_additional_info. #=> String
resp.tax_registration.additional_tax_information.italy_additional_info.tax_code #=> String
resp.tax_registration.additional_tax_information.kenya_additional_info.person_type #=> String, one of "Legal Person", "Physical Person", "Business"
resp.tax_registration.additional_tax_information.malaysia_additional_info.business_registration_number #=> String
resp.tax_registration.additional_tax_information.malaysia_additional_info.service_tax_codes #=> Array
resp.tax_registration.additional_tax_information.malaysia_additional_info.service_tax_codes[0] #=> String, one of "Consultancy", "Digital Service And Electronic Medium", "IT Services", "Training Or Coaching"
resp.tax_registration.additional_tax_information.malaysia_additional_info.tax_information_number #=> String
resp.tax_registration.additional_tax_information.poland_additional_info.individual_registration_number #=> String
resp.tax_registration.additional_tax_information.poland_additional_info.is_group_vat_enabled #=> Boolean
resp.tax_registration.additional_tax_information.romania_additional_info.tax_registration_number_type #=> String, one of "TaxRegistrationNumber", "LocalRegistrationNumber"
resp.tax_registration.additional_tax_information.saudi_arabia_additional_info.tax_registration_number_type #=> String, one of "TaxRegistrationNumber", "TaxIdentificationNumber", "CommercialRegistrationNumber"
resp.tax_registration.additional_tax_information.south_korea_additional_info.business_representative_name #=> String
resp.tax_registration.additional_tax_information.south_korea_additional_info.item_of_business #=> String
resp.tax_registration.additional_tax_information.south_korea_additional_info.line_of_business #=> String
resp.tax_registration.additional_tax_information.spain_additional_info.registration_type #=> String, one of "Intra-EU", "Local"
resp.tax_registration.additional_tax_information.turkey_additional_info.industries #=> String, one of "CirculatingOrg", "ProfessionalOrg", "Banks", "Insurance", "PensionAndBenefitFunds", "DevelopmentAgencies"
resp.tax_registration.additional_tax_information.turkey_additional_info.kep_email_id #=> String
resp.tax_registration.additional_tax_information.turkey_additional_info.secondary_tax_id #=> String
resp.tax_registration.additional_tax_information.turkey_additional_info.tax_office #=> String
resp.tax_registration.additional_tax_information.ukraine_additional_info.ukraine_trn_type #=> String, one of "Business", "Individual"
resp.tax_registration.certified_email_id #=> String
resp.tax_registration.legal_address.address_line_1 #=> String
resp.tax_registration.legal_address.address_line_2 #=> String
resp.tax_registration.legal_address.address_line_3 #=> String
resp.tax_registration.legal_address.city #=> String
resp.tax_registration.legal_address.country_code #=> String
resp.tax_registration.legal_address.district_or_county #=> String
resp.tax_registration.legal_address.postal_code #=> String
resp.tax_registration.legal_address.state_or_region #=> String
resp.tax_registration.legal_name #=> String
resp.tax_registration.registration_id #=> String
resp.tax_registration.registration_type #=> String, one of "VAT", "GST", "CPF", "CNPJ", "SST", "TIN", "NRIC"
resp.tax_registration.sector #=> String, one of "Business", "Individual", "Government"
resp.tax_registration.status #=> String, one of "Verified", "Pending", "Deleted", "Rejected"
resp.tax_registration.tax_document_metadatas #=> Array
resp.tax_registration.tax_document_metadatas[0].tax_document_access_token #=> String
resp.tax_registration.tax_document_metadatas[0].tax_document_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (String) —

    Your unique account identifier.

Returns:

See Also:



899
900
901
902
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 899

def get_tax_registration(params = {}, options = {})
  req = build_request(:get_tax_registration, params)
  req.send_request(options)
end

#get_tax_registration_document(params = {}) ⇒ Types::GetTaxRegistrationDocumentResponse

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

Examples:

Request syntax with placeholder values


resp = client.get_tax_registration_document({
  destination_s3_location: { # required
    bucket: "S3BucketName", # required
    prefix: "S3Prefix",
  },
  tax_document_metadata: { # required
    tax_document_access_token: "TaxDocumentAccessToken", # required
    tax_document_name: "TaxDocumentName", # required
  },
})

Response structure


resp.destination_file_path #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



939
940
941
942
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 939

def get_tax_registration_document(params = {}, options = {})
  req = build_request(:get_tax_registration_document, params)
  req.send_request(options)
end

#list_supplemental_tax_registrations(params = {}) ⇒ Types::ListSupplementalTaxRegistrationsResponse

Retrieves supplemental tax registrations for a single account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_supplemental_tax_registrations({
  max_results: 1,
  next_token: "PaginationTokenString",
})

Response structure


resp.next_token #=> String
resp.tax_registrations #=> Array
resp.tax_registrations[0].address.address_line_1 #=> String
resp.tax_registrations[0].address.address_line_2 #=> String
resp.tax_registrations[0].address.address_line_3 #=> String
resp.tax_registrations[0].address.city #=> String
resp.tax_registrations[0].address.country_code #=> String
resp.tax_registrations[0].address.district_or_county #=> String
resp.tax_registrations[0].address.postal_code #=> String
resp.tax_registrations[0].address.state_or_region #=> String
resp.tax_registrations[0].authority_id #=> String
resp.tax_registrations[0].legal_name #=> String
resp.tax_registrations[0].registration_id #=> String
resp.tax_registrations[0].registration_type #=> String, one of "VAT"
resp.tax_registrations[0].status #=> String, one of "Verified", "Pending", "Deleted", "Rejected"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The number of taxRegistrations results you want in one response.

  • :next_token (String) —

    The token to retrieve the next set of results.

Returns:

See Also:



988
989
990
991
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 988

def list_supplemental_tax_registrations(params = {}, options = {})
  req = build_request(:list_supplemental_tax_registrations, params)
  req.send_request(options)
end

#list_tax_registrations(params = {}) ⇒ Types::ListTaxRegistrationsResponse

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).

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_tax_registrations({
  max_results: 1,
  next_token: "PaginationTokenString",
})

Response structure


resp. #=> Array
resp.[0]. #=> String
resp.[0].. #=> String
resp.[0]..address.address_line_1 #=> String
resp.[0]..address.address_line_2 #=> String
resp.[0]..address.address_line_3 #=> String
resp.[0]..address.city #=> String
resp.[0]..address.country_code #=> String
resp.[0]..address.district_or_county #=> String
resp.[0]..address.postal_code #=> String
resp.[0]..address.state_or_region #=> String
resp.[0]..address_role_map #=> Hash
resp.[0]..address_role_map["AddressRoleType"].country_code #=> String
resp.[0]..address_role_map["AddressRoleType"].state_or_region #=> String
resp.[0]..address_type #=> String, one of "TaxAddress", "BillingAddress", "ContactAddress"
resp.[0]..seller #=> String
resp.[0].tax_inheritance_details.inheritance_obtained_reason #=> String
resp.[0].tax_inheritance_details.parent_entity_id #=> String
resp.[0].tax_registration.additional_tax_information.brazil_additional_info.ccm_code #=> String
resp.[0].tax_registration.additional_tax_information.brazil_additional_info.legal_nature_code #=> String
resp.[0].tax_registration.additional_tax_information.canada_additional_info.canada_quebec_sales_tax_number #=> String
resp.[0].tax_registration.additional_tax_information.canada_additional_info.canada_retail_sales_tax_number #=> String
resp.[0].tax_registration.additional_tax_information.canada_additional_info. #=> Boolean
resp.[0].tax_registration.additional_tax_information.canada_additional_info.provincial_sales_tax_id #=> String
resp.[0].tax_registration.additional_tax_information.estonia_additional_info.registry_commercial_code #=> String
resp.[0].tax_registration.additional_tax_information.georgia_additional_info.person_type #=> String, one of "Legal Person", "Physical Person", "Business"
resp.[0].tax_registration.additional_tax_information.india_additional_info.pan #=> String
resp.[0].tax_registration.additional_tax_information.israel_additional_info.customer_type #=> String, one of "Business", "Individual"
resp.[0].tax_registration.additional_tax_information.israel_additional_info.dealer_type #=> String, one of "Authorized", "Non-authorized"
resp.[0].tax_registration.additional_tax_information.italy_additional_info.cig_number #=> String
resp.[0].tax_registration.additional_tax_information.italy_additional_info.cup_number #=> String
resp.[0].tax_registration.additional_tax_information.italy_additional_info. #=> String
resp.[0].tax_registration.additional_tax_information.italy_additional_info.tax_code #=> String
resp.[0].tax_registration.additional_tax_information.kenya_additional_info.person_type #=> String, one of "Legal Person", "Physical Person", "Business"
resp.[0].tax_registration.additional_tax_information.malaysia_additional_info.business_registration_number #=> String
resp.[0].tax_registration.additional_tax_information.malaysia_additional_info.service_tax_codes #=> Array
resp.[0].tax_registration.additional_tax_information.malaysia_additional_info.service_tax_codes[0] #=> String, one of "Consultancy", "Digital Service And Electronic Medium", "IT Services", "Training Or Coaching"
resp.[0].tax_registration.additional_tax_information.malaysia_additional_info.tax_information_number #=> String
resp.[0].tax_registration.additional_tax_information.poland_additional_info.individual_registration_number #=> String
resp.[0].tax_registration.additional_tax_information.poland_additional_info.is_group_vat_enabled #=> Boolean
resp.[0].tax_registration.additional_tax_information.romania_additional_info.tax_registration_number_type #=> String, one of "TaxRegistrationNumber", "LocalRegistrationNumber"
resp.[0].tax_registration.additional_tax_information.saudi_arabia_additional_info.tax_registration_number_type #=> String, one of "TaxRegistrationNumber", "TaxIdentificationNumber", "CommercialRegistrationNumber"
resp.[0].tax_registration.additional_tax_information.south_korea_additional_info.business_representative_name #=> String
resp.[0].tax_registration.additional_tax_information.south_korea_additional_info.item_of_business #=> String
resp.[0].tax_registration.additional_tax_information.south_korea_additional_info.line_of_business #=> String
resp.[0].tax_registration.additional_tax_information.spain_additional_info.registration_type #=> String, one of "Intra-EU", "Local"
resp.[0].tax_registration.additional_tax_information.turkey_additional_info.industries #=> String, one of "CirculatingOrg", "ProfessionalOrg", "Banks", "Insurance", "PensionAndBenefitFunds", "DevelopmentAgencies"
resp.[0].tax_registration.additional_tax_information.turkey_additional_info.kep_email_id #=> String
resp.[0].tax_registration.additional_tax_information.turkey_additional_info.secondary_tax_id #=> String
resp.[0].tax_registration.additional_tax_information.turkey_additional_info.tax_office #=> String
resp.[0].tax_registration.additional_tax_information.ukraine_additional_info.ukraine_trn_type #=> String, one of "Business", "Individual"
resp.[0].tax_registration.certified_email_id #=> String
resp.[0].tax_registration.jurisdiction.country_code #=> String
resp.[0].tax_registration.jurisdiction.state_or_region #=> String
resp.[0].tax_registration.legal_name #=> String
resp.[0].tax_registration.registration_id #=> String
resp.[0].tax_registration.registration_type #=> String, one of "VAT", "GST", "CPF", "CNPJ", "SST", "TIN", "NRIC"
resp.[0].tax_registration.sector #=> String, one of "Business", "Individual", "Government"
resp.[0].tax_registration.status #=> String, one of "Verified", "Pending", "Deleted", "Rejected"
resp.[0].tax_registration.tax_document_metadatas #=> Array
resp.[0].tax_registration.tax_document_metadatas[0].tax_document_access_token #=> String
resp.[0].tax_registration.tax_document_metadatas[0].tax_document_name #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Number of accountDetails results you want in one response.

  • :next_token (String) —

    The token to retrieve the next set of results.

Returns:

See Also:



1087
1088
1089
1090
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 1087

def list_tax_registrations(params = {}, options = {})
  req = build_request(:list_tax_registrations, params)
  req.send_request(options)
end

#put_supplemental_tax_registration(params = {}) ⇒ Types::PutSupplementalTaxRegistrationResponse

Stores supplemental tax registration for a single account.

Examples:

Request syntax with placeholder values


resp = client.put_supplemental_tax_registration({
  tax_registration_entry: { # required
    address: { # required
      address_line_1: "AddressLine1", # required
      address_line_2: "AddressLine2",
      address_line_3: "AddressLine3",
      city: "City", # required
      country_code: "CountryCode", # required
      district_or_county: "District",
      postal_code: "PostalCode", # required
      state_or_region: "State",
    },
    legal_name: "LegalName", # required
    registration_id: "RegistrationId", # required
    registration_type: "VAT", # required, accepts VAT
  },
})

Response structure


resp.authority_id #=> String
resp.status #=> String, one of "Verified", "Pending", "Deleted", "Rejected"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

Returns:

See Also:



1132
1133
1134
1135
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 1132

def put_supplemental_tax_registration(params = {}, options = {})
  req = build_request(:put_supplemental_tax_registration, params)
  req.send_request(options)
end

#put_tax_registration(params = {}) ⇒ Types::PutTaxRegistrationResponse

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 taxRegistrationDocuments field of the VerificationDetails object.

^

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 personType values are Physical Person and Business.

^

Kenya

  • You must specify the personType in the kenyaAdditionalInfo field of the additionalTaxInformation object.

  • If the personType is Physical Person, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Malaysia

  • The sector valid values are Business and Individual.

  • RegistrationType valid values are NRIC for individual, and TIN and sales and service tax (SST) for Business.

  • For individual, you can specify the taxInformationNumber in MalaysiaAdditionalInfo with NRIC type, and a valid MyKad or NRIC number.

  • For business, you must specify a businessRegistrationNumber in MalaysiaAdditionalInfo with a TIN type and tax identification number.

  • For business resellers, you must specify a businessRegistrationNumber and taxInformationNumber in MalaysiaAdditionalInfo with a sales and service tax (SST) type and a valid SST number.

  • For business resellers with service codes, you must specify businessRegistrationNumber, taxInformationNumber, and distinct serviceTaxCodes in MalaysiaAdditionalInfo with 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 Business and Individual.

^

Saudi Arabia

  • For address, you must specify addressLine3.

^

South Korea

  • You must specify the certifiedEmailId and legalName in the TaxRegistrationEntry object. Use Korean characters for legalName.

  • You must specify the businessRepresentativeName, itemOfBusiness, and lineOfBusiness in the southKoreaAdditionalInfo field of the additionalTaxInformation object. Use Korean characters for these fields.

  • You must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

  • For the address object, use Korean characters for addressLine1, addressLine2 city, postalCode, and stateOrRegion.

Spain

  • You must specify the registrationType in the spainAdditionalInfo field of the additionalTaxInformation object.

  • If the registrationType is Local, you must specify the tax registration certificate document in the taxRegistrationDocuments field of the VerificationDetails object.

Turkey

  • You must specify the sector in the taxRegistrationEntry object.

  • If your sector is Business, Individual, or Government:

    • Specify the taxOffice. If your sector is Individual, don't enter this value.

    • (Optional) Specify the kepEmailId. If your sector is Individual, don't enter this value.

    • Note: In the Tax Settings page of the Billing console, Government appears as Public institutions

  • If your sector is Business and you're subject to KDV tax, you must specify your industry in the industries field.

  • For address, you must specify districtOrCounty.

Ukraine

  • The sector valid values are Business and Individual.

^

Examples:

Request syntax with placeholder values


resp = client.put_tax_registration({
  account_id: "AccountId",
  tax_registration_entry: { # required
    additional_tax_information: {
      canada_additional_info: {
        canada_quebec_sales_tax_number: "CanadaQuebecSalesTaxNumberString",
        canada_retail_sales_tax_number: "CanadaRetailSalesTaxNumberString",
        is_reseller_account: false,
        provincial_sales_tax_id: "CanadaProvincialSalesTaxIdString",
      },
      estonia_additional_info: {
        registry_commercial_code: "RegistryCommercialCode", # required
      },
      georgia_additional_info: {
        person_type: "Legal Person", # required, accepts Legal Person, Physical Person, Business
      },
      israel_additional_info: {
        customer_type: "Business", # required, accepts Business, Individual
        dealer_type: "Authorized", # required, accepts Authorized, Non-authorized
      },
      italy_additional_info: {
        cig_number: "CigNumber",
        cup_number: "CupNumber",
        sdi_account_id: "SdiAccountId",
        tax_code: "TaxCode",
      },
      kenya_additional_info: {
        person_type: "Legal Person", # required, accepts Legal Person, Physical Person, Business
      },
      malaysia_additional_info: {
        business_registration_number: "BusinessRegistrationNumber",
        service_tax_codes: ["Consultancy"], # accepts Consultancy, Digital Service And Electronic Medium, IT Services, Training Or Coaching
        tax_information_number: "TaxInformationNumber",
      },
      poland_additional_info: {
        individual_registration_number: "IndividualRegistrationNumber",
        is_group_vat_enabled: false,
      },
      romania_additional_info: {
        tax_registration_number_type: "TaxRegistrationNumber", # required, accepts TaxRegistrationNumber, LocalRegistrationNumber
      },
      saudi_arabia_additional_info: {
        tax_registration_number_type: "TaxRegistrationNumber", # accepts TaxRegistrationNumber, TaxIdentificationNumber, CommercialRegistrationNumber
      },
      south_korea_additional_info: {
        business_representative_name: "BusinessRepresentativeName", # required
        item_of_business: "ItemOfBusiness", # required
        line_of_business: "LineOfBusiness", # required
      },
      spain_additional_info: {
        registration_type: "Intra-EU", # required, accepts Intra-EU, Local
      },
      turkey_additional_info: {
        industries: "CirculatingOrg", # accepts CirculatingOrg, ProfessionalOrg, Banks, Insurance, PensionAndBenefitFunds, DevelopmentAgencies
        kep_email_id: "KepEmailId",
        secondary_tax_id: "SecondaryTaxId",
        tax_office: "TaxOffice",
      },
      ukraine_additional_info: {
        ukraine_trn_type: "Business", # required, accepts Business, Individual
      },
    },
    certified_email_id: "CertifiedEmailId",
    legal_address: {
      address_line_1: "AddressLine1", # required
      address_line_2: "AddressLine2",
      address_line_3: "AddressLine3",
      city: "City", # required
      country_code: "CountryCode", # required
      district_or_county: "District",
      postal_code: "PostalCode", # required
      state_or_region: "State",
    },
    legal_name: "LegalName",
    registration_id: "RegistrationId", # required
    registration_type: "VAT", # required, accepts VAT, GST, CPF, CNPJ, SST, TIN, NRIC
    sector: "Business", # accepts Business, Individual, Government
    verification_details: {
      date_of_birth: "DateOfBirth",
      tax_registration_documents: [
        {
          s3_location: { # required
            bucket: "S3BucketName", # required
            key: "S3Key", # required
          },
        },
      ],
    },
  },
})

Response structure


resp.status #=> String, one of "Verified", "Pending", "Deleted", "Rejected"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :account_id (String) —

    Your unique account identifier.

  • :tax_registration_entry (required, Types::TaxRegistrationEntry) —

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

Returns:

See Also:



1404
1405
1406
1407
 
# File 'gems/aws-sdk-taxsettings/lib/aws-sdk-taxsettings/client.rb', line 1404

def put_tax_registration(params = {}, options = {})
  req = build_request(:put_tax_registration, params)
  req.send_request(options)
end