diff --git a/clients/client-invoicing/.gitignore b/clients/client-invoicing/.gitignore new file mode 100644 index 000000000000..54f14c9aef25 --- /dev/null +++ b/clients/client-invoicing/.gitignore @@ -0,0 +1,9 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +/dist-* +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/clients/client-invoicing/LICENSE b/clients/client-invoicing/LICENSE new file mode 100644 index 000000000000..1349aa7c9923 --- /dev/null +++ b/clients/client-invoicing/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2018-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/clients/client-invoicing/README.md b/clients/client-invoicing/README.md new file mode 100644 index 000000000000..4fabe0e8ccd2 --- /dev/null +++ b/clients/client-invoicing/README.md @@ -0,0 +1,293 @@ + + +# @aws-sdk/client-invoicing + +## Description + +AWS SDK for JavaScript Invoicing Client for Node.js, Browser and React Native. + +
+Amazon Web Services Invoice Configuration +
+You can use Amazon Web Services Invoice Configuration APIs to programmatically create, +update, delete, get, and list invoice units. You can also programmatically fetch the +information of the invoice receiver. For example, business legal name, address, and invoicing +contacts.
+You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
+Service endpoint
+You can use the following endpoints for Amazon Web Services Invoice Configuration:
+
+https://invoicing.us-east-1.api.aws
+
+ * Amazon Web Services Invoice Configuration + *
+ *You can use Amazon Web Services Invoice Configuration APIs to programmatically create, + * update, delete, get, and list invoice units. You can also programmatically fetch the + * information of the invoice receiver. For example, business legal name, address, and invoicing + * contacts.
+ *You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
+ *Service endpoint
+ *You can use the following endpoints for Amazon Web Services Invoice Configuration:
+ *
+ * https://invoicing.us-east-1.api.aws
+ *
+ * Amazon Web Services Invoice Configuration + *
+ *You can use Amazon Web Services Invoice Configuration APIs to programmatically create, + * update, delete, get, and list invoice units. You can also programmatically fetch the + * information of the invoice receiver. For example, business legal name, address, and invoicing + * contacts.
+ *You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
+ *Service endpoint
+ *You can use the following endpoints for Amazon Web Services Invoice Configuration:
+ *
+ * https://invoicing.us-east-1.api.aws
+ *
This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, BatchGetInvoiceProfileCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, BatchGetInvoiceProfileCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // BatchGetInvoiceProfileRequest + * AccountIds: [ // AccountIdList // required + * "STRING_VALUE", + * ], + * }; + * const command = new BatchGetInvoiceProfileCommand(input); + * const response = await client.send(command); + * // { // BatchGetInvoiceProfileResponse + * // Profiles: [ // ProfileList + * // { // InvoiceProfile + * // AccountId: "STRING_VALUE", + * // ReceiverName: "STRING_VALUE", + * // ReceiverAddress: { // ReceiverAddress + * // AddressLine1: "STRING_VALUE", + * // AddressLine2: "STRING_VALUE", + * // AddressLine3: "STRING_VALUE", + * // DistrictOrCounty: "STRING_VALUE", + * // City: "STRING_VALUE", + * // StateOrRegion: "STRING_VALUE", + * // CountryCode: "STRING_VALUE", + * // CompanyName: "STRING_VALUE", + * // PostalCode: "STRING_VALUE", + * // }, + * // ReceiverEmail: "STRING_VALUE", + * // Issuer: "STRING_VALUE", + * // TaxRegistrationNumber: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param BatchGetInvoiceProfileCommandInput - {@link BatchGetInvoiceProfileCommandInput} + * @returns {@link BatchGetInvoiceProfileCommandOutput} + * @see {@link BatchGetInvoiceProfileCommandInput} for command's `input` shape. + * @see {@link BatchGetInvoiceProfileCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class BatchGetInvoiceProfileCommand extends $Command + .classBuilder< + BatchGetInvoiceProfileCommandInput, + BatchGetInvoiceProfileCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "BatchGetInvoiceProfile", {}) + .n("InvoicingClient", "BatchGetInvoiceProfileCommand") + .f(void 0, BatchGetInvoiceProfileResponseFilterSensitiveLog) + .ser(se_BatchGetInvoiceProfileCommand) + .de(de_BatchGetInvoiceProfileCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: BatchGetInvoiceProfileRequest; + output: BatchGetInvoiceProfileResponse; + }; + sdk: { + input: BatchGetInvoiceProfileCommandInput; + output: BatchGetInvoiceProfileCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/CreateInvoiceUnitCommand.ts b/clients/client-invoicing/src/commands/CreateInvoiceUnitCommand.ts new file mode 100644 index 000000000000..28c59493e458 --- /dev/null +++ b/clients/client-invoicing/src/commands/CreateInvoiceUnitCommand.ts @@ -0,0 +1,121 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { CreateInvoiceUnitRequest, CreateInvoiceUnitResponse } from "../models/models_0"; +import { de_CreateInvoiceUnitCommand, se_CreateInvoiceUnitCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link CreateInvoiceUnitCommand}. + */ +export interface CreateInvoiceUnitCommandInput extends CreateInvoiceUnitRequest {} +/** + * @public + * + * The output of {@link CreateInvoiceUnitCommand}. + */ +export interface CreateInvoiceUnitCommandOutput extends CreateInvoiceUnitResponse, __MetadataBearer {} + +/** + *This creates a new invoice unit with the provided definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, CreateInvoiceUnitCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, CreateInvoiceUnitCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // CreateInvoiceUnitRequest + * Name: "STRING_VALUE", // required + * InvoiceReceiver: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * TaxInheritanceDisabled: true || false, + * Rule: { // InvoiceUnitRule + * LinkedAccounts: [ // AccountIdList + * "STRING_VALUE", + * ], + * }, + * ResourceTags: [ // ResourceTagList + * { // ResourceTag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new CreateInvoiceUnitCommand(input); + * const response = await client.send(command); + * // { // CreateInvoiceUnitResponse + * // InvoiceUnitArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param CreateInvoiceUnitCommandInput - {@link CreateInvoiceUnitCommandInput} + * @returns {@link CreateInvoiceUnitCommandOutput} + * @see {@link CreateInvoiceUnitCommandInput} for command's `input` shape. + * @see {@link CreateInvoiceUnitCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class CreateInvoiceUnitCommand extends $Command + .classBuilder< + CreateInvoiceUnitCommandInput, + CreateInvoiceUnitCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "CreateInvoiceUnit", {}) + .n("InvoicingClient", "CreateInvoiceUnitCommand") + .f(void 0, void 0) + .ser(se_CreateInvoiceUnitCommand) + .de(de_CreateInvoiceUnitCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: CreateInvoiceUnitRequest; + output: CreateInvoiceUnitResponse; + }; + sdk: { + input: CreateInvoiceUnitCommandInput; + output: CreateInvoiceUnitCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/DeleteInvoiceUnitCommand.ts b/clients/client-invoicing/src/commands/DeleteInvoiceUnitCommand.ts new file mode 100644 index 000000000000..500542372603 --- /dev/null +++ b/clients/client-invoicing/src/commands/DeleteInvoiceUnitCommand.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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { DeleteInvoiceUnitRequest, DeleteInvoiceUnitResponse } from "../models/models_0"; +import { de_DeleteInvoiceUnitCommand, se_DeleteInvoiceUnitCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link DeleteInvoiceUnitCommand}. + */ +export interface DeleteInvoiceUnitCommandInput extends DeleteInvoiceUnitRequest {} +/** + * @public + * + * The output of {@link DeleteInvoiceUnitCommand}. + */ +export interface DeleteInvoiceUnitCommandOutput extends DeleteInvoiceUnitResponse, __MetadataBearer {} + +/** + *This deletes an invoice unit with the provided invoice unit ARN. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, DeleteInvoiceUnitCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, DeleteInvoiceUnitCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // DeleteInvoiceUnitRequest + * InvoiceUnitArn: "STRING_VALUE", // required + * }; + * const command = new DeleteInvoiceUnitCommand(input); + * const response = await client.send(command); + * // { // DeleteInvoiceUnitResponse + * // InvoiceUnitArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteInvoiceUnitCommandInput - {@link DeleteInvoiceUnitCommandInput} + * @returns {@link DeleteInvoiceUnitCommandOutput} + * @see {@link DeleteInvoiceUnitCommandInput} for command's `input` shape. + * @see {@link DeleteInvoiceUnitCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class DeleteInvoiceUnitCommand extends $Command + .classBuilder< + DeleteInvoiceUnitCommandInput, + DeleteInvoiceUnitCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "DeleteInvoiceUnit", {}) + .n("InvoicingClient", "DeleteInvoiceUnitCommand") + .f(void 0, void 0) + .ser(se_DeleteInvoiceUnitCommand) + .de(de_DeleteInvoiceUnitCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: DeleteInvoiceUnitRequest; + output: DeleteInvoiceUnitResponse; + }; + sdk: { + input: DeleteInvoiceUnitCommandInput; + output: DeleteInvoiceUnitCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/GetInvoiceUnitCommand.ts b/clients/client-invoicing/src/commands/GetInvoiceUnitCommand.ts new file mode 100644 index 000000000000..f29e78607843 --- /dev/null +++ b/clients/client-invoicing/src/commands/GetInvoiceUnitCommand.ts @@ -0,0 +1,122 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { GetInvoiceUnitRequest, GetInvoiceUnitResponse } from "../models/models_0"; +import { de_GetInvoiceUnitCommand, se_GetInvoiceUnitCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link GetInvoiceUnitCommand}. + */ +export interface GetInvoiceUnitCommandInput extends GetInvoiceUnitRequest {} +/** + * @public + * + * The output of {@link GetInvoiceUnitCommand}. + */ +export interface GetInvoiceUnitCommandOutput extends GetInvoiceUnitResponse, __MetadataBearer {} + +/** + *This retrieves the invoice unit definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, GetInvoiceUnitCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, GetInvoiceUnitCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // GetInvoiceUnitRequest + * InvoiceUnitArn: "STRING_VALUE", // required + * AsOf: new Date("TIMESTAMP"), + * }; + * const command = new GetInvoiceUnitCommand(input); + * const response = await client.send(command); + * // { // GetInvoiceUnitResponse + * // InvoiceUnitArn: "STRING_VALUE", + * // InvoiceReceiver: "STRING_VALUE", + * // Name: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // TaxInheritanceDisabled: true || false, + * // Rule: { // InvoiceUnitRule + * // LinkedAccounts: [ // AccountIdList + * // "STRING_VALUE", + * // ], + * // }, + * // LastModified: new Date("TIMESTAMP"), + * // }; + * + * ``` + * + * @param GetInvoiceUnitCommandInput - {@link GetInvoiceUnitCommandInput} + * @returns {@link GetInvoiceUnitCommandOutput} + * @see {@link GetInvoiceUnitCommandInput} for command's `input` shape. + * @see {@link GetInvoiceUnitCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class GetInvoiceUnitCommand extends $Command + .classBuilder< + GetInvoiceUnitCommandInput, + GetInvoiceUnitCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "GetInvoiceUnit", {}) + .n("InvoicingClient", "GetInvoiceUnitCommand") + .f(void 0, void 0) + .ser(se_GetInvoiceUnitCommand) + .de(de_GetInvoiceUnitCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: GetInvoiceUnitRequest; + output: GetInvoiceUnitResponse; + }; + sdk: { + input: GetInvoiceUnitCommandInput; + output: GetInvoiceUnitCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/ListInvoiceUnitsCommand.ts b/clients/client-invoicing/src/commands/ListInvoiceUnitsCommand.ts new file mode 100644 index 000000000000..9b9c46553dce --- /dev/null +++ b/clients/client-invoicing/src/commands/ListInvoiceUnitsCommand.ts @@ -0,0 +1,135 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { ListInvoiceUnitsRequest, ListInvoiceUnitsResponse } from "../models/models_0"; +import { de_ListInvoiceUnitsCommand, se_ListInvoiceUnitsCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListInvoiceUnitsCommand}. + */ +export interface ListInvoiceUnitsCommandInput extends ListInvoiceUnitsRequest {} +/** + * @public + * + * The output of {@link ListInvoiceUnitsCommand}. + */ +export interface ListInvoiceUnitsCommandOutput extends ListInvoiceUnitsResponse, __MetadataBearer {} + +/** + *This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf
date.
You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class ListInvoiceUnitsCommand extends $Command + .classBuilder< + ListInvoiceUnitsCommandInput, + ListInvoiceUnitsCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "ListInvoiceUnits", {}) + .n("InvoicingClient", "ListInvoiceUnitsCommand") + .f(void 0, void 0) + .ser(se_ListInvoiceUnitsCommand) + .de(de_ListInvoiceUnitsCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListInvoiceUnitsRequest; + output: ListInvoiceUnitsResponse; + }; + sdk: { + input: ListInvoiceUnitsCommandInput; + output: ListInvoiceUnitsCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/ListTagsForResourceCommand.ts b/clients/client-invoicing/src/commands/ListTagsForResourceCommand.ts new file mode 100644 index 000000000000..3631c9b4cf19 --- /dev/null +++ b/clients/client-invoicing/src/commands/ListTagsForResourceCommand.ts @@ -0,0 +1,117 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0"; +import { de_ListTagsForResourceCommand, se_ListTagsForResourceCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {} +/** + * @public + * + * The output of {@link ListTagsForResourceCommand}. + */ +export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {} + +/** + *Lists the tags for a resource. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, ListTagsForResourceCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, ListTagsForResourceCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // ListTagsForResourceRequest + * ResourceArn: "STRING_VALUE", // required + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // ResourceTags: [ // ResourceTagList + * // { // ResourceTag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput} + * @returns {@link ListTagsForResourceCommandOutput} + * @see {@link ListTagsForResourceCommandInput} for command's `input` shape. + * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class ListTagsForResourceCommand extends $Command + .classBuilder< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "ListTagsForResource", {}) + .n("InvoicingClient", "ListTagsForResourceCommand") + .f(void 0, void 0) + .ser(se_ListTagsForResourceCommand) + .de(de_ListTagsForResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: ListTagsForResourceRequest; + output: ListTagsForResourceResponse; + }; + sdk: { + input: ListTagsForResourceCommandInput; + output: ListTagsForResourceCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/TagResourceCommand.ts b/clients/client-invoicing/src/commands/TagResourceCommand.ts new file mode 100644 index 000000000000..6cf7f04ad655 --- /dev/null +++ b/clients/client-invoicing/src/commands/TagResourceCommand.ts @@ -0,0 +1,120 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { TagResourceRequest, TagResourceResponse } from "../models/models_0"; +import { de_TagResourceCommand, se_TagResourceCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link TagResourceCommand}. + */ +export interface TagResourceCommandInput extends TagResourceRequest {} +/** + * @public + * + * The output of {@link TagResourceCommand}. + */ +export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {} + +/** + *Adds a tag to a resource. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, TagResourceCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, TagResourceCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // TagResourceRequest + * ResourceArn: "STRING_VALUE", // required + * ResourceTags: [ // ResourceTagList // required + * { // ResourceTag + * Key: "STRING_VALUE", // required + * Value: "STRING_VALUE", // required + * }, + * ], + * }; + * const command = new TagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param TagResourceCommandInput - {@link TagResourceCommandInput} + * @returns {@link TagResourceCommandOutput} + * @see {@link TagResourceCommandInput} for command's `input` shape. + * @see {@link TagResourceCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class TagResourceCommand extends $Command + .classBuilder< + TagResourceCommandInput, + TagResourceCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "TagResource", {}) + .n("InvoicingClient", "TagResourceCommand") + .f(void 0, void 0) + .ser(se_TagResourceCommand) + .de(de_TagResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: TagResourceRequest; + output: {}; + }; + sdk: { + input: TagResourceCommandInput; + output: TagResourceCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/UntagResourceCommand.ts b/clients/client-invoicing/src/commands/UntagResourceCommand.ts new file mode 100644 index 000000000000..f2dd4a28cf1f --- /dev/null +++ b/clients/client-invoicing/src/commands/UntagResourceCommand.ts @@ -0,0 +1,114 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0"; +import { de_UntagResourceCommand, se_UntagResourceCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandInput extends UntagResourceRequest {} +/** + * @public + * + * The output of {@link UntagResourceCommand}. + */ +export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {} + +/** + *+ * Removes a tag from a resource. + *
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, UntagResourceCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, UntagResourceCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // UntagResourceRequest + * ResourceArn: "STRING_VALUE", // required + * ResourceTagKeys: [ // ResourceTagKeyList // required + * "STRING_VALUE", + * ], + * }; + * const command = new UntagResourceCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param UntagResourceCommandInput - {@link UntagResourceCommandInput} + * @returns {@link UntagResourceCommandOutput} + * @see {@link UntagResourceCommandInput} for command's `input` shape. + * @see {@link UntagResourceCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class UntagResourceCommand extends $Command + .classBuilder< + UntagResourceCommandInput, + UntagResourceCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "UntagResource", {}) + .n("InvoicingClient", "UntagResourceCommand") + .f(void 0, void 0) + .ser(se_UntagResourceCommand) + .de(de_UntagResourceCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UntagResourceRequest; + output: {}; + }; + sdk: { + input: UntagResourceCommandInput; + output: UntagResourceCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/UpdateInvoiceUnitCommand.ts b/clients/client-invoicing/src/commands/UpdateInvoiceUnitCommand.ts new file mode 100644 index 000000000000..2333e60a89be --- /dev/null +++ b/clients/client-invoicing/src/commands/UpdateInvoiceUnitCommand.ts @@ -0,0 +1,118 @@ +// 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 { InvoicingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../InvoicingClient"; +import { UpdateInvoiceUnitRequest, UpdateInvoiceUnitResponse } from "../models/models_0"; +import { de_UpdateInvoiceUnitCommand, se_UpdateInvoiceUnitCommand } from "../protocols/Aws_json1_0"; + +/** + * @public + */ +export type { __MetadataBearer }; +export { $Command }; +/** + * @public + * + * The input for {@link UpdateInvoiceUnitCommand}. + */ +export interface UpdateInvoiceUnitCommandInput extends UpdateInvoiceUnitRequest {} +/** + * @public + * + * The output of {@link UpdateInvoiceUnitCommand}. + */ +export interface UpdateInvoiceUnitCommandOutput extends UpdateInvoiceUnitResponse, __MetadataBearer {} + +/** + *You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { InvoicingClient, UpdateInvoiceUnitCommand } from "@aws-sdk/client-invoicing"; // ES Modules import + * // const { InvoicingClient, UpdateInvoiceUnitCommand } = require("@aws-sdk/client-invoicing"); // CommonJS import + * const client = new InvoicingClient(config); + * const input = { // UpdateInvoiceUnitRequest + * InvoiceUnitArn: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * TaxInheritanceDisabled: true || false, + * Rule: { // InvoiceUnitRule + * LinkedAccounts: [ // AccountIdList + * "STRING_VALUE", + * ], + * }, + * }; + * const command = new UpdateInvoiceUnitCommand(input); + * const response = await client.send(command); + * // { // UpdateInvoiceUnitResponse + * // InvoiceUnitArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param UpdateInvoiceUnitCommandInput - {@link UpdateInvoiceUnitCommandInput} + * @returns {@link UpdateInvoiceUnitCommandOutput} + * @see {@link UpdateInvoiceUnitCommandInput} for command's `input` shape. + * @see {@link UpdateInvoiceUnitCommandOutput} for command's `response` shape. + * @see {@link InvoicingClientResolvedConfig | config} for InvoicingClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You don't have sufficient access to perform this action.
+ * + * @throws {@link InternalServerException} (server fault) + *The processing request failed because of an unknown error, exception, or failure. + *
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The resource could not be found. + *
+ * + * @throws {@link ThrottlingException} (client fault) + *The request was denied due to request throttling.
+ * + * @throws {@link ValidationException} (client fault) + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * + * @throws {@link InvoicingServiceException} + *Base exception class for all service exceptions from Invoicing service.
+ * + * @public + */ +export class UpdateInvoiceUnitCommand extends $Command + .classBuilder< + UpdateInvoiceUnitCommandInput, + UpdateInvoiceUnitCommandOutput, + InvoicingClientResolvedConfig, + ServiceInputTypes, + ServiceOutputTypes + >() + .ep(commonParams) + .m(function (this: any, Command: any, cs: any, config: InvoicingClientResolvedConfig, o: any) { + return [ + getSerdePlugin(config, this.serialize, this.deserialize), + getEndpointPlugin(config, Command.getEndpointParameterInstructions()), + ]; + }) + .s("Invoicing", "UpdateInvoiceUnit", {}) + .n("InvoicingClient", "UpdateInvoiceUnitCommand") + .f(void 0, void 0) + .ser(se_UpdateInvoiceUnitCommand) + .de(de_UpdateInvoiceUnitCommand) + .build() { + /** @internal type navigation helper, not in runtime. */ + protected declare static __types: { + api: { + input: UpdateInvoiceUnitRequest; + output: UpdateInvoiceUnitResponse; + }; + sdk: { + input: UpdateInvoiceUnitCommandInput; + output: UpdateInvoiceUnitCommandOutput; + }; + }; +} diff --git a/clients/client-invoicing/src/commands/index.ts b/clients/client-invoicing/src/commands/index.ts new file mode 100644 index 000000000000..35f75458cf39 --- /dev/null +++ b/clients/client-invoicing/src/commands/index.ts @@ -0,0 +1,10 @@ +// smithy-typescript generated code +export * from "./BatchGetInvoiceProfileCommand"; +export * from "./CreateInvoiceUnitCommand"; +export * from "./DeleteInvoiceUnitCommand"; +export * from "./GetInvoiceUnitCommand"; +export * from "./ListInvoiceUnitsCommand"; +export * from "./ListTagsForResourceCommand"; +export * from "./TagResourceCommand"; +export * from "./UntagResourceCommand"; +export * from "./UpdateInvoiceUnitCommand"; diff --git a/clients/client-invoicing/src/endpoint/EndpointParameters.ts b/clients/client-invoicing/src/endpoint/EndpointParameters.ts new file mode 100644 index 000000000000..76f6706edc0c --- /dev/null +++ b/clients/client-invoicing/src/endpoint/EndpointParameters.ts @@ -0,0 +1,37 @@ +// smithy-typescript generated code +import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types"; + +/** + * @public + */ +export interface ClientInputEndpointParameters { + useFipsEndpoint?: boolean | Provider+ * Amazon Web Services Invoice Configuration + *
+ *You can use Amazon Web Services Invoice Configuration APIs to programmatically create, + * update, delete, get, and list invoice units. You can also programmatically fetch the + * information of the invoice receiver. For example, business legal name, address, and invoicing + * contacts.
+ *You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
+ *Service endpoint
+ *You can use the following endpoints for Amazon Web Services Invoice Configuration:
+ *
+ * https://invoicing.us-east-1.api.aws
+ *
You don't have sufficient access to perform this action.
+ * @public + */ +export class AccessDeniedException extends __BaseException { + readonly name: "AccessDeniedException" = "AccessDeniedException"; + readonly $fault: "client" = "client"; + /** + *You don't have sufficient access to perform this action. + *
+ * @public + */ + resourceName?: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeRetrieves the corresponding invoice profile data for these account IDs. + *
+ * @public + */ + AccountIds: string[] | undefined; +} + +/** + *+ * The details of the address associated with the receiver. + *
+ * @public + */ +export interface ReceiverAddress { + /** + *+ * The first line of the address. + *
+ * @public + */ + AddressLine1?: string | undefined; + + /** + *+ * The second line of the address, if applicable. + *
+ * @public + */ + AddressLine2?: string | undefined; + + /** + *+ * The third line of the address, if applicable. + *
+ * @public + */ + AddressLine3?: string | undefined; + + /** + *+ * The district or country the address is located in. + *
+ * @public + */ + DistrictOrCounty?: string | undefined; + + /** + *+ * The city that the address is in. + *
+ * @public + */ + City?: string | undefined; + + /** + *+ * The state, region, or province the address is located. + *
+ * @public + */ + StateOrRegion?: string | undefined; + + /** + *+ * The country code for the country the address is in. + *
+ * @public + */ + CountryCode?: string | undefined; + + /** + *+ * A unique company name. + *
+ * @public + */ + CompanyName?: string | undefined; + + /** + *+ * The postal code associated with the address. + *
+ * @public + */ + PostalCode?: string | undefined; +} + +/** + *+ * Contains high-level information about the invoice receiver. + *
+ * @public + */ +export interface InvoiceProfile { + /** + *+ * The account ID the invoice profile is generated for. + *
+ * @public + */ + AccountId?: string | undefined; + + /** + *+ * The name of the person receiving the invoice profile. + *
+ * @public + */ + ReceiverName?: string | undefined; + + /** + *The address of the receiver that will be printed on the invoice. + *
+ * @public + */ + ReceiverAddress?: ReceiverAddress | undefined; + + /** + *The email address for the invoice profile receiver. + *
+ * @public + */ + ReceiverEmail?: string | undefined; + + /** + *+ * This specifies the issuing entity of the invoice. + *
+ * @public + */ + Issuer?: string | undefined; + + /** + *+ * Your Tax Registration Number (TRN) information. + *
+ * @public + */ + TaxRegistrationNumber?: string | undefined; +} + +/** + * @public + */ +export interface BatchGetInvoiceProfileResponse { + /** + *+ * A list of invoice profiles corresponding to the requested accounts. + *
+ * @public + */ + Profiles?: InvoiceProfile[] | undefined; +} + +/** + *The processing request failed because of an unknown error, exception, or failure. + *
+ * @public + */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + /** + *The processing request failed because of an unknown error, exception, or failure.
+ * @public + */ + retryAfterSeconds?: number | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe resource could not be found. + *
+ * @public + */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + /** + *The resource could not be found.
+ * @public + */ + resourceName?: string | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ * @public + */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionType+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * @public + */ +export interface ValidationExceptionField { + /** + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * @public + */ + name: string | undefined; + + /** + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * @public + */ + message: string | undefined; +} + +/** + * @public + * @enum + */ +export const ValidationExceptionReason = { + ACCOUNT_MEMBERSHIP_ERROR: "accountMembershipError", + CANNOT_PARSE: "cannotParse", + DUPLICATE_INVOICE_UNIT: "duplicateInvoiceUnit", + EXPIRED_NEXT_TOKEN: "expiredNextToken", + FIELD_VALIDATION_FAILED: "fieldValidationFailed", + INVALID_INPUT: "invalidInput", + INVALID_NEXT_TOKEN: "invalidNextToken", + MAX_ACCOUNTS_EXCEEDED: "maxAccountsExceeded", + MAX_INVOICE_UNITS_EXCEEDED: "maxInvoiceUnitsExceeded", + MUTUAL_EXCLUSION_ERROR: "mutualExclusionError", + NON_MEMBERS_PRESENT: "nonMemberPresent", + OTHER: "other", + TAX_SETTINGS_ERROR: "taxSettingsError", + UNKNOWN_OPERATION: "unknownOperation", +} as const; + +/** + * @public + */ +export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; + +/** + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * @public + */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + /** + *You don't have sufficient access to perform this action. + *
+ * @public + */ + resourceName?: string | undefined; + + /** + *You don't have sufficient access to perform this action. + *
+ * @public + */ + reason?: ValidationExceptionReason | undefined; + + /** + *+ * The input fails to satisfy the constraints specified by an Amazon Web Services service. + *
+ * @public + */ + fieldList?: ValidationExceptionField[] | undefined; + + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe tag structure that contains a tag key and value. + *
+ * @public + */ +export interface ResourceTag { + /** + *The object key of your of your resource tag. + *
+ * @public + */ + Key: string | undefined; + + /** + *+ * The specific value of the resource tag. + *
+ * @public + */ + Value: string | undefined; +} + +/** + *
+ * This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT
.
+ *
The list of LINKED_ACCOUNT
IDs where charges are included within the invoice unit.
+ *
+ * The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate. + *
+ * @public + */ + Name: string | undefined; + + /** + *+ * The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID. + *
+ * @public + */ + InvoiceReceiver: string | undefined; + + /** + *+ * The invoice unit's description. This can be changed at a later time. + *
+ * @public + */ + Description?: string | undefined; + + /** + *Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + *
+ * @public + */ + TaxInheritanceDisabled?: boolean | undefined; + + /** + *The InvoiceUnitRule
object used to create invoice units.
+ *
+ * The tag structure that contains a tag key and value. + *
+ * @public + */ + ResourceTags?: ResourceTag[] | undefined; +} + +/** + * @public + */ +export interface CreateInvoiceUnitResponse { + /** + *+ * The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn?: string | undefined; +} + +/** + * @public + */ +export interface DeleteInvoiceUnitRequest { + /** + *+ * The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteInvoiceUnitResponse { + /** + *+ * The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn?: string | undefined; +} + +/** + *An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers
, Names
, and Accounts
.
+ *
+ * An optional input to the list API. You can specify a list of invoice unit names inside filters to return invoice units that match only the specified invoice unit names. If multiple names are provided, the result is an OR
condition (match any) of the specified invoice unit names.
+ *
+ * You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR
condition (match any) of the specified accounts. This filter only matches the specified accounts on the invoice receivers of the invoice units.
+ *
+ * You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR
condition (match any) of the specified accounts. The specified account IDs are matched with either the receiver or the linked accounts in the rules.
+ *
+ * The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn: string | undefined; + + /** + *
+ * The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf
time is set to before it was deleted. If an AsOf
is not provided, the default value is the current time.
+ *
+ * The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn?: string | undefined; + + /** + *+ * The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID. + *
+ * @public + */ + InvoiceReceiver?: string | undefined; + + /** + *+ * The unique name of the invoice unit that is shown on the generated invoice. + *
+ * @public + */ + Name?: string | undefined; + + /** + *+ * The assigned description for an invoice unit. + *
+ * @public + */ + Description?: string | undefined; + + /** + *+ * Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + *
+ * @public + */ + TaxInheritanceDisabled?: boolean | undefined; + + /** + *
+ * This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT
.
+ *
+ * The most recent date the invoice unit response was updated. + *
+ * @public + */ + LastModified?: Date | undefined; +} + +/** + *An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you separate Amazon Web Services account costs and configures your invoice for each business entity going forward. + *
+ * @public + */ +export interface InvoiceUnit { + /** + *ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn?: string | undefined; + + /** + *The account that receives invoices related to the invoice unit. + *
+ * @public + */ + InvoiceReceiver?: string | undefined; + + /** + *+ * A unique name that is distinctive within your Amazon Web Services. + *
+ * @public + */ + Name?: string | undefined; + + /** + *The assigned description for an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + Description?: string | undefined; + + /** + *Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + *
+ * @public + */ + TaxInheritanceDisabled?: boolean | undefined; + + /** + *
+ * An InvoiceUnitRule
object used the categorize invoice units.
+ *
+ * The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration. + *
+ * @public + */ + LastModified?: Date | undefined; +} + +/** + * @public + */ +export interface ListInvoiceUnitsRequest { + /** + *
+ * An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers
, Names
, and Accounts
.
+ *
The next token used to indicate where the returned list should start from. + *
+ * @public + */ + NextToken?: string | undefined; + + /** + *The maximum number of invoice units that can be returned. + *
+ * @public + */ + MaxResults?: number | undefined; + + /** + *
+ * The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf
time is set to before it was deleted. If an AsOf
is not provided, the default value is the current time.
+ *
+ * An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. + *
+ * @public + */ + InvoiceUnits?: InvoiceUnit[] | undefined; + + /** + *The next token used to indicate where the returned list should start from. + *
+ * @public + */ + NextToken?: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + *The Amazon Resource Name (ARN) of tags to list. + *
+ * @public + */ + ResourceArn: string | undefined; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + *+ * Adds a tag to a resource. + *
+ * @public + */ + ResourceTags?: ResourceTag[] | undefined; +} + +/** + *The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded. + *
+ * @public + */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + readonly $fault: "client" = "client"; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the tags. + *
+ * @public + */ + ResourceArn: string | undefined; + + /** + *+ * Adds a tag to a resource. + *
+ * @public + */ + ResourceTags: ResourceTag[] | undefined; +} + +/** + * @public + */ +export interface TagResourceResponse {} + +/** + * @public + */ +export interface UntagResourceRequest { + /** + *+ * The Amazon Resource Name (ARN) to untag. + *
+ * @public + */ + ResourceArn: string | undefined; + + /** + *+ * Keys for the tags to be removed. + *
+ * @public + */ + ResourceTagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceResponse {} + +/** + * @public + */ +export interface UpdateInvoiceUnitRequest { + /** + *The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn: string | undefined; + + /** + *The assigned description for an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + Description?: string | undefined; + + /** + *Whether the invoice unit based tax inheritance is/ should be enabled or disabled. + *
+ * @public + */ + TaxInheritanceDisabled?: boolean | undefined; + + /** + *The InvoiceUnitRule
object used to update invoice units.
+ *
+ * The ARN to identify an invoice unit. This information can't be modified or deleted. + *
+ * @public + */ + InvoiceUnitArn?: string | undefined; +} + +/** + * @internal + */ +export const ReceiverAddressFilterSensitiveLog = (obj: ReceiverAddress): any => ({ + ...obj, +}); + +/** + * @internal + */ +export const InvoiceProfileFilterSensitiveLog = (obj: InvoiceProfile): any => ({ + ...obj, + ...(obj.ReceiverAddress && { ReceiverAddress: SENSITIVE_STRING }), + ...(obj.ReceiverEmail && { ReceiverEmail: SENSITIVE_STRING }), + ...(obj.TaxRegistrationNumber && { TaxRegistrationNumber: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const BatchGetInvoiceProfileResponseFilterSensitiveLog = (obj: BatchGetInvoiceProfileResponse): any => ({ + ...obj, + ...(obj.Profiles && { Profiles: obj.Profiles.map((item) => InvoiceProfileFilterSensitiveLog(item)) }), +}); diff --git a/clients/client-invoicing/src/pagination/Interfaces.ts b/clients/client-invoicing/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..106128180f0a --- /dev/null +++ b/clients/client-invoicing/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { InvoicingClient } from "../InvoicingClient"; + +/** + * @public + */ +export interface InvoicingPaginationConfiguration extends PaginationConfiguration { + client: InvoicingClient; +} diff --git a/clients/client-invoicing/src/pagination/ListInvoiceUnitsPaginator.ts b/clients/client-invoicing/src/pagination/ListInvoiceUnitsPaginator.ts new file mode 100644 index 000000000000..983d18d7a49f --- /dev/null +++ b/clients/client-invoicing/src/pagination/ListInvoiceUnitsPaginator.ts @@ -0,0 +1,24 @@ +// smithy-typescript generated code +import { createPaginator } from "@smithy/core"; +import { Paginator } from "@smithy/types"; + +import { + ListInvoiceUnitsCommand, + ListInvoiceUnitsCommandInput, + ListInvoiceUnitsCommandOutput, +} from "../commands/ListInvoiceUnitsCommand"; +import { InvoicingClient } from "../InvoicingClient"; +import { InvoicingPaginationConfiguration } from "./Interfaces"; + +/** + * @public + */ +export const paginateListInvoiceUnits: ( + config: InvoicingPaginationConfiguration, + input: ListInvoiceUnitsCommandInput, + ...rest: any[] +) => PaginatorYou don't have sufficient access to perform this action.\n
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvoicingAccessDenied", + "httpResponseCode": 403 + }, + "smithy.api#documentation": "You don't have sufficient access to perform this action.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.invoicing#AccountIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.invoicing#AccountIdString" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.invoicing#AccountIdString": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\d{12}$" + } + }, + "com.amazonaws.invoicing#AsOfTimestamp": { + "type": "timestamp" + }, + "com.amazonaws.invoicing#BasicString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^\\S+$" + } + }, + "com.amazonaws.invoicing#BatchGetInvoiceProfile": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#BatchGetInvoiceProfileRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#BatchGetInvoiceProfileResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.
", + "smithy.api#examples": [ + { + "title": "BatchGetInvoiceProfile", + "input": { + "AccountIds": ["111111111111"] + }, + "output": { + "Profiles": [ + { + "AccountId": "111111111111", + "Issuer": "Test", + "ReceiverAddress": { + "AddressLine1": "Test", + "City": "Test", + "CountryCode": "LU", + "PostalCode": "Test", + "StateOrRegion": "Test" + }, + "ReceiverEmail": "test@amazon.com", + "ReceiverName": "TestAccount" + } + ] + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.invoicing#BatchGetInvoiceProfileRequest": { + "type": "structure", + "members": { + "AccountIds": { + "target": "com.amazonaws.invoicing#AccountIdList", + "traits": { + "smithy.api#documentation": "Retrieves the corresponding invoice profile data for these account IDs.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.invoicing#BatchGetInvoiceProfileResponse": { + "type": "structure", + "members": { + "Profiles": { + "target": "com.amazonaws.invoicing#ProfileList", + "traits": { + "smithy.api#documentation": "\n A list of invoice profiles corresponding to the requested accounts.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#CreateInvoiceUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#CreateInvoiceUnitRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#CreateInvoiceUnitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This creates a new invoice unit with the provided definition.
", + "smithy.api#examples": [ + { + "title": "CreateInvoiceUnit", + "input": { + "Name": "Example Invoice Unit", + "InvoiceReceiver": "111111111111", + "Description": "Example Invoice Unit Description", + "TaxInheritanceDisabled": false, + "Rule": { + "LinkedAccounts": ["222222222222"] + }, + "ResourceTags": [ + { + "Key": "TagKey", + "Value": "TagValue" + } + ] + }, + "output": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + } + } + ] + } + }, + "com.amazonaws.invoicing#CreateInvoiceUnitRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.invoicing#InvoiceUnitName", + "traits": { + "smithy.api#documentation": "\n The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate.\n
", + "smithy.api#required": {} + } + }, + "InvoiceReceiver": { + "target": "com.amazonaws.invoicing#AccountIdString", + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.\n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.invoicing#DescriptionString", + "traits": { + "smithy.api#documentation": "\n The invoice unit's description. This can be changed at a later time.\n
" + } + }, + "TaxInheritanceDisabled": { + "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.\n
" + } + }, + "Rule": { + "target": "com.amazonaws.invoicing#InvoiceUnitRule", + "traits": { + "smithy.api#documentation": "The InvoiceUnitRule
object used to create invoice units.\n
\n The tag structure that contains a tag key and value.\n
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.invoicing#CreateInvoiceUnitResponse": { + "type": "structure", + "members": { + "InvoiceUnitArn": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "\n The ARN to identify an invoice unit. This information can't be modified or deleted.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#DeleteInvoiceUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#DeleteInvoiceUnitRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#DeleteInvoiceUnitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "This deletes an invoice unit with the provided invoice unit ARN.\n
", + "smithy.api#examples": [ + { + "title": "DeleteInvoiceUnit", + "input": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + }, + "output": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + } + } + ] + } + }, + "com.amazonaws.invoicing#DeleteInvoiceUnitRequest": { + "type": "structure", + "members": { + "InvoiceUnitArn": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "\n The ARN to identify an invoice unit. This information can't be modified or deleted.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.invoicing#DeleteInvoiceUnitResponse": { + "type": "structure", + "members": { + "InvoiceUnitArn": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "\n The ARN to identify an invoice unit. This information can't be modified or deleted.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#DescriptionString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.invoicing#Filters": { + "type": "structure", + "members": { + "Names": { + "target": "com.amazonaws.invoicing#InvoiceUnitNames", + "traits": { + "smithy.api#documentation": "\n An optional input to the list API. You can specify a list of invoice unit names inside filters to return invoice units that match only the specified invoice unit names. If multiple names are provided, the result is an OR
condition (match any) of the specified invoice unit names.\n
\nYou can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR
condition (match any) of the specified accounts. This filter only matches the specified accounts on the invoice receivers of the invoice units.\n
\nYou can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR
condition (match any) of the specified accounts. The specified account IDs are matched with either the receiver or the linked accounts in the rules.\n
An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers
, Names
, and Accounts
. \n
This retrieves the invoice unit definition.
", + "smithy.api#examples": [ + { + "title": "GetInvoiceUnit as of current time", + "input": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + }, + "output": { + "InvoiceReceiver": "111111111111", + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", + "LastModified": 1733788800, + "Name": "Example Invoice Unit A", + "Description": "Description changed on 1733788800", + "Rule": { + "LinkedAccounts": ["222222222222"] + }, + "TaxInheritanceDisabled": false + } + }, + { + "title": "GetInvoiceUnit as of specified time", + "input": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", + "AsOf": 1733097600 + }, + "output": { + "InvoiceReceiver": "333333333333", + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/87654321", + "LastModified": 1733011200, + "Name": "Example Invoice Unit B", + "Description": "Description changed on 1733011200", + "Rule": { + "LinkedAccounts": ["333333333333"] + }, + "TaxInheritanceDisabled": false + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.invoicing#GetInvoiceUnitRequest": { + "type": "structure", + "members": { + "InvoiceUnitArn": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "\n The ARN to identify an invoice unit. This information can't be modified or deleted.\n
", + "smithy.api#required": {} + } + }, + "AsOf": { + "target": "com.amazonaws.invoicing#AsOfTimestamp", + "traits": { + "smithy.api#documentation": "\n The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf
time is set to before it was deleted. If an AsOf
is not provided, the default value is the current time.\n
\n The ARN to identify an invoice unit. This information can't be modified or deleted.\n
" + } + }, + "InvoiceReceiver": { + "target": "com.amazonaws.invoicing#AccountIdString", + "traits": { + "smithy.api#documentation": "\n The Amazon Web Services account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.\n
" + } + }, + "Name": { + "target": "com.amazonaws.invoicing#InvoiceUnitName", + "traits": { + "smithy.api#documentation": "\n The unique name of the invoice unit that is shown on the generated invoice.\n
" + } + }, + "Description": { + "target": "com.amazonaws.invoicing#DescriptionString", + "traits": { + "smithy.api#documentation": "\n The assigned description for an invoice unit.\n
" + } + }, + "TaxInheritanceDisabled": { + "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "\n Whether the invoice unit based tax inheritance is/ should be enabled or disabled.\n
" + } + }, + "Rule": { + "target": "com.amazonaws.invoicing#InvoiceUnitRule" + }, + "LastModified": { + "target": "com.amazonaws.invoicing#LastModifiedTimestamp", + "traits": { + "smithy.api#documentation": "\n The most recent date the invoice unit response was updated.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#InternalServerException": { + "type": "structure", + "members": { + "retryAfterSeconds": { + "target": "smithy.api#Integer", + "traits": { + "smithy.api#documentation": "The processing request failed because of an unknown error, exception, or failure.
", + "smithy.api#httpHeader": "Retry-After" + } + }, + "message": { + "target": "com.amazonaws.invoicing#BasicString" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvoicingInternalServer", + "httpResponseCode": 500 + }, + "smithy.api#documentation": "The processing request failed because of an unknown error, exception, or failure.\n
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.invoicing#InvoiceProfile": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.invoicing#AccountIdString", + "traits": { + "smithy.api#documentation": "\nThe account ID the invoice profile is generated for.\n
" + } + }, + "ReceiverName": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe name of the person receiving the invoice profile.\n
" + } + }, + "ReceiverAddress": { + "target": "com.amazonaws.invoicing#ReceiverAddress", + "traits": { + "smithy.api#documentation": "The address of the receiver that will be printed on the invoice.\n
" + } + }, + "ReceiverEmail": { + "target": "com.amazonaws.invoicing#SensitiveBasicString", + "traits": { + "smithy.api#documentation": "The email address for the invoice profile receiver.\n
" + } + }, + "Issuer": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThis specifies the issuing entity of the invoice.\n
" + } + }, + "TaxRegistrationNumber": { + "target": "com.amazonaws.invoicing#SensitiveBasicString", + "traits": { + "smithy.api#documentation": "\nYour Tax Registration Number (TRN) information.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nContains high-level information about the invoice receiver.\n
" + } + }, + "com.amazonaws.invoicing#InvoiceUnit": { + "type": "structure", + "members": { + "InvoiceUnitArn": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "ARN to identify an invoice unit. This information can't be modified or deleted.\n
" + } + }, + "InvoiceReceiver": { + "target": "com.amazonaws.invoicing#AccountIdString", + "traits": { + "smithy.api#documentation": "The account that receives invoices related to the invoice unit.\n
" + } + }, + "Name": { + "target": "com.amazonaws.invoicing#InvoiceUnitName", + "traits": { + "smithy.api#documentation": "\n A unique name that is distinctive within your Amazon Web Services.\n
" + } + }, + "Description": { + "target": "com.amazonaws.invoicing#DescriptionString", + "traits": { + "smithy.api#documentation": "The assigned description for an invoice unit. This information can't be modified or deleted.\n
" + } + }, + "TaxInheritanceDisabled": { + "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.\n
" + } + }, + "Rule": { + "target": "com.amazonaws.invoicing#InvoiceUnitRule", + "traits": { + "smithy.api#documentation": "\nAn InvoiceUnitRule
object used the categorize invoice units. \n
\nThe last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you separate Amazon Web Services account costs and configures your invoice for each business entity going forward.\n
" + } + }, + "com.amazonaws.invoicing#InvoiceUnitArnString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$" + } + }, + "com.amazonaws.invoicing#InvoiceUnitName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + }, + "smithy.api#pattern": "^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?The list ofLINKED_ACCOUNT
IDs where charges are included within the invoice unit.\n"
+ }
+ }
+ },
+ "traits": {
+ "smithy.api#documentation": "\nThis is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT
.\n
\n Amazon Web Services Invoice Configuration\n
\nYou can use Amazon Web Services Invoice Configuration APIs to programmatically create,\n update, delete, get, and list invoice units. You can also programmatically fetch the\n information of the invoice receiver. For example, business legal name, address, and invoicing\n contacts.
\nYou can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
\nService endpoint
\nYou can use the following endpoints for Amazon Web Services Invoice Configuration:
\n\n https://invoicing.us-east-1.api.aws
\n
This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf
date.
\n An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers
, Names
, and Accounts
. \n
The next token used to indicate where the returned list should start from.\n
" + } + }, + "MaxResults": { + "target": "com.amazonaws.invoicing#MaxResultsInteger", + "traits": { + "smithy.api#default": 500, + "smithy.api#documentation": "The maximum number of invoice units that can be returned.\n
" + } + }, + "AsOf": { + "target": "com.amazonaws.invoicing#AsOfTimestamp", + "traits": { + "smithy.api#documentation": "\n The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf
time is set to before it was deleted. If an AsOf
is not provided, the default value is the current time.\n
\n An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.\n
" + } + }, + "NextToken": { + "target": "com.amazonaws.invoicing#NextTokenString", + "traits": { + "smithy.api#documentation": "The next token used to indicate where the returned list should start from.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for a resource.\n
", + "smithy.api#examples": [ + { + "title": "ListTagsForResource", + "input": { + "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + }, + "output": { + "ResourceTags": [ + { + "Key": "TagKey", + "Value": "TagValue" + } + ] + } + } + ], + "smithy.api#readonly": {} + } + }, + "com.amazonaws.invoicing#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.invoicing#TagrisArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of tags to list.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.invoicing#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceTags": { + "target": "com.amazonaws.invoicing#ResourceTagList", + "traits": { + "smithy.api#documentation": "\n Adds a tag to a resource.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#MaxResultsInteger": { + "type": "integer", + "traits": { + "smithy.api#default": 500, + "smithy.api#range": { + "min": 1, + "max": 500 + } + } + }, + "com.amazonaws.invoicing#NextTokenString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.invoicing#ProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.invoicing#InvoiceProfile" + } + }, + "com.amazonaws.invoicing#ReceiverAddress": { + "type": "structure", + "members": { + "AddressLine1": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe first line of the address.\n
" + } + }, + "AddressLine2": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe second line of the address, if applicable.\n
" + } + }, + "AddressLine3": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe third line of the address, if applicable.\n
" + } + }, + "DistrictOrCounty": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe district or country the address is located in.\n
" + } + }, + "City": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe city that the address is in.\n
" + } + }, + "StateOrRegion": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe state, region, or province the address is located.\n
" + } + }, + "CountryCode": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe country code for the country the address is in.\n
" + } + }, + "CompanyName": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nA unique company name.\n
" + } + }, + "PostalCode": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\nThe postal code associated with the address.\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\nThe details of the address associated with the receiver.\n
", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.invoicing#ResourceNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.invoicing#BasicString" + }, + "resourceName": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "The resource could not be found.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvoicingResourceNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The resource could not be found.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.invoicing#ResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.invoicing#ResourceTagKey", + "traits": { + "smithy.api#documentation": "The object key of your of your resource tag.\n
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.invoicing#ResourceTagValue", + "traits": { + "smithy.api#documentation": "\nThe specific value of the resource tag.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The tag structure that contains a tag key and value.\n
" + } + }, + "com.amazonaws.invoicing#ResourceTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.invoicing#ResourceTagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.invoicing#ResourceTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.invoicing#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.invoicing#ResourceTag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.invoicing#ResourceTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.invoicing#SensitiveBasicString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^\\S+$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.invoicing#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvoicingServiceQuotaExceeded", + "httpResponseCode": 402 + }, + "smithy.api#documentation": "The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.invoicing#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.invoicing#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a tag to a resource.\n
", + "smithy.api#examples": [ + { + "title": "TagResource", + "input": { + "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", + "ResourceTags": [ + { + "Key": "TagKey", + "Value": "TagValue" + } + ] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.invoicing#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.invoicing#TagrisArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tags.\n
", + "smithy.api#required": {} + } + }, + "ResourceTags": { + "target": "com.amazonaws.invoicing#ResourceTagList", + "traits": { + "smithy.api#documentation": "\n Adds a tag to a resource.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.invoicing#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#TagrisArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + }, + "smithy.api#pattern": "^arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+$" + } + }, + "com.amazonaws.invoicing#TaxInheritanceDisabledFlag": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.invoicing#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.invoicing#BasicString" + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvoicingThrottling", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.invoicing#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "\n Removes a tag from a resource.\n
", + "smithy.api#examples": [ + { + "title": "UntagResource", + "input": { + "ResourceArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", + "ResourceTagKeys": ["TagKey"] + }, + "output": {} + } + ] + } + }, + "com.amazonaws.invoicing#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.invoicing#TagrisArn", + "traits": { + "smithy.api#documentation": "\n The Amazon Resource Name (ARN) to untag.\n
", + "smithy.api#required": {} + } + }, + "ResourceTagKeys": { + "target": "com.amazonaws.invoicing#ResourceTagKeyList", + "traits": { + "smithy.api#documentation": "\n Keys for the tags to be removed.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.invoicing#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#UpdateInvoiceUnit": { + "type": "operation", + "input": { + "target": "com.amazonaws.invoicing#UpdateInvoiceUnitRequest" + }, + "output": { + "target": "com.amazonaws.invoicing#UpdateInvoiceUnitResponse" + }, + "errors": [ + { + "target": "com.amazonaws.invoicing#AccessDeniedException" + }, + { + "target": "com.amazonaws.invoicing#InternalServerException" + }, + { + "target": "com.amazonaws.invoicing#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.invoicing#ThrottlingException" + }, + { + "target": "com.amazonaws.invoicing#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.
", + "smithy.api#examples": [ + { + "title": "UpdateInvoiceUnit with all updatable fields", + "input": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", + "Description": "Updated IU description", + "TaxInheritanceDisabled": false, + "Rule": { + "LinkedAccounts": ["111111111111", "222222222222"] + } + }, + "output": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + } + }, + { + "title": "UpdateInvoiceUnit with specific fields", + "input": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678", + "Description": "Updated IU description. All other fields remain unchanged" + }, + "output": { + "InvoiceUnitArn": "arn:aws:invoicing::000000000000:invoice-unit/12345678" + } + } + ] + } + }, + "com.amazonaws.invoicing#UpdateInvoiceUnitRequest": { + "type": "structure", + "members": { + "InvoiceUnitArn": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "The ARN to identify an invoice unit. This information can't be modified or deleted.\n
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.invoicing#DescriptionString", + "traits": { + "smithy.api#documentation": "The assigned description for an invoice unit. This information can't be modified or deleted.\n
" + } + }, + "TaxInheritanceDisabled": { + "target": "com.amazonaws.invoicing#TaxInheritanceDisabledFlag", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "Whether the invoice unit based tax inheritance is/ should be enabled or disabled.\n
" + } + }, + "Rule": { + "target": "com.amazonaws.invoicing#InvoiceUnitRule", + "traits": { + "smithy.api#documentation": "The InvoiceUnitRule
object used to update invoice units.\n
\n The ARN to identify an invoice unit. This information can't be modified or deleted.\n
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.invoicing#ValidationException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.invoicing#BasicString" + }, + "resourceName": { + "target": "com.amazonaws.invoicing#InvoiceUnitArnString", + "traits": { + "smithy.api#documentation": "You don't have sufficient access to perform this action.\n
" + } + }, + "reason": { + "target": "com.amazonaws.invoicing#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "You don't have sufficient access to perform this action.\n
" + } + }, + "fieldList": { + "target": "com.amazonaws.invoicing#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "\n The input fails to satisfy the constraints specified by an Amazon Web Services service.\n
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvoicingValidation", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "\n The input fails to satisfy the constraints specified by an Amazon Web Services service.\n
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.invoicing#ValidationExceptionField": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\n The input fails to satisfy the constraints specified by an Amazon Web Services service.\n
", + "smithy.api#required": {} + } + }, + "message": { + "target": "com.amazonaws.invoicing#BasicString", + "traits": { + "smithy.api#documentation": "\n The input fails to satisfy the constraints specified by an Amazon Web Services service.\n
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "\n The input fails to satisfy the constraints specified by an Amazon Web Services service.\n
" + } + }, + "com.amazonaws.invoicing#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.invoicing#ValidationExceptionField" + } + }, + "com.amazonaws.invoicing#ValidationExceptionReason": { + "type": "enum", + "members": { + "NON_MEMBERS_PRESENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "nonMemberPresent" + } + }, + "MAX_ACCOUNTS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "maxAccountsExceeded" + } + }, + "MAX_INVOICE_UNITS_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "maxInvoiceUnitsExceeded" + } + }, + "DUPLICATE_INVOICE_UNIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "duplicateInvoiceUnit" + } + }, + "MUTUAL_EXCLUSION_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "mutualExclusionError" + } + }, + "ACCOUNT_MEMBERSHIP_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "accountMembershipError" + } + }, + "TAX_SETTINGS_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "taxSettingsError" + } + }, + "EXPIRED_NEXT_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "expiredNextToken" + } + }, + "INVALID_NEXT_TOKEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "invalidNextToken" + } + }, + "INVALID_INPUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "invalidInput" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + } + } +}