@aws-sdk/client-s3tables 3.787.0 → 3.796.0

package/dist-types/commands/GetTableBucketEncryptionCommand.d.ts

@@ -0,0 +1,99 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetTableBucketEncryptionRequest, GetTableBucketEncryptionResponse } from "../models/models_0";
+import { S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3TablesClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetTableBucketEncryptionCommand}.
+ */
+export interface GetTableBucketEncryptionCommandInput extends GetTableBucketEncryptionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetTableBucketEncryptionCommand}.
+ */
+export interface GetTableBucketEncryptionCommandOutput extends GetTableBucketEncryptionResponse, __MetadataBearer {
+}
+declare const GetTableBucketEncryptionCommand_base: {
+    new (input: GetTableBucketEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl<GetTableBucketEncryptionCommandInput, GetTableBucketEncryptionCommandOutput, S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetTableBucketEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl<GetTableBucketEncryptionCommandInput, GetTableBucketEncryptionCommandOutput, S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Gets the encryption configuration for a table bucket.</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableBucketEncryption</code> permission to use this operation.</p>
+ *             </dd>
+ *          </dl>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3TablesClient, GetTableBucketEncryptionCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
+ * // const { S3TablesClient, GetTableBucketEncryptionCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
+ * const client = new S3TablesClient(config);
+ * const input = { // GetTableBucketEncryptionRequest
+ *   tableBucketARN: "STRING_VALUE", // required
+ * };
+ * const command = new GetTableBucketEncryptionCommand(input);
+ * const response = await client.send(command);
+ * // { // GetTableBucketEncryptionResponse
+ * //   encryptionConfiguration: { // EncryptionConfiguration
+ * //     sseAlgorithm: "AES256" || "aws:kms", // required
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetTableBucketEncryptionCommandInput - {@link GetTableBucketEncryptionCommandInput}
+ * @returns {@link GetTableBucketEncryptionCommandOutput}
+ * @see {@link GetTableBucketEncryptionCommandInput} for command's `input` shape.
+ * @see {@link GetTableBucketEncryptionCommandOutput} for command's `response` shape.
+ * @see {@link S3TablesClientResolvedConfig | config} for S3TablesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The action cannot be performed because you do not have the required permission.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The request is invalid or malformed.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The caller isn't authorized to make the request.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource could not be found.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link S3TablesServiceException}
+ * <p>Base exception class for all service exceptions from S3Tables service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetTableBucketEncryptionCommand extends GetTableBucketEncryptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetTableBucketEncryptionRequest;
+            output: GetTableBucketEncryptionResponse;
+        };
+        sdk: {
+            input: GetTableBucketEncryptionCommandInput;
+            output: GetTableBucketEncryptionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetTableCommand.d.ts

@@ -54,6 +54,7 @@ declare const GetTableCommand_base: {
  * //   namespace: [ // NamespaceList // required
  * //     "STRING_VALUE",
  * //   ],
+ * //   namespaceId: "STRING_VALUE",
  * //   versionToken: "STRING_VALUE", // required
  * //   metadataLocation: "STRING_VALUE",
  * //   warehouseLocation: "STRING_VALUE", // required
@@ -64,6 +65,7 @@ declare const GetTableCommand_base: {
  * //   modifiedBy: "STRING_VALUE", // required
  * //   ownerAccountId: "STRING_VALUE", // required
  * //   format: "ICEBERG", // required
+ * //   tableBucketId: "STRING_VALUE",
  * // };
  *
  * ```

package/dist-types/commands/GetTableEncryptionCommand.d.ts

@@ -0,0 +1,101 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { GetTableEncryptionRequest, GetTableEncryptionResponse } from "../models/models_0";
+import { S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3TablesClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link GetTableEncryptionCommand}.
+ */
+export interface GetTableEncryptionCommandInput extends GetTableEncryptionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetTableEncryptionCommand}.
+ */
+export interface GetTableEncryptionCommandOutput extends GetTableEncryptionResponse, __MetadataBearer {
+}
+declare const GetTableEncryptionCommand_base: {
+    new (input: GetTableEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl<GetTableEncryptionCommandInput, GetTableEncryptionCommandOutput, S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: GetTableEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl<GetTableEncryptionCommandInput, GetTableEncryptionCommandOutput, S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Gets the encryption configuration for a table.</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableEncryption</code> permission to use this operation.</p>
+ *             </dd>
+ *          </dl>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3TablesClient, GetTableEncryptionCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
+ * // const { S3TablesClient, GetTableEncryptionCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
+ * const client = new S3TablesClient(config);
+ * const input = { // GetTableEncryptionRequest
+ *   tableBucketARN: "STRING_VALUE", // required
+ *   namespace: "STRING_VALUE", // required
+ *   name: "STRING_VALUE", // required
+ * };
+ * const command = new GetTableEncryptionCommand(input);
+ * const response = await client.send(command);
+ * // { // GetTableEncryptionResponse
+ * //   encryptionConfiguration: { // EncryptionConfiguration
+ * //     sseAlgorithm: "AES256" || "aws:kms", // required
+ * //     kmsKeyArn: "STRING_VALUE",
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param GetTableEncryptionCommandInput - {@link GetTableEncryptionCommandInput}
+ * @returns {@link GetTableEncryptionCommandOutput}
+ * @see {@link GetTableEncryptionCommandInput} for command's `input` shape.
+ * @see {@link GetTableEncryptionCommandOutput} for command's `response` shape.
+ * @see {@link S3TablesClientResolvedConfig | config} for S3TablesClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>The action cannot be performed because you do not have the required permission.</p>
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The request is invalid or malformed.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The caller isn't authorized to make the request.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource could not be found.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link S3TablesServiceException}
+ * <p>Base exception class for all service exceptions from S3Tables service.</p>
+ *
+ *
+ * @public
+ */
+export declare class GetTableEncryptionCommand extends GetTableEncryptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetTableEncryptionRequest;
+            output: GetTableEncryptionResponse;
+        };
+        sdk: {
+            input: GetTableEncryptionCommandInput;
+            output: GetTableEncryptionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/ListNamespacesCommand.d.ts

@@ -57,6 +57,8 @@ declare const ListNamespacesCommand_base: {
  * //       createdAt: new Date("TIMESTAMP"), // required
  * //       createdBy: "STRING_VALUE", // required
  * //       ownerAccountId: "STRING_VALUE", // required
+ * //       namespaceId: "STRING_VALUE",
+ * //       tableBucketId: "STRING_VALUE",
  * //     },
  * //   ],
  * //   continuationToken: "STRING_VALUE",

package/dist-types/commands/ListTableBucketsCommand.d.ts

@@ -54,6 +54,7 @@ declare const ListTableBucketsCommand_base: {
  * //       name: "STRING_VALUE", // required
  * //       ownerAccountId: "STRING_VALUE", // required
  * //       createdAt: new Date("TIMESTAMP"), // required
+ * //       tableBucketId: "STRING_VALUE",
  * //     },
  * //   ],
  * //   continuationToken: "STRING_VALUE",

package/dist-types/commands/ListTablesCommand.d.ts

@@ -60,6 +60,8 @@ declare const ListTablesCommand_base: {
  * //       tableARN: "STRING_VALUE", // required
  * //       createdAt: new Date("TIMESTAMP"), // required
  * //       modifiedAt: new Date("TIMESTAMP"), // required
+ * //       namespaceId: "STRING_VALUE",
+ * //       tableBucketId: "STRING_VALUE",
  * //     },
  * //   ],
  * //   continuationToken: "STRING_VALUE",

package/dist-types/commands/PutTableBucketEncryptionCommand.d.ts

@@ -0,0 +1,103 @@
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import { PutTableBucketEncryptionRequest } from "../models/models_0";
+import { S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3TablesClient";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+export { $Command };
+/**
+ * @public
+ *
+ * The input for {@link PutTableBucketEncryptionCommand}.
+ */
+export interface PutTableBucketEncryptionCommandInput extends PutTableBucketEncryptionRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link PutTableBucketEncryptionCommand}.
+ */
+export interface PutTableBucketEncryptionCommandOutput extends __MetadataBearer {
+}
+declare const PutTableBucketEncryptionCommand_base: {
+    new (input: PutTableBucketEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl<PutTableBucketEncryptionCommandInput, PutTableBucketEncryptionCommandOutput, S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    new (__0_0: PutTableBucketEncryptionCommandInput): import("@smithy/smithy-client").CommandImpl<PutTableBucketEncryptionCommandInput, PutTableBucketEncryptionCommandOutput, S3TablesClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
+};
+/**
+ * <p>Sets the encryption configuration for a table bucket.</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:PutTableBucketEncryption</code> permission to use this operation.</p>
+ *                <note>
+ *                   <p>If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a>
+ *                   </p>
+ *                </note>
+ *             </dd>
+ *          </dl>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { S3TablesClient, PutTableBucketEncryptionCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
+ * // const { S3TablesClient, PutTableBucketEncryptionCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
+ * const client = new S3TablesClient(config);
+ * const input = { // PutTableBucketEncryptionRequest
+ *   tableBucketARN: "STRING_VALUE", // required
+ *   encryptionConfiguration: { // EncryptionConfiguration
+ *     sseAlgorithm: "AES256" || "aws:kms", // required
+ *     kmsKeyArn: "STRING_VALUE",
+ *   },
+ * };
+ * const command = new PutTableBucketEncryptionCommand(input);
+ * const response = await client.send(command);
+ * // {};
+ *
+ * ```
+ *
+ * @param PutTableBucketEncryptionCommandInput - {@link PutTableBucketEncryptionCommandInput}
+ * @returns {@link PutTableBucketEncryptionCommandOutput}
+ * @see {@link PutTableBucketEncryptionCommandInput} for command's `input` shape.
+ * @see {@link PutTableBucketEncryptionCommandOutput} for command's `response` shape.
+ * @see {@link S3TablesClientResolvedConfig | config} for S3TablesClient's `config` shape.
+ *
+ * @throws {@link BadRequestException} (client fault)
+ *  <p>The request is invalid or malformed.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request failed because there is a conflict with a previous write. You can retry the
+ *       request.</p>
+ *
+ * @throws {@link ForbiddenException} (client fault)
+ *  <p>The caller isn't authorized to make the request.</p>
+ *
+ * @throws {@link InternalServerErrorException} (server fault)
+ *  <p>The request failed due to an internal server error.</p>
+ *
+ * @throws {@link NotFoundException} (client fault)
+ *  <p>The request was rejected because the specified resource could not be found.</p>
+ *
+ * @throws {@link TooManyRequestsException} (client fault)
+ *  <p>The limit on the number of requests per second was exceeded.</p>
+ *
+ * @throws {@link S3TablesServiceException}
+ * <p>Base exception class for all service exceptions from S3Tables service.</p>
+ *
+ *
+ * @public
+ */
+export declare class PutTableBucketEncryptionCommand extends PutTableBucketEncryptionCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: PutTableBucketEncryptionRequest;
+            output: {};
+        };
+        sdk: {
+            input: PutTableBucketEncryptionCommandInput;
+            output: PutTableBucketEncryptionCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -3,14 +3,17 @@ export * from "./CreateTableBucketCommand";
 export * from "./CreateTableCommand";
 export * from "./DeleteNamespaceCommand";
 export * from "./DeleteTableBucketCommand";
+export * from "./DeleteTableBucketEncryptionCommand";
 export * from "./DeleteTableBucketPolicyCommand";
 export * from "./DeleteTableCommand";
 export * from "./DeleteTablePolicyCommand";
 export * from "./GetNamespaceCommand";
 export * from "./GetTableBucketCommand";
+export * from "./GetTableBucketEncryptionCommand";
 export * from "./GetTableBucketMaintenanceConfigurationCommand";
 export * from "./GetTableBucketPolicyCommand";
 export * from "./GetTableCommand";
+export * from "./GetTableEncryptionCommand";
 export * from "./GetTableMaintenanceConfigurationCommand";
 export * from "./GetTableMaintenanceJobStatusCommand";
 export * from "./GetTableMetadataLocationCommand";
@@ -18,6 +21,7 @@ export * from "./GetTablePolicyCommand";
 export * from "./ListNamespacesCommand";
 export * from "./ListTableBucketsCommand";
 export * from "./ListTablesCommand";
+export * from "./PutTableBucketEncryptionCommand";
 export * from "./PutTableBucketMaintenanceConfigurationCommand";
 export * from "./PutTableBucketPolicyCommand";
 export * from "./PutTableMaintenanceConfigurationCommand";

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <p>An Amazon S3 table represents a structured dataset consisting of tabular data in <a href="https://parquet.apache.org/docs/">Apache Parquet</a> format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the <a href="https://iceberg.apache.org/docs/latest/">Apache Iceberg</a> table format. Through integration with the <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/glue/latest/dg/catalog-and-crawler.html">AWS Glue Data Catalog</a> you can interact with your tables using AWS analytics services, such as <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/athena/">Amazon Athena</a> and <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/redshift/">Amazon Redshift</a>. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html">Amazon S3 table buckets</a>.</p>
+ * <p>An Amazon S3 table represents a structured dataset consisting of tabular data in <a href="https://parquet.apache.org/docs/">Apache Parquet</a> format and related metadata. This data is stored inside an S3 table as a subresource. All tables in a table bucket are stored in the <a href="https://iceberg.apache.org/docs/latest/">Apache Iceberg</a> table format. Through integration with the <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/glue/latest/dg/catalog-and-crawler.html">Amazon Web Services Glue Data Catalog</a> you can interact with your tables using Amazon Web Services analytics services, such as <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/athena/">Amazon Athena</a> and <a href="https://docs.aws.amazon.com/https:/docs.aws.amazon.com/redshift/">Amazon Redshift</a>. Amazon S3 manages maintenance of your tables through automatic file compaction and snapshot management. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html">Amazon S3 table buckets</a>.</p>
  *
  * @packageDocumentation
  */