diff --git a/clients/client-bcm-data-exports/.gitignore b/clients/client-bcm-data-exports/.gitignore new file mode 100644 index 000000000000..54f14c9aef25 --- /dev/null +++ b/clients/client-bcm-data-exports/.gitignore @@ -0,0 +1,9 @@ +/node_modules/ +/build/ +/coverage/ +/docs/ +/dist-* +*.tsbuildinfo +*.tgz +*.log +package-lock.json diff --git a/clients/client-bcm-data-exports/LICENSE b/clients/client-bcm-data-exports/LICENSE new file mode 100644 index 000000000000..5001cd317c44 --- /dev/null +++ b/clients/client-bcm-data-exports/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-2023 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-bcm-data-exports/README.md b/clients/client-bcm-data-exports/README.md new file mode 100644 index 000000000000..e0264d7cd76a --- /dev/null +++ b/clients/client-bcm-data-exports/README.md @@ -0,0 +1,308 @@ + + +# @aws-sdk/client-bcm-data-exports + +## Description + +AWS SDK for JavaScript BCMDataExports Client for Node.js, Browser and React Native. + +
You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost +optimization recommendations.
+The Data Exports API provides the following endpoint:
+https://bcm-data-exports.us-east-1.api.aws
+You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost + * optimization recommendations.
+ *The Data Exports API provides the following endpoint:
+ *https://bcm-data-exports.us-east-1.api.aws
+ *You can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost + * optimization recommendations.
+ *The Data Exports API provides the following endpoint:
+ *https://bcm-data-exports.us-east-1.api.aws
+ *Creates a data export and specifies the data query, the delivery preference, and any + * optional resource tags.
+ *A DataQuery
consists of both a QueryStatement
and
+ * TableConfigurations
.
The QueryStatement
is an SQL statement. Data Exports only supports a limited
+ * subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To
+ * view the available tables and columns, see the Data Exports table
+ * dictionary.
The TableConfigurations
is a collection of specified
+ * TableProperties
for the table being queried in the QueryStatement
.
+ * TableProperties are additional configurations you can provide to change the data and schema of
+ * a table. Each table can have different TableProperties. However, tables are not required to
+ * have any TableProperties. Each table property has a default value that it assumes if not
+ * specified. For more information on table configurations, see Data query. To
+ * view the table properties available for each table, see the Data Exports table
+ * dictionary or use the ListTables
API to get a response of all tables
+ * and their available properties.
An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ServiceQuotaExceededException} (client fault) + *You've reached the limit on the number of resources you can create, or exceeded the size + * of an individual resource.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class CreateExportCommand extends $Command< + CreateExportCommandInput, + CreateExportCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: CreateExportCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes an existing data export.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, DeleteExportCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, DeleteExportCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // DeleteExportRequest + * ExportArn: "STRING_VALUE", // required + * }; + * const command = new DeleteExportCommand(input); + * const response = await client.send(command); + * // { // DeleteExportResponse + * // ExportArn: "STRING_VALUE", + * // }; + * + * ``` + * + * @param DeleteExportCommandInput - {@link DeleteExportCommandInput} + * @returns {@link DeleteExportCommandOutput} + * @see {@link DeleteExportCommandInput} for command's `input` shape. + * @see {@link DeleteExportCommandOutput} for command's `response` shape. + * @see {@link BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class DeleteExportCommand extends $Command< + DeleteExportCommandInput, + DeleteExportCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DeleteExportCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackExports data based on the source data update.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, GetExecutionCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, GetExecutionCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // GetExecutionRequest + * ExportArn: "STRING_VALUE", // required + * ExecutionId: "STRING_VALUE", // required + * }; + * const command = new GetExecutionCommand(input); + * const response = await client.send(command); + * // { // GetExecutionResponse + * // ExecutionId: "STRING_VALUE", + * // Export: { // Export + * // ExportArn: "STRING_VALUE", + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // DataQuery: { // DataQuery + * // QueryStatement: "STRING_VALUE", // required + * // TableConfigurations: { // TableConfigurations + * // "An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class GetExecutionCommand extends $Command< + GetExecutionCommandInput, + GetExecutionCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetExecutionCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackViews the definition of an existing data export.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, GetExportCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, GetExportCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // GetExportRequest + * ExportArn: "STRING_VALUE", // required + * }; + * const command = new GetExportCommand(input); + * const response = await client.send(command); + * // { // GetExportResponse + * // Export: { // Export + * // ExportArn: "STRING_VALUE", + * // Name: "STRING_VALUE", // required + * // Description: "STRING_VALUE", + * // DataQuery: { // DataQuery + * // QueryStatement: "STRING_VALUE", // required + * // TableConfigurations: { // TableConfigurations + * // "An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class GetExportCommand extends $Command< + GetExportCommandInput, + GetExportCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetExportCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackReturns the metadata for the specified table and table properties. This includes the list + * of columns in the table schema, their data types, and column descriptions.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, GetTableCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, GetTableCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // GetTableRequest + * TableName: "STRING_VALUE", // required + * TableProperties: { // TableProperties + * "An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class GetTableCommand extends $Command< + GetTableCommandInput, + GetTableCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: GetTableCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists the historical executions for the export.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, ListExecutionsCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, ListExecutionsCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // ListExecutionsRequest + * ExportArn: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListExecutionsCommand(input); + * const response = await client.send(command); + * // { // ListExecutionsResponse + * // Executions: [ // ExecutionReferenceList + * // { // ExecutionReference + * // ExecutionId: "STRING_VALUE", // required + * // ExecutionStatus: { // ExecutionStatus + * // StatusCode: "INITIATION_IN_PROCESS" || "QUERY_QUEUED" || "QUERY_IN_PROCESS" || "QUERY_FAILURE" || "DELIVERY_IN_PROCESS" || "DELIVERY_SUCCESS" || "DELIVERY_FAILURE", + * // StatusReason: "INSUFFICIENT_PERMISSION" || "BILL_OWNER_CHANGED" || "INTERNAL_FAILURE", + * // CreatedAt: new Date("TIMESTAMP"), + * // CompletedAt: new Date("TIMESTAMP"), + * // LastUpdatedAt: new Date("TIMESTAMP"), + * // }, + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListExecutionsCommandInput - {@link ListExecutionsCommandInput} + * @returns {@link ListExecutionsCommandOutput} + * @see {@link ListExecutionsCommandInput} for command's `input` shape. + * @see {@link ListExecutionsCommandOutput} for command's `response` shape. + * @see {@link BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class ListExecutionsCommand extends $Command< + ListExecutionsCommandInput, + ListExecutionsCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListExecutionsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all data export definitions.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, ListExportsCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, ListExportsCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // ListExportsRequest + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListExportsCommand(input); + * const response = await client.send(command); + * // { // ListExportsResponse + * // Exports: [ // ExportReferenceList + * // { // ExportReference + * // ExportArn: "STRING_VALUE", // required + * // ExportName: "STRING_VALUE", // required + * // ExportStatus: { // ExportStatus + * // StatusCode: "HEALTHY" || "UNHEALTHY", + * // StatusReason: "INSUFFICIENT_PERMISSION" || "BILL_OWNER_CHANGED" || "INTERNAL_FAILURE", + * // CreatedAt: new Date("TIMESTAMP"), + * // LastUpdatedAt: new Date("TIMESTAMP"), + * // LastRefreshedAt: new Date("TIMESTAMP"), + * // }, + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListExportsCommandInput - {@link ListExportsCommandInput} + * @returns {@link ListExportsCommandOutput} + * @see {@link ListExportsCommandInput} for command's `input` shape. + * @see {@link ListExportsCommandOutput} for command's `response` shape. + * @see {@link BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class ListExportsCommand extends $Command< + ListExportsCommandInput, + ListExportsCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListExportsCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackLists all available tables in data exports.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, ListTablesCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, ListTablesCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // ListTablesRequest + * NextToken: "STRING_VALUE", + * MaxResults: Number("int"), + * }; + * const command = new ListTablesCommand(input); + * const response = await client.send(command); + * // { // ListTablesResponse + * // Tables: [ // TableList + * // { // Table + * // TableName: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // TableProperties: [ // TablePropertyDescriptionList + * // { // TablePropertyDescription + * // Name: "STRING_VALUE", + * // ValidValues: [ // GenericStringList + * // "STRING_VALUE", + * // ], + * // DefaultValue: "STRING_VALUE", + * // Description: "STRING_VALUE", + * // }, + * // ], + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @param ListTablesCommandInput - {@link ListTablesCommandInput} + * @returns {@link ListTablesCommandOutput} + * @see {@link ListTablesCommandInput} for command's `input` shape. + * @see {@link ListTablesCommandOutput} for command's `response` shape. + * @see {@link BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class ListTablesCommand extends $Command< + ListTablesCommandInput, + ListTablesCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTablesCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackList tags associated with an existing data export.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, ListTagsForResourceCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, ListTagsForResourceCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // ListTagsForResourceRequest + * ResourceArn: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListTagsForResourceCommand(input); + * const response = await client.send(command); + * // { // ListTagsForResourceResponse + * // ResourceTags: [ // ResourceTagList + * // { // ResourceTag + * // Key: "STRING_VALUE", // required + * // Value: "STRING_VALUE", // required + * // }, + * // ], + * // NextToken: "STRING_VALUE", + * // }; + * + * ``` + * + * @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 BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class ListTagsForResourceCommand extends $Command< + ListTagsForResourceCommandInput, + ListTagsForResourceCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTagsForResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackAdds tags for an existing data export definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, TagResourceCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, TagResourceCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(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 BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class TagResourceCommand extends $Command< + TagResourceCommandInput, + TagResourceCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: TagResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDeletes tags associated with an existing data export definition.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, UntagResourceCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, UntagResourceCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(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 BCMDataExportsClientResolvedConfig | config} for BCMDataExportsClient's `config` shape. + * + * @throws {@link InternalServerException} (server fault) + *An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class UntagResourceCommand extends $Command< + UntagResourceCommandInput, + UntagResourceCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UntagResourceCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates an existing data export by overwriting all export parameters. All export + * parameters must be provided in the UpdateExport request.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { BCMDataExportsClient, UpdateExportCommand } from "@aws-sdk/client-bcm-data-exports"; // ES Modules import + * // const { BCMDataExportsClient, UpdateExportCommand } = require("@aws-sdk/client-bcm-data-exports"); // CommonJS import + * const client = new BCMDataExportsClient(config); + * const input = { // UpdateExportRequest + * ExportArn: "STRING_VALUE", // required + * Export: { // Export + * ExportArn: "STRING_VALUE", + * Name: "STRING_VALUE", // required + * Description: "STRING_VALUE", + * DataQuery: { // DataQuery + * QueryStatement: "STRING_VALUE", // required + * TableConfigurations: { // TableConfigurations + * "An error on the server occurred during the processing of your request. Try again + * later.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ * + * @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 BCMDataExportsServiceException} + *Base exception class for all service exceptions from BCMDataExports service.
+ * + */ +export class UpdateExportCommand extends $Command< + UpdateExportCommandInput, + UpdateExportCommandOutput, + BCMDataExportsClientResolvedConfig +> { + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + }; + } + + /** + * @public + */ + constructor(readonly input: UpdateExportCommandInput) { + super(); + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackYou can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost + * optimization recommendations.
+ *The Data Exports API provides the following endpoint:
+ *https://bcm-data-exports.us-east-1.api.aws
+ *The SQL query of column selections and row filters from the data table you want.
+ */ +export interface DataQuery { + /** + * @public + *The query statement.
+ */ + QueryStatement: string | undefined; + + /** + * @public + *The table configuration.
+ */ + TableConfigurations?: RecordThe compression type, file format, and overwrite preference for the data export.
+ */ +export interface S3OutputConfigurations { + /** + * @public + *The output type for the data export.
+ */ + OutputType: S3OutputType | undefined; + + /** + * @public + *The file format for the data export.
+ */ + Format: FormatOption | undefined; + + /** + * @public + *The compression type for the data export.
+ */ + Compression: CompressionOption | undefined; + + /** + * @public + *The rule to follow when generating a version of the data export file. You have the choice + * to overwrite the previous version or to be delivered in addition to the previous versions. + * Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows + * you to track the changes in cost and usage data over time.
+ */ + Overwrite: OverwriteOption | undefined; +} + +/** + * @public + *Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object + * keys of a data exports file.
+ */ +export interface S3Destination { + /** + * @public + *The name of the Amazon S3 bucket used as the destination of a data export file.
+ */ + S3Bucket: string | undefined; + + /** + * @public + *The S3 path prefix you want prepended to the name of your data export.
+ */ + S3Prefix: string | undefined; + + /** + * @public + *The S3 bucket Region.
+ */ + S3Region: string | undefined; + + /** + * @public + *The output configuration for the data export.
+ */ + S3OutputConfigurations: S3OutputConfigurations | undefined; +} + +/** + * @public + *The destinations used for data exports.
+ */ +export interface DestinationConfigurations { + /** + * @public + *An object that describes the destination of the data exports file.
+ */ + S3Destination: S3Destination | undefined; +} + +/** + * @public + * @enum + */ +export const FrequencyOption = { + SYNCHRONOUS: "SYNCHRONOUS", +} as const; + +/** + * @public + */ +export type FrequencyOption = (typeof FrequencyOption)[keyof typeof FrequencyOption]; + +/** + * @public + *The cadence for Amazon Web Services to update the data export in your S3 bucket.
+ */ +export interface RefreshCadence { + /** + * @public + *The frequency that data exports are updated. The export refreshes each time the source + * data updates, up to three times daily.
+ */ + Frequency: FrequencyOption | undefined; +} + +/** + * @public + *The details that are available for an export.
+ */ +export interface Export { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn?: string; + + /** + * @public + *The name of this specific data export.
+ */ + Name: string | undefined; + + /** + * @public + *The description for this specific data export.
+ */ + Description?: string; + + /** + * @public + *The data query for this specific data export.
+ */ + DataQuery: DataQuery | undefined; + + /** + * @public + *The destination configuration for this specific data export.
+ */ + DestinationConfigurations: DestinationConfigurations | undefined; + + /** + * @public + *The cadence for Amazon Web Services to update the export in your S3 bucket.
+ */ + RefreshCadence: RefreshCadence | undefined; +} + +/** + * @public + *The tag structure that contains a tag key and value.
+ */ +export interface ResourceTag { + /** + * @public + *The key that's associated with the tag.
+ */ + Key: string | undefined; + + /** + * @public + *The value that's associated with the tag.
+ */ + Value: string | undefined; +} + +/** + * @public + */ +export interface CreateExportRequest { + /** + * @public + *The details of the export, including data query, name, description, and destination + * configuration.
+ */ + Export: Export | undefined; + + /** + * @public + *An optional list of tags to associate with the specified export. Each tag consists of a + * key and a value, and each key must be unique for the resource.
+ */ + ResourceTags?: ResourceTag[]; +} + +/** + * @public + */ +export interface CreateExportResponse { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn?: string; +} + +/** + * @public + *An error on the server occurred during the processing of your request. Try again + * later.
+ */ +export class InternalServerException extends __BaseException { + readonly name: "InternalServerException" = "InternalServerException"; + readonly $fault: "server" = "server"; + Message: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeYou've reached the limit on the number of resources you can create, or exceeded the size + * of an individual resource.
+ */ +export class ServiceQuotaExceededException extends __BaseException { + readonly name: "ServiceQuotaExceededException" = "ServiceQuotaExceededException"; + readonly $fault: "client" = "client"; + Message: string | undefined; + /** + * @public + *The identifier of the resource that exceeded quota.
+ */ + ResourceId?: string; + + /** + * @public + *The type of the resource that exceeded quota.
+ */ + ResourceType?: string; + + /** + * @public + *The quota code that was exceeded.
+ */ + QuotaCode: string | undefined; + + /** + * @public + *The service code that exceeded quota. It will always be + * “AWSBillingAndCostManagementDataExports”.
+ */ + ServiceCode: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe request was denied due to request throttling.
+ */ +export class ThrottlingException extends __BaseException { + readonly name: "ThrottlingException" = "ThrottlingException"; + readonly $fault: "client" = "client"; + Message: string | undefined; + /** + * @public + *The quota code that exceeded the throttling limit.
+ */ + QuotaCode?: string; + + /** + * @public + *The service code that exceeded the throttling limit. It will always be + * “AWSBillingAndCostManagementDataExports”.
+ */ + ServiceCode?: string; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe input failed to meet the constraints specified by the Amazon Web Services service in a + * specified field.
+ */ +export interface ValidationExceptionField { + /** + * @public + *The field name where the invalid entry was detected.
+ */ + Name: string | undefined; + + /** + * @public + *A message with the reason for the validation exception error.
+ */ + Message: string | undefined; +} + +/** + * @public + * @enum + */ +export const ValidationExceptionReason = { + CANNOT_PARSE: "cannotParse", + FIELD_VALIDATION_FAILED: "fieldValidationFailed", + OTHER: "other", + UNKNOWN_OPERATION: "unknownOperation", +} as const; + +/** + * @public + */ +export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason]; + +/** + * @public + *The input fails to satisfy the constraints specified by an Amazon Web Services + * service.
+ */ +export class ValidationException extends __BaseException { + readonly name: "ValidationException" = "ValidationException"; + readonly $fault: "client" = "client"; + Message: string | undefined; + /** + * @public + *The reason for the validation exception.
+ */ + Reason?: ValidationExceptionReason; + + /** + * @public + *The list of fields that are invalid.
+ */ + Fields?: ValidationExceptionField[]; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) for this export.
+ */ + ExportArn: string | undefined; +} + +/** + * @public + */ +export interface DeleteExportResponse { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn?: string; +} + +/** + * @public + *The specified Amazon Resource Name (ARN) in the request doesn't exist.
+ */ +export class ResourceNotFoundException extends __BaseException { + readonly name: "ResourceNotFoundException" = "ResourceNotFoundException"; + readonly $fault: "client" = "client"; + Message: string | undefined; + /** + * @public + *The identifier of the resource that was not found.
+ */ + ResourceId: string | undefined; + + /** + * @public + *The type of the resource that was not found.
+ */ + ResourceType: string | undefined; + /** + * @internal + */ + constructor(opts: __ExceptionOptionTypeThe Amazon Resource Name (ARN) of the Export object that generated this specific + * execution.
+ */ + ExportArn: string | undefined; + + /** + * @public + *The ID for this specific execution.
+ */ + ExecutionId: string | undefined; +} + +/** + * @public + * @enum + */ +export const ExecutionStatusCode = { + DELIVERY_FAILURE: "DELIVERY_FAILURE", + DELIVERY_IN_PROCESS: "DELIVERY_IN_PROCESS", + DELIVERY_SUCCESS: "DELIVERY_SUCCESS", + INITIATION_IN_PROCESS: "INITIATION_IN_PROCESS", + QUERY_FAILURE: "QUERY_FAILURE", + QUERY_IN_PROCESS: "QUERY_IN_PROCESS", + QUERY_QUEUED: "QUERY_QUEUED", +} as const; + +/** + * @public + */ +export type ExecutionStatusCode = (typeof ExecutionStatusCode)[keyof typeof ExecutionStatusCode]; + +/** + * @public + * @enum + */ +export const ExecutionStatusReason = { + BILL_OWNER_CHANGED: "BILL_OWNER_CHANGED", + INSUFFICIENT_PERMISSION: "INSUFFICIENT_PERMISSION", + INTERNAL_FAILURE: "INTERNAL_FAILURE", +} as const; + +/** + * @public + */ +export type ExecutionStatusReason = (typeof ExecutionStatusReason)[keyof typeof ExecutionStatusReason]; + +/** + * @public + *The status of the execution.
+ */ +export interface ExecutionStatus { + /** + * @public + *The code for the status of the execution.
+ */ + StatusCode?: ExecutionStatusCode; + + /** + * @public + *The reason for the failed status.
+ */ + StatusReason?: ExecutionStatusReason; + + /** + * @public + *The time when the execution was created.
+ */ + CreatedAt?: Date; + + /** + * @public + *The time when the execution was completed.
+ */ + CompletedAt?: Date; + + /** + * @public + *The time when the execution was last updated.
+ */ + LastUpdatedAt?: Date; +} + +/** + * @public + */ +export interface GetExecutionResponse { + /** + * @public + *The ID for this specific execution.
+ */ + ExecutionId?: string; + + /** + * @public + *The export data for this specific execution. This export data is a snapshot from when the + * execution was generated. The data could be different from the current export data if the + * export was updated since the execution was generated.
+ */ + Export?: Export; + + /** + * @public + *The status of this specific execution.
+ */ + ExecutionStatus?: ExecutionStatus; +} + +/** + * @public + */ +export interface GetExportRequest { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn: string | undefined; +} + +/** + * @public + * @enum + */ +export const ExportStatusCode = { + HEALTHY: "HEALTHY", + UNHEALTHY: "UNHEALTHY", +} as const; + +/** + * @public + */ +export type ExportStatusCode = (typeof ExportStatusCode)[keyof typeof ExportStatusCode]; + +/** + * @public + *The status of the data export.
+ */ +export interface ExportStatus { + /** + * @public + *The status code for the request.
+ */ + StatusCode?: ExportStatusCode; + + /** + * @public + *The description for the status code.
+ */ + StatusReason?: ExecutionStatusReason; + + /** + * @public + *The timestamp of when the export was created.
+ */ + CreatedAt?: Date; + + /** + * @public + *The timestamp of when the export was updated.
+ */ + LastUpdatedAt?: Date; + + /** + * @public + *The timestamp of when the export was last generated.
+ */ + LastRefreshedAt?: Date; +} + +/** + * @public + */ +export interface GetExportResponse { + /** + * @public + *The data for this specific export.
+ */ + Export?: Export; + + /** + * @public + *The status of this specific export.
+ */ + ExportStatus?: ExportStatus; +} + +/** + * @public + */ +export interface GetTableRequest { + /** + * @public + *The name of the table.
+ */ + TableName: string | undefined; + + /** + * @public + *TableProperties are additional configurations you can provide to change the data and + * schema of a table. Each table can have different TableProperties. Tables are not required to + * have any TableProperties. Each table property has a default value that it assumes if not + * specified.
+ */ + TableProperties?: RecordIncludes basic information for a data column such as its description, name, and + * type.
+ */ +export interface Column { + /** + * @public + *The column name.
+ */ + Name?: string; + + /** + * @public + *The kind of data a column stores.
+ */ + Type?: string; + + /** + * @public + *The description for a column.
+ */ + Description?: string; +} + +/** + * @public + */ +export interface GetTableResponse { + /** + * @public + *The name of the table.
+ */ + TableName?: string; + + /** + * @public + *The table description.
+ */ + Description?: string; + + /** + * @public + *TableProperties are additional configurations you can provide to change the data and + * schema of a table. Each table can have different TableProperties. Tables are not required to + * have any TableProperties. Each table property has a default value that it assumes if not + * specified.
+ */ + TableProperties?: RecordThe schema of the table.
+ */ + Schema?: Column[]; +} + +/** + * @public + */ +export interface ListExecutionsRequest { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn: string | undefined; + + /** + * @public + *The maximum number of objects that are returned for the request.
+ */ + MaxResults?: number; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + *The reference for the data export update.
+ */ +export interface ExecutionReference { + /** + * @public + *The ID for this specific execution.
+ */ + ExecutionId: string | undefined; + + /** + * @public + *The status of this specific execution.
+ */ + ExecutionStatus: ExecutionStatus | undefined; +} + +/** + * @public + */ +export interface ListExecutionsResponse { + /** + * @public + *The list of executions.
+ */ + Executions?: ExecutionReference[]; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListExportsRequest { + /** + * @public + *The maximum number of objects that are returned for the request.
+ */ + MaxResults?: number; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + *The reference details for a given export.
+ */ +export interface ExportReference { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn: string | undefined; + + /** + * @public + *The name of this specific data export.
+ */ + ExportName: string | undefined; + + /** + * @public + *The status of this specific data export.
+ */ + ExportStatus: ExportStatus | undefined; +} + +/** + * @public + */ +export interface ListExportsResponse { + /** + * @public + *The details of the exports, including name and export status.
+ */ + Exports?: ExportReference[]; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTablesRequest { + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; + + /** + * @public + *The maximum number of objects that are returned for the request.
+ */ + MaxResults?: number; +} + +/** + * @public + *The properties for the data export table.
+ */ +export interface TablePropertyDescription { + /** + * @public + *The name of the table.
+ */ + Name?: string; + + /** + * @public + *The valid values for the table.
+ */ + ValidValues?: string[]; + + /** + * @public + *The default value for the table.
+ */ + DefaultValue?: string; + + /** + * @public + *The description for the table.
+ */ + Description?: string; +} + +/** + * @public + *The details for the data export table.
+ */ +export interface Table { + /** + * @public + *The name of the table.
+ */ + TableName?: string; + + /** + * @public + *The description for the table.
+ */ + Description?: string; + + /** + * @public + *The properties for the table.
+ */ + TableProperties?: TablePropertyDescription[]; +} + +/** + * @public + */ +export interface ListTablesResponse { + /** + * @public + *The list of tables.
+ */ + Tables?: Table[]; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceRequest { + /** + * @public + *The unique identifier for the resource.
+ */ + ResourceArn: string | undefined; + + /** + * @public + *The maximum number of objects that are returned for the request.
+ */ + MaxResults?: number; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface ListTagsForResourceResponse { + /** + * @public + *An optional list of tags to associate with the specified export. Each tag consists of a + * key and a value, and each key must be unique for the resource.
+ */ + ResourceTags?: ResourceTag[]; + + /** + * @public + *The token to retrieve the next set of results.
+ */ + NextToken?: string; +} + +/** + * @public + */ +export interface TagResourceRequest { + /** + * @public + *The unique identifier for the resource.
+ */ + ResourceArn: string | undefined; + + /** + * @public + *The tags to associate with the resource. Each tag consists of a key and a value, and each + * key must be unique for the resource.
+ */ + ResourceTags: ResourceTag[] | undefined; +} + +/** + * @public + */ +export interface TagResourceResponse {} + +/** + * @public + */ +export interface UntagResourceRequest { + /** + * @public + *The unique identifier for the resource.
+ */ + ResourceArn: string | undefined; + + /** + * @public + *The tag keys that are associated with the resource ARN.
+ */ + ResourceTagKeys: string[] | undefined; +} + +/** + * @public + */ +export interface UntagResourceResponse {} + +/** + * @public + */ +export interface UpdateExportRequest { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn: string | undefined; + + /** + * @public + *The name and query details for the export.
+ */ + Export: Export | undefined; +} + +/** + * @public + */ +export interface UpdateExportResponse { + /** + * @public + *The Amazon Resource Name (ARN) for this export.
+ */ + ExportArn?: string; +} diff --git a/clients/client-bcm-data-exports/src/pagination/Interfaces.ts b/clients/client-bcm-data-exports/src/pagination/Interfaces.ts new file mode 100644 index 000000000000..e3324fa98879 --- /dev/null +++ b/clients/client-bcm-data-exports/src/pagination/Interfaces.ts @@ -0,0 +1,11 @@ +// smithy-typescript generated code +import { PaginationConfiguration } from "@smithy/types"; + +import { BCMDataExportsClient } from "../BCMDataExportsClient"; + +/** + * @public + */ +export interface BCMDataExportsPaginationConfiguration extends PaginationConfiguration { + client: BCMDataExportsClient; +} diff --git a/clients/client-bcm-data-exports/src/pagination/ListExecutionsPaginator.ts b/clients/client-bcm-data-exports/src/pagination/ListExecutionsPaginator.ts new file mode 100644 index 000000000000..7ee1fd71b974 --- /dev/null +++ b/clients/client-bcm-data-exports/src/pagination/ListExecutionsPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { BCMDataExportsClient } from "../BCMDataExportsClient"; +import { + ListExecutionsCommand, + ListExecutionsCommandInput, + ListExecutionsCommandOutput, +} from "../commands/ListExecutionsCommand"; +import { BCMDataExportsPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: BCMDataExportsClient, + input: ListExecutionsCommandInput, + ...args: any +): PromiseYou can use the Data Exports API to create customized exports from multiple Amazon Web Services cost management and billing datasets, such as cost and usage data and cost\n optimization recommendations.
\nThe Data Exports API provides the following endpoint:
\nhttps://bcm-data-exports.us-east-1.api.aws
\nThe column name.
" + } + }, + "Type": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The kind of data a column stores.
" + } + }, + "Description": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The description for a column.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Includes basic information for a data column such as its description, name, and\n type.
" + } + }, + "com.amazonaws.bcmdataexports#ColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#Column" + } + }, + "com.amazonaws.bcmdataexports#CompressionOption": { + "type": "enum", + "members": { + "GZIP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GZIP" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + } + } + }, + "com.amazonaws.bcmdataexports#CreateExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#CreateExportRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#CreateExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a data export and specifies the data query, the delivery preference, and any\n optional resource tags.
\nA DataQuery
consists of both a QueryStatement
and\n TableConfigurations
.
The QueryStatement
is an SQL statement. Data Exports only supports a limited\n subset of the SQL syntax. For more information on the SQL syntax that is supported, see Data query. To\n view the available tables and columns, see the Data Exports table\n dictionary.
The TableConfigurations
is a collection of specified\n TableProperties
for the table being queried in the QueryStatement
.\n TableProperties are additional configurations you can provide to change the data and schema of\n a table. Each table can have different TableProperties. However, tables are not required to\n have any TableProperties. Each table property has a default value that it assumes if not\n specified. For more information on table configurations, see Data query. To\n view the table properties available for each table, see the Data Exports table\n dictionary or use the ListTables
API to get a response of all tables\n and their available properties.
The details of the export, including data query, name, description, and destination\n configuration.
", + "smithy.api#required": {} + } + }, + "ResourceTags": { + "target": "com.amazonaws.bcmdataexports#ResourceTagList", + "traits": { + "smithy.api#documentation": "An optional list of tags to associate with the specified export. Each tag consists of a\n key and a value, and each key must be unique for the resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#CreateExportResponse": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#DataQuery": { + "type": "structure", + "members": { + "QueryStatement": { + "target": "com.amazonaws.bcmdataexports#QueryStatement", + "traits": { + "smithy.api#documentation": "The query statement.
", + "smithy.api#required": {} + } + }, + "TableConfigurations": { + "target": "com.amazonaws.bcmdataexports#TableConfigurations", + "traits": { + "smithy.api#documentation": "The table configuration.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The SQL query of column selections and row filters from the data table you want.
" + } + }, + "com.amazonaws.bcmdataexports#DeleteExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#DeleteExportRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#DeleteExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing data export.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.bcmdataexports#DeleteExportRequest": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#DeleteExportResponse": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#DestinationConfigurations": { + "type": "structure", + "members": { + "S3Destination": { + "target": "com.amazonaws.bcmdataexports#S3Destination", + "traits": { + "smithy.api#documentation": "An object that describes the destination of the data exports file.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The destinations used for data exports.
" + } + }, + "com.amazonaws.bcmdataexports#ExecutionReference": { + "type": "structure", + "members": { + "ExecutionId": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The ID for this specific execution.
", + "smithy.api#required": {} + } + }, + "ExecutionStatus": { + "target": "com.amazonaws.bcmdataexports#ExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of this specific execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The reference for the data export update.
" + } + }, + "com.amazonaws.bcmdataexports#ExecutionReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#ExecutionReference" + } + }, + "com.amazonaws.bcmdataexports#ExecutionStatus": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.bcmdataexports#ExecutionStatusCode", + "traits": { + "smithy.api#documentation": "The code for the status of the execution.
" + } + }, + "StatusReason": { + "target": "com.amazonaws.bcmdataexports#ExecutionStatusReason", + "traits": { + "smithy.api#documentation": "The reason for the failed status.
" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the execution was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "CompletedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the execution was completed.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the execution was last updated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the execution.
" + } + }, + "com.amazonaws.bcmdataexports#ExecutionStatusCode": { + "type": "enum", + "members": { + "INITIATION_IN_PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIATION_IN_PROCESS" + } + }, + "QUERY_QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_QUEUED" + } + }, + "QUERY_IN_PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_IN_PROCESS" + } + }, + "QUERY_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_FAILURE" + } + }, + "DELIVERY_IN_PROCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY_IN_PROCESS" + } + }, + "DELIVERY_SUCCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY_SUCCESS" + } + }, + "DELIVERY_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELIVERY_FAILURE" + } + } + } + }, + "com.amazonaws.bcmdataexports#ExecutionStatusReason": { + "type": "enum", + "members": { + "INSUFFICIENT_PERMISSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_PERMISSION" + } + }, + "BILL_OWNER_CHANGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILL_OWNER_CHANGED" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + } + } + }, + "com.amazonaws.bcmdataexports#Export": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
" + } + }, + "Name": { + "target": "com.amazonaws.bcmdataexports#ExportName", + "traits": { + "smithy.api#documentation": "The name of this specific data export.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The description for this specific data export.
" + } + }, + "DataQuery": { + "target": "com.amazonaws.bcmdataexports#DataQuery", + "traits": { + "smithy.api#documentation": "The data query for this specific data export.
", + "smithy.api#required": {} + } + }, + "DestinationConfigurations": { + "target": "com.amazonaws.bcmdataexports#DestinationConfigurations", + "traits": { + "smithy.api#documentation": "The destination configuration for this specific data export.
", + "smithy.api#required": {} + } + }, + "RefreshCadence": { + "target": "com.amazonaws.bcmdataexports#RefreshCadence", + "traits": { + "smithy.api#documentation": "The cadence for Amazon Web Services to update the export in your S3 bucket.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details that are available for an export.
" + } + }, + "com.amazonaws.bcmdataexports#ExportName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[0-9A-Za-z!\\-_.*\\'()]+$" + } + }, + "com.amazonaws.bcmdataexports#ExportReference": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
", + "smithy.api#required": {} + } + }, + "ExportName": { + "target": "com.amazonaws.bcmdataexports#ExportName", + "traits": { + "smithy.api#documentation": "The name of this specific data export.
", + "smithy.api#required": {} + } + }, + "ExportStatus": { + "target": "com.amazonaws.bcmdataexports#ExportStatus", + "traits": { + "smithy.api#documentation": "The status of this specific data export.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The reference details for a given export.
" + } + }, + "com.amazonaws.bcmdataexports#ExportReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#ExportReference" + } + }, + "com.amazonaws.bcmdataexports#ExportStatus": { + "type": "structure", + "members": { + "StatusCode": { + "target": "com.amazonaws.bcmdataexports#ExportStatusCode", + "traits": { + "smithy.api#documentation": "The status code for the request.
" + } + }, + "StatusReason": { + "target": "com.amazonaws.bcmdataexports#ExecutionStatusReason", + "traits": { + "smithy.api#documentation": "The description for the status code.
" + } + }, + "CreatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export was created.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastUpdatedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export was updated.
", + "smithy.api#timestampFormat": "date-time" + } + }, + "LastRefreshedAt": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of when the export was last generated.
", + "smithy.api#timestampFormat": "date-time" + } + } + }, + "traits": { + "smithy.api#documentation": "The status of the data export.
" + } + }, + "com.amazonaws.bcmdataexports#ExportStatusCode": { + "type": "enum", + "members": { + "HEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEALTHY" + } + }, + "UNHEALTHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNHEALTHY" + } + } + } + }, + "com.amazonaws.bcmdataexports#FormatOption": { + "type": "enum", + "members": { + "TEXT_OR_CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_OR_CSV" + } + }, + "PARQUET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARQUET" + } + } + } + }, + "com.amazonaws.bcmdataexports#FrequencyOption": { + "type": "enum", + "members": { + "SYNCHRONOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SYNCHRONOUS" + } + } + } + }, + "com.amazonaws.bcmdataexports#GenericString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdataexports#GenericStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#GenericString" + } + }, + "com.amazonaws.bcmdataexports#GetExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#GetExecutionRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#GetExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Exports data based on the source data update.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#GetExecutionRequest": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Export object that generated this specific\n execution.
", + "smithy.api#required": {} + } + }, + "ExecutionId": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The ID for this specific execution.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#GetExecutionResponse": { + "type": "structure", + "members": { + "ExecutionId": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The ID for this specific execution.
" + } + }, + "Export": { + "target": "com.amazonaws.bcmdataexports#Export", + "traits": { + "smithy.api#documentation": "The export data for this specific execution. This export data is a snapshot from when the\n execution was generated. The data could be different from the current export data if the\n export was updated since the execution was generated.
" + } + }, + "ExecutionStatus": { + "target": "com.amazonaws.bcmdataexports#ExecutionStatus", + "traits": { + "smithy.api#documentation": "The status of this specific execution.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#GetExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#GetExportRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#GetExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Views the definition of an existing data export.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#GetExportRequest": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#GetExportResponse": { + "type": "structure", + "members": { + "Export": { + "target": "com.amazonaws.bcmdataexports#Export", + "traits": { + "smithy.api#documentation": "The data for this specific export.
" + } + }, + "ExportStatus": { + "target": "com.amazonaws.bcmdataexports#ExportStatus", + "traits": { + "smithy.api#documentation": "The status of this specific export.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#GetTable": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#GetTableRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#GetTableResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the metadata for the specified table and table properties. This includes the list\n of columns in the table schema, their data types, and column descriptions.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#GetTableRequest": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.bcmdataexports#TableName", + "traits": { + "smithy.api#documentation": "The name of the table.
", + "smithy.api#required": {} + } + }, + "TableProperties": { + "target": "com.amazonaws.bcmdataexports#TableProperties", + "traits": { + "smithy.api#documentation": "TableProperties are additional configurations you can provide to change the data and\n schema of a table. Each table can have different TableProperties. Tables are not required to\n have any TableProperties. Each table property has a default value that it assumes if not\n specified.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#GetTableResponse": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.bcmdataexports#TableName", + "traits": { + "smithy.api#documentation": "The name of the table.
" + } + }, + "Description": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The table description.
" + } + }, + "TableProperties": { + "target": "com.amazonaws.bcmdataexports#TableProperties", + "traits": { + "smithy.api#documentation": "TableProperties are additional configurations you can provide to change the data and\n schema of a table. Each table can have different TableProperties. Tables are not required to\n have any TableProperties. Each table property has a default value that it assumes if not\n specified.
" + } + }, + "Schema": { + "target": "com.amazonaws.bcmdataexports#ColumnList", + "traits": { + "smithy.api#documentation": "The schema of the table.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An error on the server occurred during the processing of your request. Try again\n later.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.bcmdataexports#ListExecutions": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#ListExecutionsRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#ListExecutionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the historical executions for the export.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Executions" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#ListExecutionsRequest": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.bcmdataexports#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of objects that are returned for the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#ListExecutionsResponse": { + "type": "structure", + "members": { + "Executions": { + "target": "com.amazonaws.bcmdataexports#ExecutionReferenceList", + "traits": { + "smithy.api#documentation": "The list of executions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#ListExports": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#ListExportsRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#ListExportsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all data export definitions.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Exports" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#ListExportsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.bcmdataexports#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of objects that are returned for the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#ListExportsResponse": { + "type": "structure", + "members": { + "Exports": { + "target": "com.amazonaws.bcmdataexports#ExportReferenceList", + "traits": { + "smithy.api#documentation": "The details of the exports, including name and export status.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#ListTables": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#ListTablesRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#ListTablesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all available tables in data exports.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults", + "items": "Tables" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#ListTablesRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.bcmdataexports#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of objects that are returned for the request.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#ListTablesResponse": { + "type": "structure", + "members": { + "Tables": { + "target": "com.amazonaws.bcmdataexports#TableList", + "traits": { + "smithy.api#documentation": "The list of tables.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "List tags associated with an existing data export.
", + "smithy.api#readonly": {} + } + }, + "com.amazonaws.bcmdataexports#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The unique identifier for the resource.
", + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.bcmdataexports#MaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of objects that are returned for the request.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "ResourceTags": { + "target": "com.amazonaws.bcmdataexports#ResourceTagList", + "traits": { + "smithy.api#documentation": "An optional list of tags to associate with the specified export. Each tag consists of a\n key and a value, and each key must be unique for the resource.
" + } + }, + "NextToken": { + "target": "com.amazonaws.bcmdataexports#NextPageToken", + "traits": { + "smithy.api#documentation": "The token to retrieve the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.bcmdataexports#NextPageToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 8192 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdataexports#OverwriteOption": { + "type": "enum", + "members": { + "CREATE_NEW_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATE_NEW_REPORT" + } + }, + "OVERWRITE_REPORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OVERWRITE_REPORT" + } + } + } + }, + "com.amazonaws.bcmdataexports#QueryStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 36000 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdataexports#RefreshCadence": { + "type": "structure", + "members": { + "Frequency": { + "target": "com.amazonaws.bcmdataexports#FrequencyOption", + "traits": { + "smithy.api#documentation": "The frequency that data exports are updated. The export refreshes each time the source\n data updates, up to three times daily.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The cadence for Amazon Web Services to update the data export in your S3 bucket.
" + } + }, + "com.amazonaws.bcmdataexports#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The identifier of the resource that was not found.
", + "smithy.api#required": {} + } + }, + "ResourceType": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The type of the resource that was not found.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The specified Amazon Resource Name (ARN) in the request doesn't exist.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.bcmdataexports#ResourceTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.bcmdataexports#ResourceTagKey", + "traits": { + "smithy.api#documentation": "The key that's associated with the tag.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.bcmdataexports#ResourceTagValue", + "traits": { + "smithy.api#documentation": "The value that's associated with the tag.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The tag structure that contains a tag key and value.
" + } + }, + "com.amazonaws.bcmdataexports#ResourceTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.bcmdataexports#ResourceTagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#ResourceTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bcmdataexports#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#ResourceTag" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.bcmdataexports#ResourceTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.bcmdataexports#S3Destination": { + "type": "structure", + "members": { + "S3Bucket": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The name of the Amazon S3 bucket used as the destination of a data export file.
", + "smithy.api#required": {} + } + }, + "S3Prefix": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The S3 path prefix you want prepended to the name of your data export.
", + "smithy.api#required": {} + } + }, + "S3Region": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The S3 bucket Region.
", + "smithy.api#required": {} + } + }, + "S3OutputConfigurations": { + "target": "com.amazonaws.bcmdataexports#S3OutputConfigurations", + "traits": { + "smithy.api#documentation": "The output configuration for the data export.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object\n keys of a data exports file.
" + } + }, + "com.amazonaws.bcmdataexports#S3OutputConfigurations": { + "type": "structure", + "members": { + "OutputType": { + "target": "com.amazonaws.bcmdataexports#S3OutputType", + "traits": { + "smithy.api#documentation": "The output type for the data export.
", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.bcmdataexports#FormatOption", + "traits": { + "smithy.api#documentation": "The file format for the data export.
", + "smithy.api#required": {} + } + }, + "Compression": { + "target": "com.amazonaws.bcmdataexports#CompressionOption", + "traits": { + "smithy.api#documentation": "The compression type for the data export.
", + "smithy.api#required": {} + } + }, + "Overwrite": { + "target": "com.amazonaws.bcmdataexports#OverwriteOption", + "traits": { + "smithy.api#documentation": "The rule to follow when generating a version of the data export file. You have the choice\n to overwrite the previous version or to be delivered in addition to the previous versions.\n Overwriting exports can save on Amazon S3 storage costs. Creating new export versions allows\n you to track the changes in cost and usage data over time.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The compression type, file format, and overwrite preference for the data export.
" + } + }, + "com.amazonaws.bcmdataexports#S3OutputType": { + "type": "enum", + "members": { + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.bcmdataexports#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#required": {} + } + }, + "ResourceId": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The identifier of the resource that exceeded quota.
" + } + }, + "ResourceType": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The type of the resource that exceeded quota.
" + } + }, + "QuotaCode": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The quota code that was exceeded.
", + "smithy.api#required": {} + } + }, + "ServiceCode": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The service code that exceeded quota. It will always be\n “AWSBillingAndCostManagementDataExports”.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "You've reached the limit on the number of resources you can create, or exceeded the size\n of an individual resource.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.bcmdataexports#Table": { + "type": "structure", + "members": { + "TableName": { + "target": "com.amazonaws.bcmdataexports#TableName", + "traits": { + "smithy.api#documentation": "The name of the table.
" + } + }, + "Description": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The description for the table.
" + } + }, + "TableProperties": { + "target": "com.amazonaws.bcmdataexports#TablePropertyDescriptionList", + "traits": { + "smithy.api#documentation": "The properties for the table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the data export table.
" + } + }, + "com.amazonaws.bcmdataexports#TableConfigurations": { + "type": "map", + "key": { + "target": "com.amazonaws.bcmdataexports#TableName" + }, + "value": { + "target": "com.amazonaws.bcmdataexports#TableProperties" + } + }, + "com.amazonaws.bcmdataexports#TableList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#Table" + } + }, + "com.amazonaws.bcmdataexports#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdataexports#TableProperties": { + "type": "map", + "key": { + "target": "com.amazonaws.bcmdataexports#TableProperty" + }, + "value": { + "target": "com.amazonaws.bcmdataexports#GenericString" + } + }, + "com.amazonaws.bcmdataexports#TableProperty": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + }, + "smithy.api#pattern": "^[\\S\\s]*$" + } + }, + "com.amazonaws.bcmdataexports#TablePropertyDescription": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The name of the table.
" + } + }, + "ValidValues": { + "target": "com.amazonaws.bcmdataexports#GenericStringList", + "traits": { + "smithy.api#documentation": "The valid values for the table.
" + } + }, + "DefaultValue": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The default value for the table.
" + } + }, + "Description": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The description for the table.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties for the data export table.
" + } + }, + "com.amazonaws.bcmdataexports#TablePropertyDescriptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#TablePropertyDescription" + } + }, + "com.amazonaws.bcmdataexports#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds tags for an existing data export definition.
" + } + }, + "com.amazonaws.bcmdataexports#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The unique identifier for the resource.
", + "smithy.api#required": {} + } + }, + "ResourceTags": { + "target": "com.amazonaws.bcmdataexports#ResourceTagList", + "traits": { + "smithy.api#documentation": "The tags to associate with the resource. Each tag consists of a key and a value, and each\n key must be unique for the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#TagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#required": {} + } + }, + "QuotaCode": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The quota code that exceeded the throttling limit.
" + } + }, + "ServiceCode": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The service code that exceeded the throttling limit. It will always be\n “AWSBillingAndCostManagementDataExports”.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The request was denied due to request throttling.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.bcmdataexports#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes tags associated with an existing data export definition.
" + } + }, + "com.amazonaws.bcmdataexports#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The unique identifier for the resource.
", + "smithy.api#required": {} + } + }, + "ResourceTagKeys": { + "target": "com.amazonaws.bcmdataexports#ResourceTagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys that are associated with the resource ARN.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#UntagResourceResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#UpdateExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.bcmdataexports#UpdateExportRequest" + }, + "output": { + "target": "com.amazonaws.bcmdataexports#UpdateExportResponse" + }, + "errors": [ + { + "target": "com.amazonaws.bcmdataexports#InternalServerException" + }, + { + "target": "com.amazonaws.bcmdataexports#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.bcmdataexports#ThrottlingException" + }, + { + "target": "com.amazonaws.bcmdataexports#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an existing data export by overwriting all export parameters. All export\n parameters must be provided in the UpdateExport request.
" + } + }, + "com.amazonaws.bcmdataexports#UpdateExportRequest": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
", + "smithy.api#required": {} + } + }, + "Export": { + "target": "com.amazonaws.bcmdataexports#Export", + "traits": { + "smithy.api#documentation": "The name and query details for the export.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.bcmdataexports#UpdateExportResponse": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.bcmdataexports#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for this export.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.bcmdataexports#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#required": {} + } + }, + "Reason": { + "target": "com.amazonaws.bcmdataexports#ValidationExceptionReason", + "traits": { + "smithy.api#documentation": "The reason for the validation exception.
" + } + }, + "Fields": { + "target": "com.amazonaws.bcmdataexports#ValidationExceptionFieldList", + "traits": { + "smithy.api#documentation": "The list of fields that are invalid.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The input fails to satisfy the constraints specified by an Amazon Web Services\n service.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.bcmdataexports#ValidationExceptionField": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "The field name where the invalid entry was detected.
", + "smithy.api#required": {} + } + }, + "Message": { + "target": "com.amazonaws.bcmdataexports#GenericString", + "traits": { + "smithy.api#documentation": "A message with the reason for the validation exception error.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The input failed to meet the constraints specified by the Amazon Web Services service in a\n specified field.
" + } + }, + "com.amazonaws.bcmdataexports#ValidationExceptionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.bcmdataexports#ValidationExceptionField" + } + }, + "com.amazonaws.bcmdataexports#ValidationExceptionReason": { + "type": "enum", + "members": { + "UNKNOWN_OPERATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "unknownOperation" + } + }, + "CANNOT_PARSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "cannotParse" + } + }, + "FIELD_VALIDATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "fieldValidationFailed" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "other" + } + } + } + } + } +}