Get the active tax exemptions for a given list of accounts. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TaxSettingsClient, BatchGetTaxExemptionsCommand } from "@aws-sdk/client-taxsettings"; // ES Modules import + * // const { TaxSettingsClient, BatchGetTaxExemptionsCommand } = require("@aws-sdk/client-taxsettings"); // CommonJS import + * const client = new TaxSettingsClient(config); + * const input = { // BatchGetTaxExemptionsRequest + * accountIds: [ // AccountIds // required + * "STRING_VALUE", + * ], + * }; + * const command = new BatchGetTaxExemptionsCommand(input); + * const response = await client.send(command); + * // { // BatchGetTaxExemptionsResponse + * // taxExemptionDetailsMap: { // TaxExemptionDetailsMap + * // "The exception thrown when an unexpected error occurs when processing a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The exception thrown when the input doesn't have a resource associated to it.
+ * + * @throws {@link ValidationException} (client fault) + *The exception when the input doesn't pass validation for at least one of the input + * parameters.
+ * + * @throws {@link TaxSettingsServiceException} + *Base exception class for all service exceptions from TaxSettings service.
+ * + * @public + */ +export class BatchGetTaxExemptionsCommand extends $Command + .classBuilder< + BatchGetTaxExemptionsCommandInput, + BatchGetTaxExemptionsCommandOutput, + TaxSettingsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: TaxSettingsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("TaxSettings", "BatchGetTaxExemptions", {}) + .n("TaxSettingsClient", "BatchGetTaxExemptionsCommand") + .f(void 0, void 0) + .ser(se_BatchGetTaxExemptionsCommand) + .de(de_BatchGetTaxExemptionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: BatchGetTaxExemptionsRequest; + output: BatchGetTaxExemptionsResponse; + }; + sdk: { + input: BatchGetTaxExemptionsCommandInput; + output: BatchGetTaxExemptionsCommandOutput; + }; + }; +} diff --git a/clients/client-taxsettings/src/commands/BatchPutTaxRegistrationCommand.ts b/clients/client-taxsettings/src/commands/BatchPutTaxRegistrationCommand.ts index eac46f78919f7..1c4084addd7ec 100644 --- a/clients/client-taxsettings/src/commands/BatchPutTaxRegistrationCommand.ts +++ b/clients/client-taxsettings/src/commands/BatchPutTaxRegistrationCommand.ts @@ -310,6 +310,10 @@ export interface BatchPutTaxRegistrationCommandOutput extends BatchPutTaxRegistr * bucket: "STRING_VALUE", // required * key: "STRING_VALUE", // required * }, + * file: { // TaxRegistrationDocFile + * fileName: "STRING_VALUE", // required + * fileContent: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required + * }, * }, * ], * }, diff --git a/clients/client-taxsettings/src/commands/GetTaxExemptionTypesCommand.ts b/clients/client-taxsettings/src/commands/GetTaxExemptionTypesCommand.ts new file mode 100644 index 0000000000000..da0c9d884a664 --- /dev/null +++ b/clients/client-taxsettings/src/commands/GetTaxExemptionTypesCommand.ts @@ -0,0 +1,112 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetTaxExemptionTypesRequest, GetTaxExemptionTypesResponse } from "../models/models_0"; +import { de_GetTaxExemptionTypesCommand, se_GetTaxExemptionTypesCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, TaxSettingsClientResolvedConfig } from "../TaxSettingsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetTaxExemptionTypesCommand}. + */ +export interface GetTaxExemptionTypesCommandInput extends GetTaxExemptionTypesRequest {} +/** + * @public + * + * The output of {@link GetTaxExemptionTypesCommand}. + */ +export interface GetTaxExemptionTypesCommandOutput extends GetTaxExemptionTypesResponse, __MetadataBearer {} + +/** + *Get supported tax exemption types. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TaxSettingsClient, GetTaxExemptionTypesCommand } from "@aws-sdk/client-taxsettings"; // ES Modules import + * // const { TaxSettingsClient, GetTaxExemptionTypesCommand } = require("@aws-sdk/client-taxsettings"); // CommonJS import + * const client = new TaxSettingsClient(config); + * const input = {}; + * const command = new GetTaxExemptionTypesCommand(input); + * const response = await client.send(command); + * // { // GetTaxExemptionTypesResponse + * // taxExemptionTypes: [ // TaxExemptionTypes + * // { // TaxExemptionType + * // displayName: "STRING_VALUE", + * // description: "STRING_VALUE", + * // applicableJurisdictions: [ // Authorities + * // { // Authority + * // country: "STRING_VALUE", // required + * // state: "STRING_VALUE", + * // }, + * // ], + * // }, + * // ], + * // }; + * + * ``` + * + * @param GetTaxExemptionTypesCommandInput - {@link GetTaxExemptionTypesCommandInput} + * @returns {@link GetTaxExemptionTypesCommandOutput} + * @see {@link GetTaxExemptionTypesCommandInput} for command's `input` shape. + * @see {@link GetTaxExemptionTypesCommandOutput} for command's `response` shape. + * @see {@link TaxSettingsClientResolvedConfig | config} for TaxSettingsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *The exception thrown when an unexpected error occurs when processing a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The exception thrown when the input doesn't have a resource associated to it.
+ * + * @throws {@link ValidationException} (client fault) + *The exception when the input doesn't pass validation for at least one of the input + * parameters.
+ * + * @throws {@link TaxSettingsServiceException} + *Base exception class for all service exceptions from TaxSettings service.
+ * + * @public + */ +export class GetTaxExemptionTypesCommand extends $Command + .classBuilder< + GetTaxExemptionTypesCommandInput, + GetTaxExemptionTypesCommandOutput, + TaxSettingsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: TaxSettingsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("TaxSettings", "GetTaxExemptionTypes", {}) + .n("TaxSettingsClient", "GetTaxExemptionTypesCommand") + .f(void 0, void 0) + .ser(se_GetTaxExemptionTypesCommand) + .de(de_GetTaxExemptionTypesCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: {}; + output: GetTaxExemptionTypesResponse; + }; + sdk: { + input: GetTaxExemptionTypesCommandInput; + output: GetTaxExemptionTypesCommandOutput; + }; + }; +} diff --git a/clients/client-taxsettings/src/commands/GetTaxInheritanceCommand.ts b/clients/client-taxsettings/src/commands/GetTaxInheritanceCommand.ts new file mode 100644 index 0000000000000..479d4433bd27f --- /dev/null +++ b/clients/client-taxsettings/src/commands/GetTaxInheritanceCommand.ts @@ -0,0 +1,101 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { GetTaxInheritanceRequest, GetTaxInheritanceResponse } from "../models/models_0"; +import { de_GetTaxInheritanceCommand, se_GetTaxInheritanceCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, TaxSettingsClientResolvedConfig } from "../TaxSettingsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetTaxInheritanceCommand}. + */ +export interface GetTaxInheritanceCommandInput extends GetTaxInheritanceRequest {} +/** + * @public + * + * The output of {@link GetTaxInheritanceCommand}. + */ +export interface GetTaxInheritanceCommandOutput extends GetTaxInheritanceResponse, __MetadataBearer {} + +/** + *The get account tax inheritance status. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TaxSettingsClient, GetTaxInheritanceCommand } from "@aws-sdk/client-taxsettings"; // ES Modules import + * // const { TaxSettingsClient, GetTaxInheritanceCommand } = require("@aws-sdk/client-taxsettings"); // CommonJS import + * const client = new TaxSettingsClient(config); + * const input = {}; + * const command = new GetTaxInheritanceCommand(input); + * const response = await client.send(command); + * // { // GetTaxInheritanceResponse + * // heritageStatus: "OptIn" || "OptOut", + * // }; + * + * ``` + * + * @param GetTaxInheritanceCommandInput - {@link GetTaxInheritanceCommandInput} + * @returns {@link GetTaxInheritanceCommandOutput} + * @see {@link GetTaxInheritanceCommandInput} for command's `input` shape. + * @see {@link GetTaxInheritanceCommandOutput} for command's `response` shape. + * @see {@link TaxSettingsClientResolvedConfig | config} for TaxSettingsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *The exception thrown when an unexpected error occurs when processing a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The exception thrown when the input doesn't have a resource associated to it.
+ * + * @throws {@link ValidationException} (client fault) + *The exception when the input doesn't pass validation for at least one of the input + * parameters.
+ * + * @throws {@link TaxSettingsServiceException} + *Base exception class for all service exceptions from TaxSettings service.
+ * + * @public + */ +export class GetTaxInheritanceCommand extends $Command + .classBuilder< + GetTaxInheritanceCommandInput, + GetTaxInheritanceCommandOutput, + TaxSettingsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: TaxSettingsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("TaxSettings", "GetTaxInheritance", {}) + .n("TaxSettingsClient", "GetTaxInheritanceCommand") + .f(void 0, void 0) + .ser(se_GetTaxInheritanceCommand) + .de(de_GetTaxInheritanceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: {}; + output: GetTaxInheritanceResponse; + }; + sdk: { + input: GetTaxInheritanceCommandInput; + output: GetTaxInheritanceCommandOutput; + }; + }; +} diff --git a/clients/client-taxsettings/src/commands/GetTaxRegistrationDocumentCommand.ts b/clients/client-taxsettings/src/commands/GetTaxRegistrationDocumentCommand.ts index f523fbf3229d0..9c88ac73e135d 100644 --- a/clients/client-taxsettings/src/commands/GetTaxRegistrationDocumentCommand.ts +++ b/clients/client-taxsettings/src/commands/GetTaxRegistrationDocumentCommand.ts @@ -50,6 +50,7 @@ export interface GetTaxRegistrationDocumentCommandOutput extends GetTaxRegistrat * const response = await client.send(command); * // { // GetTaxRegistrationDocumentResponse * // destinationFilePath: "STRING_VALUE", + * // presignedS3Url: "STRING_VALUE", * // }; * * ``` diff --git a/clients/client-taxsettings/src/commands/ListTaxExemptionsCommand.ts b/clients/client-taxsettings/src/commands/ListTaxExemptionsCommand.ts new file mode 100644 index 0000000000000..ad552066939d8 --- /dev/null +++ b/clients/client-taxsettings/src/commands/ListTaxExemptionsCommand.ts @@ -0,0 +1,133 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { ListTaxExemptionsRequest, ListTaxExemptionsResponse } from "../models/models_0"; +import { de_ListTaxExemptionsCommand, se_ListTaxExemptionsCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, TaxSettingsClientResolvedConfig } from "../TaxSettingsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTaxExemptionsCommand}. + */ +export interface ListTaxExemptionsCommandInput extends ListTaxExemptionsRequest {} +/** + * @public + * + * The output of {@link ListTaxExemptionsCommand}. + */ +export interface ListTaxExemptionsCommandOutput extends ListTaxExemptionsResponse, __MetadataBearer {} + +/** + *Retrieves the tax exemption of accounts listed in a consolidated billing family. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TaxSettingsClient, ListTaxExemptionsCommand } from "@aws-sdk/client-taxsettings"; // ES Modules import + * // const { TaxSettingsClient, ListTaxExemptionsCommand } = require("@aws-sdk/client-taxsettings"); // CommonJS import + * const client = new TaxSettingsClient(config); + * const input = { // ListTaxExemptionsRequest + * maxResults: Number("int"), + * nextToken: "STRING_VALUE", + * }; + * const command = new ListTaxExemptionsCommand(input); + * const response = await client.send(command); + * // { // ListTaxExemptionsResponse + * // nextToken: "STRING_VALUE", + * // taxExemptionDetailsMap: { // TaxExemptionDetailsMap + * // "The exception thrown when an unexpected error occurs when processing a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The exception thrown when the input doesn't have a resource associated to it.
+ * + * @throws {@link ValidationException} (client fault) + *The exception when the input doesn't pass validation for at least one of the input + * parameters.
+ * + * @throws {@link TaxSettingsServiceException} + *Base exception class for all service exceptions from TaxSettings service.
+ * + * @public + */ +export class ListTaxExemptionsCommand extends $Command + .classBuilder< + ListTaxExemptionsCommandInput, + ListTaxExemptionsCommandOutput, + TaxSettingsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: TaxSettingsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("TaxSettings", "ListTaxExemptions", {}) + .n("TaxSettingsClient", "ListTaxExemptionsCommand") + .f(void 0, void 0) + .ser(se_ListTaxExemptionsCommand) + .de(de_ListTaxExemptionsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTaxExemptionsRequest; + output: ListTaxExemptionsResponse; + }; + sdk: { + input: ListTaxExemptionsCommandInput; + output: ListTaxExemptionsCommandOutput; + }; + }; +} diff --git a/clients/client-taxsettings/src/commands/PutTaxExemptionCommand.ts b/clients/client-taxsettings/src/commands/PutTaxExemptionCommand.ts new file mode 100644 index 0000000000000..acef5ddb0d531 --- /dev/null +++ b/clients/client-taxsettings/src/commands/PutTaxExemptionCommand.ts @@ -0,0 +1,126 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutTaxExemptionRequest, PutTaxExemptionResponse } from "../models/models_0"; +import { de_PutTaxExemptionCommand, se_PutTaxExemptionCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, TaxSettingsClientResolvedConfig } from "../TaxSettingsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutTaxExemptionCommand}. + */ +export interface PutTaxExemptionCommandInput extends PutTaxExemptionRequest {} +/** + * @public + * + * The output of {@link PutTaxExemptionCommand}. + */ +export interface PutTaxExemptionCommandOutput extends PutTaxExemptionResponse, __MetadataBearer {} + +/** + *Adds the tax exemption for a single account or all accounts listed in a consolidated billing family. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TaxSettingsClient, PutTaxExemptionCommand } from "@aws-sdk/client-taxsettings"; // ES Modules import + * // const { TaxSettingsClient, PutTaxExemptionCommand } = require("@aws-sdk/client-taxsettings"); // CommonJS import + * const client = new TaxSettingsClient(config); + * const input = { // PutTaxExemptionRequest + * accountIds: [ // AccountIds // required + * "STRING_VALUE", + * ], + * authority: { // Authority + * country: "STRING_VALUE", // required + * state: "STRING_VALUE", + * }, + * exemptionType: "STRING_VALUE", // required + * exemptionCertificate: { // ExemptionCertificate + * documentName: "STRING_VALUE", // required + * documentFile: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required + * }, + * }; + * const command = new PutTaxExemptionCommand(input); + * const response = await client.send(command); + * // { // PutTaxExemptionResponse + * // caseId: "STRING_VALUE", + * // }; + * + * ``` + * + * @param PutTaxExemptionCommandInput - {@link PutTaxExemptionCommandInput} + * @returns {@link PutTaxExemptionCommandOutput} + * @see {@link PutTaxExemptionCommandInput} for command's `input` shape. + * @see {@link PutTaxExemptionCommandOutput} for command's `response` shape. + * @see {@link TaxSettingsClientResolvedConfig | config} for TaxSettingsClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *The access is denied for the Amazon Web Services Support API. + *
+ * + * @throws {@link AttachmentUploadException} (client fault) + *Failed to upload the tax exemption document to Amazon Web Services Support case. + *
+ * + * @throws {@link CaseCreationLimitExceededException} (client fault) + *You've exceeded the Amazon Web Services Support case creation limit for your account. + *
+ * + * @throws {@link InternalServerException} (server fault) + *The exception thrown when an unexpected error occurs when processing a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The exception thrown when the input doesn't have a resource associated to it.
+ * + * @throws {@link ValidationException} (client fault) + *The exception when the input doesn't pass validation for at least one of the input + * parameters.
+ * + * @throws {@link TaxSettingsServiceException} + *Base exception class for all service exceptions from TaxSettings service.
+ * + * @public + */ +export class PutTaxExemptionCommand extends $Command + .classBuilder< + PutTaxExemptionCommandInput, + PutTaxExemptionCommandOutput, + TaxSettingsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: TaxSettingsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("TaxSettings", "PutTaxExemption", {}) + .n("TaxSettingsClient", "PutTaxExemptionCommand") + .f(void 0, void 0) + .ser(se_PutTaxExemptionCommand) + .de(de_PutTaxExemptionCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutTaxExemptionRequest; + output: PutTaxExemptionResponse; + }; + sdk: { + input: PutTaxExemptionCommandInput; + output: PutTaxExemptionCommandOutput; + }; + }; +} diff --git a/clients/client-taxsettings/src/commands/PutTaxInheritanceCommand.ts b/clients/client-taxsettings/src/commands/PutTaxInheritanceCommand.ts new file mode 100644 index 0000000000000..ba9807a6b5dfb --- /dev/null +++ b/clients/client-taxsettings/src/commands/PutTaxInheritanceCommand.ts @@ -0,0 +1,104 @@ +// smithy-typescript generated code +import { getEndpointPlugin } from "@smithy/middleware-endpoint"; +import { getSerdePlugin } from "@smithy/middleware-serde"; +import { Command as $Command } from "@smithy/smithy-client"; +import { MetadataBearer as __MetadataBearer } from "@smithy/types"; + +import { commonParams } from "../endpoint/EndpointParameters"; +import { PutTaxInheritanceRequest, PutTaxInheritanceResponse } from "../models/models_0"; +import { de_PutTaxInheritanceCommand, se_PutTaxInheritanceCommand } from "../protocols/Aws_restJson1"; +import { ServiceInputTypes, ServiceOutputTypes, TaxSettingsClientResolvedConfig } from "../TaxSettingsClient"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link PutTaxInheritanceCommand}. + */ +export interface PutTaxInheritanceCommandInput extends PutTaxInheritanceRequest {} +/** + * @public + * + * The output of {@link PutTaxInheritanceCommand}. + */ +export interface PutTaxInheritanceCommandOutput extends PutTaxInheritanceResponse, __MetadataBearer {} + +/** + *The updated tax inheritance status. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { TaxSettingsClient, PutTaxInheritanceCommand } from "@aws-sdk/client-taxsettings"; // ES Modules import + * // const { TaxSettingsClient, PutTaxInheritanceCommand } = require("@aws-sdk/client-taxsettings"); // CommonJS import + * const client = new TaxSettingsClient(config); + * const input = { // PutTaxInheritanceRequest + * heritageStatus: "OptIn" || "OptOut", + * }; + * const command = new PutTaxInheritanceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param PutTaxInheritanceCommandInput - {@link PutTaxInheritanceCommandInput} + * @returns {@link PutTaxInheritanceCommandOutput} + * @see {@link PutTaxInheritanceCommandInput} for command's `input` shape. + * @see {@link PutTaxInheritanceCommandOutput} for command's `response` shape. + * @see {@link TaxSettingsClientResolvedConfig | config} for TaxSettingsClient's `config` shape. + * + * @throws {@link ConflictException} (client fault) + *The exception when the input is creating conflict with the given state.
+ * + * @throws {@link InternalServerException} (server fault) + *The exception thrown when an unexpected error occurs when processing a request.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The exception thrown when the input doesn't have a resource associated to it.
+ * + * @throws {@link ValidationException} (client fault) + *The exception when the input doesn't pass validation for at least one of the input + * parameters.
+ * + * @throws {@link TaxSettingsServiceException} + *Base exception class for all service exceptions from TaxSettings service.
+ * + * @public + */ +export class PutTaxInheritanceCommand extends $Command + .classBuilder< + PutTaxInheritanceCommandInput, + PutTaxInheritanceCommandOutput, + TaxSettingsClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: TaxSettingsClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("TaxSettings", "PutTaxInheritance", {}) + .n("TaxSettingsClient", "PutTaxInheritanceCommand") + .f(void 0, void 0) + .ser(se_PutTaxInheritanceCommand) + .de(de_PutTaxInheritanceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: PutTaxInheritanceRequest; + output: {}; + }; + sdk: { + input: PutTaxInheritanceCommandInput; + output: PutTaxInheritanceCommandOutput; + }; + }; +} diff --git a/clients/client-taxsettings/src/commands/PutTaxRegistrationCommand.ts b/clients/client-taxsettings/src/commands/PutTaxRegistrationCommand.ts index 4305cea3e92c2..c967745ff9f33 100644 --- a/clients/client-taxsettings/src/commands/PutTaxRegistrationCommand.ts +++ b/clients/client-taxsettings/src/commands/PutTaxRegistrationCommand.ts @@ -306,6 +306,10 @@ export interface PutTaxRegistrationCommandOutput extends PutTaxRegistrationRespo * bucket: "STRING_VALUE", // required * key: "STRING_VALUE", // required * }, + * file: { // TaxRegistrationDocFile + * fileName: "STRING_VALUE", // required + * fileContent: new Uint8Array(), // e.g. Buffer.from("") or new TextEncoder().encode("") // required + * }, * }, * ], * }, diff --git a/clients/client-taxsettings/src/commands/index.ts b/clients/client-taxsettings/src/commands/index.ts index e367309417d0d..b34bf6344b33e 100644 --- a/clients/client-taxsettings/src/commands/index.ts +++ b/clients/client-taxsettings/src/commands/index.ts @@ -1,11 +1,17 @@ // smithy-typescript generated code export * from "./BatchDeleteTaxRegistrationCommand"; +export * from "./BatchGetTaxExemptionsCommand"; export * from "./BatchPutTaxRegistrationCommand"; export * from "./DeleteSupplementalTaxRegistrationCommand"; export * from "./DeleteTaxRegistrationCommand"; +export * from "./GetTaxExemptionTypesCommand"; +export * from "./GetTaxInheritanceCommand"; export * from "./GetTaxRegistrationCommand"; export * from "./GetTaxRegistrationDocumentCommand"; export * from "./ListSupplementalTaxRegistrationsCommand"; +export * from "./ListTaxExemptionsCommand"; export * from "./ListTaxRegistrationsCommand"; export * from "./PutSupplementalTaxRegistrationCommand"; +export * from "./PutTaxExemptionCommand"; +export * from "./PutTaxInheritanceCommand"; export * from "./PutTaxRegistrationCommand"; diff --git a/clients/client-taxsettings/src/models/models_0.ts b/clients/client-taxsettings/src/models/models_0.ts index 0f2fcdaba7497..58c34a097909a 100644 --- a/clients/client-taxsettings/src/models/models_0.ts +++ b/clients/client-taxsettings/src/models/models_0.ts @@ -3,6 +3,27 @@ import { ExceptionOptionType as __ExceptionOptionType, SENSITIVE_STRING } from " import { TaxSettingsServiceException as __BaseException } from "./TaxSettingsServiceException"; +/** + *The access is denied for the Amazon Web Services Support API. + *
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe details of the address associated with the TRN information.
* @public @@ -1063,6 +1084,50 @@ export interface AdditionalInfoRequest { saudiArabiaAdditionalInfo?: SaudiArabiaAdditionalInfo | undefined; } +/** + *Failed to upload the tax exemption document to Amazon Web Services Support case. + *
+ * @public + */ +export class AttachmentUploadException extends __BaseException { + readonly name: "AttachmentUploadException" = "AttachmentUploadException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe address domain associate with the tax information. + *
+ * @public + */ +export interface Authority { + /** + *+ * The country code for the country that the address is in. + *
+ * @public + */ + country: string | undefined; + + /** + *+ * The state that the address is located. + *
+ * @public + */ + state?: string | undefined; +} + /** * @public */ @@ -1231,6 +1296,215 @@ export class ValidationException extends __BaseException { } } +/** + * @public + */ +export interface BatchGetTaxExemptionsRequest { + /** + *+ * List of unique account identifiers. + *
+ * @public + */ + accountIds: string[] | undefined; +} + +/** + * @public + * @enum + */ +export const EntityExemptionAccountStatus = { + Expired: "Expired", + None: "None", + Pending: "Pending", + Valid: "Valid", +} as const; + +/** + * @public + */ +export type EntityExemptionAccountStatus = + (typeof EntityExemptionAccountStatus)[keyof typeof EntityExemptionAccountStatus]; + +/** + *The tax exemption type. + *
+ * @public + */ +export interface TaxExemptionType { + /** + *The tax exemption's type display name. + *
+ * @public + */ + displayName?: string | undefined; + + /** + *The tax exemption's type description. + *
+ * @public + */ + description?: string | undefined; + + /** + *The tax exemption's applicable jurisdictions. + *
+ * @public + */ + applicableJurisdictions?: Authority[] | undefined; +} + +/** + *The tax exemption. + *
+ * @public + */ +export interface TaxExemption { + /** + *The address domain associate with tax exemption. + *
+ * @public + */ + authority: Authority | undefined; + + /** + *The tax exemption type. + *
+ * @public + */ + taxExemptionType: TaxExemptionType | undefined; + + /** + *The tax exemption effective date. + *
+ * @public + */ + effectiveDate?: Date | undefined; + + /** + *The tax exemption expiration date. + *
+ * @public + */ + expirationDate?: Date | undefined; + + /** + *The tax exemption recording time in the TaxSettings system.
+ *
The tax exemption status. + *
+ * @public + */ + status?: EntityExemptionAccountStatus | undefined; +} + +/** + *The tax exemption details. + *
+ * @public + */ +export interface TaxExemptionDetails { + /** + *Tax exemptions. + *
+ * @public + */ + taxExemptions?: TaxExemption[] | undefined; + + /** + *The indicator if the tax exemption is inherited from the consolidated billing family management account. + *
+ * @public + */ + heritageObtainedDetails?: boolean | undefined; + + /** + *The consolidated billing family management account the tax exemption inherited from. + *
+ * @public + */ + heritageObtainedParentEntity?: string | undefined; + + /** + *The reason of the heritage inheritance. + *
+ * @public + */ + heritageObtainedReason?: string | undefined; +} + +/** + * @public + */ +export interface BatchGetTaxExemptionsResponse { + /** + *The tax exemption details map of accountId and tax exemption details. + *
+ * @public + */ + taxExemptionDetailsMap?: RecordThe list of accounts that failed to get tax exemptions. + *
+ * @public + */ + failedAccounts?: string[] | undefined; +} + +/** + *The exception thrown when the input doesn't have a resource associated to it.
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + *404
+ * @public + */ + errorCode: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe tax registration document. + *
+ * @public + */ +export interface TaxRegistrationDocFile { + /** + *The tax registration document name. + *
+ * @public + */ + fileName: string | undefined; + + /** + *The tax registration document content. + *
+ * @public + */ + fileContent: Uint8Array | undefined; +} + /** *The Amazon S3 bucket in your account where your tax document is located.
* @public @@ -1258,7 +1532,14 @@ export interface TaxRegistrationDocument { *The Amazon S3 location where your tax registration document is stored.
* @public */ - s3Location: SourceS3Location | undefined; + s3Location?: SourceS3Location | undefined; + + /** + *The tax registration document. + *
+ * @public + */ + file?: TaxRegistrationDocFile | undefined; } /** @@ -1418,6 +1699,27 @@ export interface BatchPutTaxRegistrationResponse { errors: BatchPutTaxRegistrationError[] | undefined; } +/** + *You've exceeded the Amazon Web Services Support case creation limit for your account. + *
+ * @public + */ +export class CaseCreationLimitExceededException extends __BaseException { + readonly name: "CaseCreationLimitExceededException" = "CaseCreationLimitExceededException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe exception thrown when the input doesn't have a resource associated to it.
- * @public - */ -export class ResourceNotFoundException extends __BaseException { - readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; - readonly $fault: "client" = "client"; - /** - *404
- * @public - */ - errorCode: string | undefined; - - /** - * @internal - */ - constructor(opts: __ExceptionOptionTypeThe exemption certificate. + *
+ * @public + */ +export interface ExemptionCertificate { + /** + *The exemption certificate file name. + *
+ * @public + */ + documentName: string | undefined; + + /** + *The exemption certificate file content. + *
+ * @public + */ + documentFile: Uint8Array | undefined; +} + +/** + * @public + */ +export interface GetTaxExemptionTypesRequest {} + +/** + * @public + */ +export interface GetTaxExemptionTypesResponse { + /** + *The supported types of tax exemptions. + *
+ * @public + */ + taxExemptionTypes?: TaxExemptionType[] | undefined; +} + +/** + * @public + */ +export interface GetTaxInheritanceRequest {} + +/** + * @public + * @enum + */ +export const HeritageStatus = { + OptIn: "OptIn", + OptOut: "OptOut", +} as const; + +/** + * @public + */ +export type HeritageStatus = (typeof HeritageStatus)[keyof typeof HeritageStatus]; + +/** + * @public + */ +export interface GetTaxInheritanceResponse { + /** + *The tax inheritance status. + *
+ * @public + */ + heritageStatus?: HeritageStatus | undefined; +} + /** * @public */ @@ -1592,7 +1936,7 @@ export interface GetTaxRegistrationDocumentRequest { *The Amazon S3 bucket that you specify to download your tax documents to.
* @public */ - destinationS3Location: DestinationS3Location | undefined; + destinationS3Location?: DestinationS3Location | undefined; /** *The metadata for your tax document.
@@ -1610,6 +1954,13 @@ export interface GetTaxRegistrationDocumentResponse { * @public */ destinationFilePath?: string | undefined; + + /** + *The Amazon S3 presigned URL of the tax registration document. + *
+ * @public + */ + presignedS3Url?: string | undefined; } /** @@ -1722,6 +2073,42 @@ export interface ListSupplementalTaxRegistrationsResponse { nextToken?: string | undefined; } +/** + * @public + */ +export interface ListTaxExemptionsRequest { + /** + *The number of results you want in one response. + *
+ * @public + */ + maxResults?: number | undefined; + + /** + *The token to retrieve the next set of results.
+ * @public + */ + nextToken?: string | undefined; +} + +/** + * @public + */ +export interface ListTaxExemptionsResponse { + /** + *The token to retrieve the next set of results.
+ * @public + */ + nextToken?: string | undefined; + + /** + *The tax exemption details map of accountId and tax exemption details.
+ *
+ * The list of unique account identifiers. + *
+ * @public + */ + accountIds: string[] | undefined; + + /** + *The address domain associate with the tax information. + *
+ * @public + */ + authority: Authority | undefined; + + /** + *The exemption type. + *
+ * @public + */ + exemptionType: string | undefined; + + /** + *The exemption certificate. + *
+ * @public + */ + exemptionCertificate: ExemptionCertificate | undefined; +} + +/** + * @public + */ +export interface PutTaxExemptionResponse { + /** + *The customer support case ID. + *
+ * @public + */ + caseId?: string | undefined; +} + +/** + * @public + */ +export interface PutTaxInheritanceRequest { + /** + *The tax inheritance status. + *
+ * @public + */ + heritageStatus?: HeritageStatus | undefined; +} + +/** + * @public + */ +export interface PutTaxInheritanceResponse {} + /** * @public */ diff --git a/clients/client-taxsettings/src/pagination/ListTaxExemptionsPaginator.ts b/clients/client-taxsettings/src/pagination/ListTaxExemptionsPaginator.ts new file mode 100644 index 0000000000000..917b52f3584c0 --- /dev/null +++ b/clients/client-taxsettings/src/pagination/ListTaxExemptionsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListTaxExemptionsCommand, + ListTaxExemptionsCommandInput, + ListTaxExemptionsCommandOutput, +} from "../commands/ListTaxExemptionsCommand"; +import { TaxSettingsClient } from "../TaxSettingsClient"; +import { TaxSettingsPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListTaxExemptions: ( + config: TaxSettingsPaginationConfiguration, + input: ListTaxExemptionsCommandInput, + ...rest: any[] +) => PaginatorThe access is denied for the Amazon Web Services Support API.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, "com.amazonaws.taxsettings#AccountDetails": { "type": "structure", "members": { @@ -422,6 +438,49 @@ } } }, + "com.amazonaws.taxsettings#AttachmentUploadException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Failed to upload the tax exemption document to Amazon Web Services Support case.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.taxsettings#Authorities": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#Authority" + } + }, + "com.amazonaws.taxsettings#Authority": { + "type": "structure", + "members": { + "country": { + "target": "com.amazonaws.taxsettings#CountryCode", + "traits": { + "smithy.api#documentation": "\n The country code for the country that the address is in.\n
", + "smithy.api#required": {} + } + }, + "state": { + "target": "com.amazonaws.taxsettings#State", + "traits": { + "smithy.api#documentation": "\n The state that the address is located. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The address domain associate with the tax information.\n
" + } + }, "com.amazonaws.taxsettings#BatchDeleteTaxRegistration": { "type": "operation", "input": { @@ -517,6 +576,74 @@ "smithy.api#output": {} } }, + "com.amazonaws.taxsettings#BatchGetTaxExemptions": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#BatchGetTaxExemptionsRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#BatchGetTaxExemptionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "requiredActions": ["tax:GetExemptions"], + "documentation": "Grants batch get active tax exemptions for a given list of accounts permission" + }, + "smithy.api#documentation": "Get the active tax exemptions for a given list of accounts.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/BatchGetTaxExemptions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.taxsettings#BatchGetTaxExemptionsRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.taxsettings#AccountIds", + "traits": { + "smithy.api#documentation": "\n List of unique account identifiers.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#BatchGetTaxExemptionsResponse": { + "type": "structure", + "members": { + "taxExemptionDetailsMap": { + "target": "com.amazonaws.taxsettings#TaxExemptionDetailsMap", + "traits": { + "smithy.api#documentation": "The tax exemption details map of accountId and tax exemption details.\n
" + } + }, + "failedAccounts": { + "target": "com.amazonaws.taxsettings#AccountIds", + "traits": { + "smithy.api#documentation": "The list of accounts that failed to get tax exemptions.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.taxsettings#BatchPutTaxRegistration": { "type": "operation", "input": { @@ -718,6 +845,22 @@ "smithy.api#pattern": "^([0-9]{6}-[0-9]{1})$" } }, + "com.amazonaws.taxsettings#CaseCreationLimitExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.taxsettings#ErrorMessage", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You've exceeded the Amazon Web Services Support case creation limit for your account.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 413 + } + }, "com.amazonaws.taxsettings#CcmCode": { "type": "string", "traits": { @@ -936,6 +1079,16 @@ "smithy.api#documentation": "The location of the Amazon S3 bucket that you specify to download your tax documents to.
" } }, + "com.amazonaws.taxsettings#DisplayName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#pattern": "^[\\s\\S]*$" + } + }, "com.amazonaws.taxsettings#District": { "type": "string", "traits": { @@ -946,6 +1099,35 @@ "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" } }, + "com.amazonaws.taxsettings#EntityExemptionAccountStatus": { + "type": "enum", + "members": { + "None": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "None" + } + }, + "Valid": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Valid" + } + }, + "Expired": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Expired" + } + }, + "Pending": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Pending" + } + } + } + }, "com.amazonaws.taxsettings#ErrorCode": { "type": "string", "traits": { @@ -982,12 +1164,62 @@ "smithy.api#documentation": "Additional tax information associated with your TRN in Estonia.
" } }, + "com.amazonaws.taxsettings#ExemptionCertificate": { + "type": "structure", + "members": { + "documentName": { + "target": "com.amazonaws.taxsettings#ExemptionDocumentName", + "traits": { + "smithy.api#documentation": "The exemption certificate file name.\n
", + "smithy.api#required": {} + } + }, + "documentFile": { + "target": "com.amazonaws.taxsettings#ExemptionFileBlob", + "traits": { + "smithy.api#documentation": "The exemption certificate file content.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The exemption certificate.\n
" + } + }, + "com.amazonaws.taxsettings#ExemptionDocumentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + }, + "smithy.api#pattern": "^([A-Za-z0-9-_.]+).(pdf|jpg|png)$" + } + }, + "com.amazonaws.taxsettings#ExemptionFileBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4194304 + } + } + }, "com.amazonaws.taxsettings#FieldName": { "type": "string", "traits": { "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" } }, + "com.amazonaws.taxsettings#FileBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5242880 + } + } + }, "com.amazonaws.taxsettings#GenericString": { "type": "string", "traits": { @@ -1013,6 +1245,113 @@ "smithy.api#documentation": "\n Additional tax information associated with your TRN in Georgia.\n
" } }, + "com.amazonaws.taxsettings#GetTaxExemptionTypes": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#GetTaxExemptionTypesRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#GetTaxExemptionTypesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "requiredActions": ["tax:GetExemptions"], + "documentation": "Grants get supported tax exemption types permission" + }, + "smithy.api#documentation": "Get supported tax exemption types.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/GetTaxExemptionTypes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.taxsettings#GetTaxExemptionTypesRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#GetTaxExemptionTypesResponse": { + "type": "structure", + "members": { + "taxExemptionTypes": { + "target": "com.amazonaws.taxsettings#TaxExemptionTypes", + "traits": { + "smithy.api#documentation": "The supported types of tax exemptions.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#GetTaxInheritance": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#GetTaxInheritanceRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#GetTaxInheritanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants get tax inheritance permission" + }, + "smithy.api#documentation": "The get account tax inheritance status.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/GetTaxInheritance" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.taxsettings#GetTaxInheritanceRequest": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#GetTaxInheritanceResponse": { + "type": "structure", + "members": { + "heritageStatus": { + "target": "com.amazonaws.taxsettings#HeritageStatus", + "traits": { + "smithy.api#documentation": "The tax inheritance status.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.taxsettings#GetTaxRegistration": { "type": "operation", "input": { @@ -1070,7 +1409,8 @@ "code": 200, "method": "POST", "uri": "/GetTaxRegistrationDocument" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.taxsettings#GetTaxRegistrationDocumentRequest": { @@ -1079,8 +1419,7 @@ "destinationS3Location": { "target": "com.amazonaws.taxsettings#DestinationS3Location", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket that you specify to download your tax documents to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon S3 bucket that you specify to download your tax documents to.
" } }, "taxDocumentMetadata": { @@ -1103,6 +1442,12 @@ "traits": { "smithy.api#documentation": "The file path of the Amazon S3 bucket where you want to download your tax document to.
" } + }, + "presignedS3Url": { + "target": "com.amazonaws.taxsettings#Url", + "traits": { + "smithy.api#documentation": "The Amazon S3 presigned URL of the tax registration document.\n
" + } } }, "traits": { @@ -1137,6 +1482,23 @@ "smithy.api#output": {} } }, + "com.amazonaws.taxsettings#HeritageStatus": { + "type": "enum", + "members": { + "OptIn": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OptIn" + } + }, + "OptOut": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OptOut" + } + } + } + }, "com.amazonaws.taxsettings#IndiaAdditionalInfo": { "type": "structure", "members": { @@ -1396,13 +1758,92 @@ "smithy.api#pattern": "^[0-9\\u3130-\\u318F\\uAC00-\\uD7AF,.( )-\\\\s]*$" } }, - "com.amazonaws.taxsettings#ListSupplementalTaxRegistrations": { + "com.amazonaws.taxsettings#ListSupplementalTaxRegistrations": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants retrieve permission" + }, + "smithy.api#documentation": "\n Retrieves supplemental tax registrations for a single account.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/ListSupplementalTaxRegistrations" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "items": "taxRegistrations", + "pageSize": "maxResults" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsRequest": { + "type": "structure", + "members": { + "maxResults": { + "target": "com.amazonaws.taxsettings#MaxResults", + "traits": { + "smithy.api#documentation": "\n The number of taxRegistrations results you want in one response.\n
\n The token to retrieve the next set of results. \n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsResponse": { + "type": "structure", + "members": { + "taxRegistrations": { + "target": "com.amazonaws.taxsettings#SupplementalTaxRegistrationList", + "traits": { + "smithy.api#documentation": "\n The list of supplemental tax registrations. \n
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.taxsettings#PaginationTokenString", + "traits": { + "smithy.api#documentation": "\n The token to retrieve the next set of results. \n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#ListTaxExemptions": { "type": "operation", "input": { - "target": "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsRequest" + "target": "com.amazonaws.taxsettings#ListTaxExemptionsRequest" }, "output": { - "target": "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsResponse" + "target": "com.amazonaws.taxsettings#ListTaxExemptionsResponse" }, "errors": [ { @@ -1417,36 +1858,37 @@ ], "traits": { "aws.iam#iamAction": { - "documentation": "Grants retrieve permission" + "requiredActions": ["tax:GetExemptions"], + "documentation": "Grants list the active tax exemptions for a CB family permission" }, - "smithy.api#documentation": "\n Retrieves supplemental tax registrations for a single account.\n
", + "smithy.api#documentation": "Retrieves the tax exemption of accounts listed in a consolidated billing family.\n
", "smithy.api#http": { "code": 200, "method": "POST", - "uri": "/ListSupplementalTaxRegistrations" + "uri": "/ListTaxExemptions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", - "items": "taxRegistrations", + "items": "taxExemptionDetailsMap", "pageSize": "maxResults" }, "smithy.api#readonly": {} } }, - "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsRequest": { + "com.amazonaws.taxsettings#ListTaxExemptionsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.taxsettings#MaxResults", "traits": { - "smithy.api#documentation": "\n The number of taxRegistrations results you want in one response.\n
The number of results you want in one response.\n
" } }, "nextToken": { "target": "com.amazonaws.taxsettings#PaginationTokenString", "traits": { - "smithy.api#documentation": "\n The token to retrieve the next set of results. \n
" + "smithy.api#documentation": "The token to retrieve the next set of results.
" } } }, @@ -1454,20 +1896,19 @@ "smithy.api#input": {} } }, - "com.amazonaws.taxsettings#ListSupplementalTaxRegistrationsResponse": { + "com.amazonaws.taxsettings#ListTaxExemptionsResponse": { "type": "structure", "members": { - "taxRegistrations": { - "target": "com.amazonaws.taxsettings#SupplementalTaxRegistrationList", + "nextToken": { + "target": "com.amazonaws.taxsettings#PaginationTokenString", "traits": { - "smithy.api#documentation": "\n The list of supplemental tax registrations. \n
", - "smithy.api#required": {} + "smithy.api#documentation": "The token to retrieve the next set of results.
" } }, - "nextToken": { - "target": "com.amazonaws.taxsettings#PaginationTokenString", + "taxExemptionDetailsMap": { + "target": "com.amazonaws.taxsettings#TaxExemptionDetailsMap", "traits": { - "smithy.api#documentation": "\n The token to retrieve the next set of results. \n
" + "smithy.api#documentation": "The tax exemption details map of accountId and tax exemption details.\n
Adds the tax exemption for a single account or all accounts listed in a consolidated billing family.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/PutTaxExemption" + } + } + }, + "com.amazonaws.taxsettings#PutTaxExemptionRequest": { + "type": "structure", + "members": { + "accountIds": { + "target": "com.amazonaws.taxsettings#AccountIds", + "traits": { + "smithy.api#documentation": "\n The list of unique account identifiers.\n
", + "smithy.api#required": {} + } + }, + "authority": { + "target": "com.amazonaws.taxsettings#Authority", + "traits": { + "smithy.api#required": {} + } + }, + "exemptionType": { + "target": "com.amazonaws.taxsettings#GenericString", + "traits": { + "smithy.api#documentation": "The exemption type.\n
", + "smithy.api#required": {} + } + }, + "exemptionCertificate": { + "target": "com.amazonaws.taxsettings#ExemptionCertificate", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#PutTaxExemptionResponse": { + "type": "structure", + "members": { + "caseId": { + "target": "com.amazonaws.taxsettings#GenericString", + "traits": { + "smithy.api#documentation": "The customer support case ID.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.taxsettings#PutTaxInheritance": { + "type": "operation", + "input": { + "target": "com.amazonaws.taxsettings#PutTaxInheritanceRequest" + }, + "output": { + "target": "com.amazonaws.taxsettings#PutTaxInheritanceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.taxsettings#ConflictException" + }, + { + "target": "com.amazonaws.taxsettings#InternalServerException" + }, + { + "target": "com.amazonaws.taxsettings#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.taxsettings#ValidationException" + } + ], + "traits": { + "aws.iam#iamAction": { + "documentation": "Grants put tax inheritance permission" + }, + "smithy.api#documentation": "The updated tax inheritance status.\n
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/PutTaxInheritance" + } + } + }, + "com.amazonaws.taxsettings#PutTaxInheritanceRequest": { + "type": "structure", + "members": { + "heritageStatus": { + "target": "com.amazonaws.taxsettings#HeritageStatus", + "traits": { + "smithy.api#documentation": "The tax inheritance status.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.taxsettings#PutTaxInheritanceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.taxsettings#PutTaxRegistration": { "type": "operation", "input": { @@ -1840,7 +2425,7 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 20 + "max": 200 }, "smithy.api#pattern": "^(?!\\s*$)[\\s\\S]+$" } @@ -2249,6 +2834,131 @@ "smithy.api#pattern": "^[\\s\\S]*$" } }, + "com.amazonaws.taxsettings#TaxExemption": { + "type": "structure", + "members": { + "authority": { + "target": "com.amazonaws.taxsettings#Authority", + "traits": { + "smithy.api#documentation": "The address domain associate with tax exemption.\n
", + "smithy.api#required": {} + } + }, + "taxExemptionType": { + "target": "com.amazonaws.taxsettings#TaxExemptionType", + "traits": { + "smithy.api#documentation": "The tax exemption type.\n
", + "smithy.api#required": {} + } + }, + "effectiveDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The tax exemption effective date.\n
" + } + }, + "expirationDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The tax exemption expiration date.\n
" + } + }, + "systemEffectiveDate": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The tax exemption recording time in the TaxSettings system.\n
The tax exemption status.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The tax exemption.\n
" + } + }, + "com.amazonaws.taxsettings#TaxExemptionDetails": { + "type": "structure", + "members": { + "taxExemptions": { + "target": "com.amazonaws.taxsettings#TaxExemptions", + "traits": { + "smithy.api#documentation": "Tax exemptions.\n
" + } + }, + "heritageObtainedDetails": { + "target": "com.amazonaws.taxsettings#Boolean", + "traits": { + "smithy.api#documentation": "The indicator if the tax exemption is inherited from the consolidated billing family management account.\n
" + } + }, + "heritageObtainedParentEntity": { + "target": "com.amazonaws.taxsettings#GenericString", + "traits": { + "smithy.api#documentation": "The consolidated billing family management account the tax exemption inherited from.\n
" + } + }, + "heritageObtainedReason": { + "target": "com.amazonaws.taxsettings#GenericString", + "traits": { + "smithy.api#documentation": "The reason of the heritage inheritance.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The tax exemption details.\n
" + } + }, + "com.amazonaws.taxsettings#TaxExemptionDetailsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.taxsettings#AccountId" + }, + "value": { + "target": "com.amazonaws.taxsettings#TaxExemptionDetails" + } + }, + "com.amazonaws.taxsettings#TaxExemptionType": { + "type": "structure", + "members": { + "displayName": { + "target": "com.amazonaws.taxsettings#DisplayName", + "traits": { + "smithy.api#documentation": "The tax exemption's type display name.\n
" + } + }, + "description": { + "target": "com.amazonaws.taxsettings#GenericString", + "traits": { + "smithy.api#documentation": "The tax exemption's type description.\n
" + } + }, + "applicableJurisdictions": { + "target": "com.amazonaws.taxsettings#Authorities", + "traits": { + "smithy.api#documentation": "The tax exemption's applicable jurisdictions.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "The tax exemption type.\n
" + } + }, + "com.amazonaws.taxsettings#TaxExemptionTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#TaxExemptionType" + } + }, + "com.amazonaws.taxsettings#TaxExemptions": { + "type": "list", + "member": { + "target": "com.amazonaws.taxsettings#TaxExemption" + } + }, "com.amazonaws.taxsettings#TaxInformationNumber": { "type": "string", "traits": { @@ -2349,14 +3059,41 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.taxsettings#TaxRegistrationDocFile": { + "type": "structure", + "members": { + "fileName": { + "target": "com.amazonaws.taxsettings#TaxDocumentName", + "traits": { + "smithy.api#documentation": "The tax registration document name.\n
", + "smithy.api#required": {} + } + }, + "fileContent": { + "target": "com.amazonaws.taxsettings#FileBlob", + "traits": { + "smithy.api#documentation": "The tax registration document content.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The tax registration document.\n
" + } + }, "com.amazonaws.taxsettings#TaxRegistrationDocument": { "type": "structure", "members": { "s3Location": { "target": "com.amazonaws.taxsettings#SourceS3Location", "traits": { - "smithy.api#documentation": "The Amazon S3 location where your tax registration document is stored.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon S3 location where your tax registration document is stored.
" + } + }, + "file": { + "target": "com.amazonaws.taxsettings#TaxRegistrationDocFile", + "traits": { + "smithy.api#documentation": "The tax registration document.\n
" } } }, @@ -2604,6 +3341,9 @@ { "target": "com.amazonaws.taxsettings#BatchDeleteTaxRegistration" }, + { + "target": "com.amazonaws.taxsettings#BatchGetTaxExemptions" + }, { "target": "com.amazonaws.taxsettings#BatchPutTaxRegistration" }, @@ -2613,6 +3353,12 @@ { "target": "com.amazonaws.taxsettings#DeleteTaxRegistration" }, + { + "target": "com.amazonaws.taxsettings#GetTaxExemptionTypes" + }, + { + "target": "com.amazonaws.taxsettings#GetTaxInheritance" + }, { "target": "com.amazonaws.taxsettings#GetTaxRegistration" }, @@ -2622,12 +3368,21 @@ { "target": "com.amazonaws.taxsettings#ListSupplementalTaxRegistrations" }, + { + "target": "com.amazonaws.taxsettings#ListTaxExemptions" + }, { "target": "com.amazonaws.taxsettings#ListTaxRegistrations" }, { "target": "com.amazonaws.taxsettings#PutSupplementalTaxRegistration" }, + { + "target": "com.amazonaws.taxsettings#PutTaxExemption" + }, + { + "target": "com.amazonaws.taxsettings#PutTaxInheritance" + }, { "target": "com.amazonaws.taxsettings#PutTaxRegistration" } @@ -2645,6 +3400,19 @@ "endpointPatternType": "service_region_dnsSuffix" }, "aws.protocols#restJson1": {}, + "smithy.api#cors": { + "additionalAllowedHeaders": [ + "Content-Type,X-Amz-Date", + "Authorization", + "X-Api-Key", + "X-Amz-Security-Token", + "Access-Control-Allow-Origin", + "X-Amz-Content-Sha256", + "Amz-Sdk-Invocation-Id", + "Amz-Sdk-Request", + "X-Amz-User-Agent" + ] + }, "smithy.api#documentation": "You can use the tax setting API to programmatically set, modify, and delete the tax\n registration number (TRN), associated business legal name, and address (Collectively referred\n to as \"TRN information\"). You can also programmatically view TRN information and tax addresses\n (\"Tax profiles\").
\nYou can use this API to automate your TRN information settings instead of manually using\n the console.
\nService Endpoint
\nhttps://tax.us-east-1.amazonaws.com
\n