@aws-sdk/client-s3tables 3.738.0 → 3.739.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (33) hide show
  1. package/dist-cjs/models/models_0.js +9 -1
  2. package/dist-cjs/protocols/Aws_restJson1.js +1 -0
  3. package/dist-es/models/models_0.js +8 -0
  4. package/dist-es/protocols/Aws_restJson1.js +1 -0
  5. package/dist-types/commands/CreateNamespaceCommand.d.ts +7 -1
  6. package/dist-types/commands/CreateTableBucketCommand.d.ts +7 -1
  7. package/dist-types/commands/CreateTableCommand.d.ts +23 -1
  8. package/dist-types/commands/DeleteNamespaceCommand.d.ts +7 -1
  9. package/dist-types/commands/DeleteTableBucketCommand.d.ts +7 -1
  10. package/dist-types/commands/DeleteTableBucketPolicyCommand.d.ts +7 -1
  11. package/dist-types/commands/DeleteTableCommand.d.ts +7 -1
  12. package/dist-types/commands/DeleteTablePolicyCommand.d.ts +7 -1
  13. package/dist-types/commands/GetNamespaceCommand.d.ts +7 -1
  14. package/dist-types/commands/GetTableBucketCommand.d.ts +7 -1
  15. package/dist-types/commands/GetTableBucketMaintenanceConfigurationCommand.d.ts +7 -1
  16. package/dist-types/commands/GetTableBucketPolicyCommand.d.ts +7 -1
  17. package/dist-types/commands/GetTableCommand.d.ts +7 -1
  18. package/dist-types/commands/GetTableMaintenanceConfigurationCommand.d.ts +7 -1
  19. package/dist-types/commands/GetTableMaintenanceJobStatusCommand.d.ts +7 -1
  20. package/dist-types/commands/GetTableMetadataLocationCommand.d.ts +6 -0
  21. package/dist-types/commands/GetTablePolicyCommand.d.ts +7 -1
  22. package/dist-types/commands/ListNamespacesCommand.d.ts +7 -1
  23. package/dist-types/commands/ListTableBucketsCommand.d.ts +7 -1
  24. package/dist-types/commands/ListTablesCommand.d.ts +7 -1
  25. package/dist-types/commands/PutTableBucketMaintenanceConfigurationCommand.d.ts +7 -1
  26. package/dist-types/commands/PutTableBucketPolicyCommand.d.ts +7 -1
  27. package/dist-types/commands/PutTableMaintenanceConfigurationCommand.d.ts +7 -1
  28. package/dist-types/commands/PutTablePolicyCommand.d.ts +7 -1
  29. package/dist-types/commands/RenameTableCommand.d.ts +7 -1
  30. package/dist-types/commands/UpdateTableMetadataLocationCommand.d.ts +7 -1
  31. package/dist-types/models/models_0.d.ts +92 -14
  32. package/dist-types/ts3.4/models/models_0.d.ts +30 -0
  33. package/package.json +1 -1
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.JobStatus = exports.TableMaintenanceJobType = exports.TableMaintenanceSettings = exports.TableMaintenanceType = exports.MaintenanceStatus = exports.TableBucketMaintenanceSettings = exports.TableBucketMaintenanceType = exports.TableType = exports.OpenTableFormat = exports.TooManyRequestsException = exports.NotFoundException = exports.InternalServerErrorException = exports.ForbiddenException = exports.ConflictException = exports.BadRequestException = exports.AccessDeniedException = void 0;
3
+ exports.JobStatus = exports.TableMaintenanceJobType = exports.TableMaintenanceSettings = exports.TableMaintenanceType = exports.MaintenanceStatus = exports.TableBucketMaintenanceSettings = exports.TableBucketMaintenanceType = exports.TableType = exports.TableMetadata = exports.OpenTableFormat = exports.TooManyRequestsException = exports.NotFoundException = exports.InternalServerErrorException = exports.ForbiddenException = exports.ConflictException = exports.BadRequestException = exports.AccessDeniedException = void 0;
4
4
  const S3TablesServiceException_1 = require("./S3TablesServiceException");
5
5
  class AccessDeniedException extends S3TablesServiceException_1.S3TablesServiceException {
6
6
  name = "AccessDeniedException";
@@ -96,6 +96,14 @@ exports.TooManyRequestsException = TooManyRequestsException;
96
96
  exports.OpenTableFormat = {
97
97
  ICEBERG: "ICEBERG",
98
98
  };
99
+ var TableMetadata;
100
+ (function (TableMetadata) {
101
+ TableMetadata.visit = (value, visitor) => {
102
+ if (value.iceberg !== undefined)
103
+ return visitor.iceberg(value.iceberg);
104
+ return visitor._(value.$unknown[0], value.$unknown[1]);
105
+ };
106
+ })(TableMetadata || (exports.TableMetadata = TableMetadata = {}));
99
107
  exports.TableType = {
100
108
  AWS: "aws",
101
109
  CUSTOMER: "customer",
@@ -33,6 +33,7 @@ const se_CreateTableCommand = async (input, context) => {
33
33
  let body;
34
34
  body = JSON.stringify((0, smithy_client_1.take)(input, {
35
35
  format: [],
36
+ metadata: (_) => (0, smithy_client_1._json)(_),
36
37
  name: [],
37
38
  }));
38
39
  b.m("PUT").h(headers).b(body);
@@ -86,6 +86,14 @@ export class TooManyRequestsException extends __BaseException {
86
86
  export const OpenTableFormat = {
87
87
  ICEBERG: "ICEBERG",
88
88
  };
89
+ export var TableMetadata;
90
+ (function (TableMetadata) {
91
+ TableMetadata.visit = (value, visitor) => {
92
+ if (value.iceberg !== undefined)
93
+ return visitor.iceberg(value.iceberg);
94
+ return visitor._(value.$unknown[0], value.$unknown[1]);
95
+ };
96
+ })(TableMetadata || (TableMetadata = {}));
89
97
  export const TableType = {
90
98
  AWS: "aws",
91
99
  CUSTOMER: "customer",
@@ -28,6 +28,7 @@ export const se_CreateTableCommand = async (input, context) => {
28
28
  let body;
29
29
  body = JSON.stringify(take(input, {
30
30
  format: [],
31
+ metadata: (_) => _json(_),
31
32
  name: [],
32
33
  }));
33
34
  b.m("PUT").h(headers).b(body);
@@ -27,7 +27,13 @@ declare const CreateNamespaceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html">Table namespaces</a>. </p>
30
+ * <p>Creates a namespace. A namespace is a logical grouping of tables within your table bucket, which you can use to organize tables. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-create.html">Create a namespace</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:CreateNamespace</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const CreateTableBucketCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a table bucket.</p>
30
+ * <p>Creates a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-create.html">Creating a table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:CreateTableBucket</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,16 @@ declare const CreateTableCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new table associated with the given namespace in a table bucket.</p>
30
+ * <p>Creates a new table associated with the given namespace in a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-create.html">Creating an Amazon S3 table</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:CreateTable</code> permission to use this operation. </p>
35
+ * <note>
36
+ * <p>Additionally, you must have the <code>s3tables:PutTableData</code> permission to use this operation with the optional <code>metadata</code> request parameter. </p>
37
+ * </note>
38
+ * </dd>
39
+ * </dl>
31
40
  * @example
32
41
  * Use a bare-bones client and the command you need to make an API call.
33
42
  * ```javascript
@@ -39,6 +48,19 @@ declare const CreateTableCommand_base: {
39
48
  * namespace: "STRING_VALUE", // required
40
49
  * name: "STRING_VALUE", // required
41
50
  * format: "ICEBERG", // required
51
+ * metadata: { // TableMetadata Union: only one key present
52
+ * iceberg: { // IcebergMetadata
53
+ * schema: { // IcebergSchema
54
+ * fields: [ // SchemaFieldList // required
55
+ * { // SchemaField
56
+ * name: "STRING_VALUE", // required
57
+ * type: "STRING_VALUE", // required
58
+ * required: true || false,
59
+ * },
60
+ * ],
61
+ * },
62
+ * },
63
+ * },
42
64
  * };
43
65
  * const command = new CreateTableCommand(input);
44
66
  * const response = await client.send(command);
@@ -27,7 +27,13 @@ declare const DeleteNamespaceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a namespace.</p>
30
+ * <p>Deletes a namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace-delete.html">Delete a namespace</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:DeleteNamespace</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const DeleteTableBucketCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a table bucket.</p>
30
+ * <p>Deletes a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-delete.html">Deleting a table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:DeleteTableBucket</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const DeleteTableBucketPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a table bucket policy.</p>
30
+ * <p>Deletes a table bucket policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-delete">Deleting a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:DeleteTableBucketPolicy</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const DeleteTableCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a table.</p>
30
+ * <p>Deletes a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-delete.html">Deleting an Amazon S3 table</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:DeleteTable</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const DeleteTablePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes a table policy.</p>
30
+ * <p>Deletes a table policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-delete">Deleting a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:DeleteTablePolicy</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetNamespaceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details about a namespace.</p>
30
+ * <p>Gets details about a namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html">Table namespaces</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetNamespace</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTableBucketCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details on a table bucket.</p>
30
+ * <p>Gets details on a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets-details.html">Viewing details about an Amazon S3 table bucket</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTableBucket</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTableBucketMaintenanceConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details about a maintenance configuration for a given table bucket.</p>
30
+ * <p>Gets details about a maintenance configuration for a given table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html">Amazon S3 table bucket maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTableBucketMaintenanceConfiguration</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTableBucketPolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details about a table bucket policy.</p>
30
+ * <p>Gets details about a table bucket policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-get">Viewing a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTableBucketPolicy</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTableCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details about a table.</p>
30
+ * <p>Gets details about a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTable</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTableMaintenanceConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details about the maintenance configuration of a table.</p>
30
+ * <p>Gets details about the maintenance configuration of a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTableMaintenanceConfiguration</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTableMaintenanceJobStatusCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets the status of a maintenance job for a table.</p>
30
+ * <p>Gets the status of a maintenance job for a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTableMaintenanceJobStatus</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -28,6 +28,12 @@ declare const GetTableMetadataLocationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Gets the location of the table metadata.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTableMetadataLocation</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const GetTablePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Gets details about a table policy.</p>
30
+ * <p>Gets details about a table policy. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-get">Viewing a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:GetTablePolicy</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const ListNamespacesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists the namespaces within a table bucket.</p>
30
+ * <p>Lists the namespaces within a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-namespace.html">Table namespaces</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:ListNamespaces</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const ListTableBucketsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists table buckets for your account.</p>
30
+ * <p>Lists table buckets for your account. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-buckets.html">S3 Table buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:ListTableBuckets</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const ListTablesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>List tables in the given table bucket.</p>
30
+ * <p>List tables in the given table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:ListTables</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -28,7 +28,13 @@ declare const PutTableBucketMaintenanceConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates a new maintenance configuration or replaces an existing maintenance configuration
31
- * for a table bucket.</p>
31
+ * for a table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-table-buckets-maintenance.html">Amazon S3 table bucket maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
32
+ * <dl>
33
+ * <dt>Permissions</dt>
34
+ * <dd>
35
+ * <p>You must have the <code>s3tables:PutTableBucketMaintenanceConfiguration</code> permission to use this operation. </p>
36
+ * </dd>
37
+ * </dl>
32
38
  * @example
33
39
  * Use a bare-bones client and the command you need to make an API call.
34
40
  * ```javascript
@@ -28,7 +28,13 @@ declare const PutTableBucketPolicyCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates a new maintenance configuration or replaces an existing table bucket policy for a
31
- * table bucket. </p>
31
+ * table bucket. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-bucket-policy.html#table-bucket-policy-add">Adding a table bucket policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
32
+ * <dl>
33
+ * <dt>Permissions</dt>
34
+ * <dd>
35
+ * <p>You must have the <code>s3tables:PutTableBucketPolicy</code> permission to use this operation. </p>
36
+ * </dd>
37
+ * </dl>
32
38
  * @example
33
39
  * Use a bare-bones client and the command you need to make an API call.
34
40
  * ```javascript
@@ -28,7 +28,13 @@ declare const PutTableMaintenanceConfigurationCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates a new maintenance configuration or replaces an existing maintenance configuration
31
- * for a table.</p>
31
+ * for a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-maintenance.html">S3 Tables maintenance</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
32
+ * <dl>
33
+ * <dt>Permissions</dt>
34
+ * <dd>
35
+ * <p>You must have the <code>s3tables:PutTableMaintenanceConfiguration</code> permission to use this operation. </p>
36
+ * </dd>
37
+ * </dl>
32
38
  * @example
33
39
  * Use a bare-bones client and the command you need to make an API call.
34
40
  * ```javascript
@@ -27,8 +27,14 @@ declare const PutTablePolicyCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Creates a new maintenance configuration or replaces an existing table policy for a table.
30
+ * <p>Creates a new maintenance configuration or replaces an existing table policy for a table. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-table-policy.html#table-policy-add">Adding a table policy</a> in the <i>Amazon Simple Storage Service User Guide</i>.
31
31
  * </p>
32
+ * <dl>
33
+ * <dt>Permissions</dt>
34
+ * <dd>
35
+ * <p>You must have the <code>s3tables:PutTablePolicy</code> permission to use this operation. </p>
36
+ * </dd>
37
+ * </dl>
32
38
  * @example
33
39
  * Use a bare-bones client and the command you need to make an API call.
34
40
  * ```javascript
@@ -27,7 +27,13 @@ declare const RenameTableCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Renames a table or a namespace.</p>
30
+ * <p>Renames a table or a namespace. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-tables.html">S3 Tables</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:RenameTable</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -27,7 +27,13 @@ declare const UpdateTableMetadataLocationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Updates the metadata location for a table.</p>
30
+ * <p>Updates the metadata location for a table. The metadata location of a table must be an S3 URI that begins with the table's warehouse location. The metadata location for an Apache Iceberg table must end with <code>.metadata.json</code>, or if the metadata file is Gzip-compressed, <code>.metadata.json.gz</code>.</p>
31
+ * <dl>
32
+ * <dt>Permissions</dt>
33
+ * <dd>
34
+ * <p>You must have the <code>s3tables:UpdateTableMetadataLocation</code> permission to use this operation. </p>
35
+ * </dd>
36
+ * </dl>
31
37
  * @example
32
38
  * Use a bare-bones client and the command you need to make an API call.
33
39
  * ```javascript
@@ -126,6 +126,79 @@ export declare const OpenTableFormat: {
126
126
  * @public
127
127
  */
128
128
  export type OpenTableFormat = (typeof OpenTableFormat)[keyof typeof OpenTableFormat];
129
+ /**
130
+ * <p>Contains details about a schema field.</p>
131
+ * @public
132
+ */
133
+ export interface SchemaField {
134
+ /**
135
+ * <p>The name of the field.</p>
136
+ * @public
137
+ */
138
+ name: string | undefined;
139
+ /**
140
+ * <p>The field type. S3 Tables supports all Apache Iceberg primitive types. For more information, see the <a href="https://iceberg.apache.org/spec/#primitive-types">Apache Iceberg documentation</a>.</p>
141
+ * @public
142
+ */
143
+ type: string | undefined;
144
+ /**
145
+ * <p>A Boolean value that specifies whether values are required for each row in this field. By default, this is <code>false</code> and null values are allowed in the field. If this is <code>true</code> the field does not allow null values.</p>
146
+ * @public
147
+ */
148
+ required?: boolean | undefined;
149
+ }
150
+ /**
151
+ * <p>Contains details about the schema for an Iceberg table.</p>
152
+ * @public
153
+ */
154
+ export interface IcebergSchema {
155
+ /**
156
+ * <p>The schema fields for the table</p>
157
+ * @public
158
+ */
159
+ fields: SchemaField[] | undefined;
160
+ }
161
+ /**
162
+ * <p>Contains details about the metadata for an Iceberg table.</p>
163
+ * @public
164
+ */
165
+ export interface IcebergMetadata {
166
+ /**
167
+ * <p>The schema for an Iceberg table.</p>
168
+ * @public
169
+ */
170
+ schema: IcebergSchema | undefined;
171
+ }
172
+ /**
173
+ * <p>Contains details about the table metadata.</p>
174
+ * @public
175
+ */
176
+ export type TableMetadata = TableMetadata.IcebergMember | TableMetadata.$UnknownMember;
177
+ /**
178
+ * @public
179
+ */
180
+ export declare namespace TableMetadata {
181
+ /**
182
+ * <p>Contains details about the metadata of an Iceberg table.</p>
183
+ * @public
184
+ */
185
+ interface IcebergMember {
186
+ iceberg: IcebergMetadata;
187
+ $unknown?: never;
188
+ }
189
+ /**
190
+ * @public
191
+ */
192
+ interface $UnknownMember {
193
+ iceberg?: never;
194
+ $unknown: [string, any];
195
+ }
196
+ interface Visitor<T> {
197
+ iceberg: (value: IcebergMetadata) => T;
198
+ _: (name: string, value: any) => T;
199
+ }
200
+ const visit: <T>(value: TableMetadata, visitor: Visitor<T>) => T;
201
+ }
129
202
  /**
130
203
  * @public
131
204
  */
@@ -150,6 +223,11 @@ export interface CreateTableRequest {
150
223
  * @public
151
224
  */
152
225
  format: OpenTableFormat | undefined;
226
+ /**
227
+ * <p>The metadata for the table.</p>
228
+ * @public
229
+ */
230
+ metadata?: TableMetadata | undefined;
153
231
  }
154
232
  /**
155
233
  * @public
@@ -241,7 +319,7 @@ export interface DeleteTableBucketRequest {
241
319
  */
242
320
  export interface DeleteTableBucketPolicyRequest {
243
321
  /**
244
- * <p>The Amazon Resource Number (ARN) of the table bucket.</p>
322
+ * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
245
323
  * @public
246
324
  */
247
325
  tableBucketARN: string | undefined;
@@ -251,7 +329,7 @@ export interface DeleteTableBucketPolicyRequest {
251
329
  */
252
330
  export interface DeleteTablePolicyRequest {
253
331
  /**
254
- * <p>The Amazon Resource Number (ARN) of the table bucket that contains the table.</p>
332
+ * <p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>
255
333
  * @public
256
334
  */
257
335
  tableBucketARN: string | undefined;
@@ -570,7 +648,7 @@ export interface GetTableBucketMaintenanceConfigurationResponse {
570
648
  */
571
649
  export interface GetTableBucketPolicyRequest {
572
650
  /**
573
- * <p>The Amazon Resource Number (ARN) of the table bucket.</p>
651
+ * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
574
652
  * @public
575
653
  */
576
654
  tableBucketARN: string | undefined;
@@ -580,7 +658,7 @@ export interface GetTableBucketPolicyRequest {
580
658
  */
581
659
  export interface GetTableBucketPolicyResponse {
582
660
  /**
583
- * <p>The name of the resource policy.</p>
661
+ * <p>The <code>JSON</code> that defines the policy.</p>
584
662
  * @public
585
663
  */
586
664
  resourcePolicy: string | undefined;
@@ -849,7 +927,7 @@ export interface GetTableMetadataLocationResponse {
849
927
  */
850
928
  export interface GetTablePolicyRequest {
851
929
  /**
852
- * <p>The Amazon Resource Number (ARN) of the table bucket that contains the table.</p>
930
+ * <p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>
853
931
  * @public
854
932
  */
855
933
  tableBucketARN: string | undefined;
@@ -869,7 +947,7 @@ export interface GetTablePolicyRequest {
869
947
  */
870
948
  export interface GetTablePolicyResponse {
871
949
  /**
872
- * <p>The name of the resource policy.</p>
950
+ * <p>The <code>JSON</code> that defines the policy.</p>
873
951
  * @public
874
952
  */
875
953
  resourcePolicy: string | undefined;
@@ -972,7 +1050,7 @@ export interface ListTableBucketsRequest {
972
1050
  */
973
1051
  export interface TableBucketSummary {
974
1052
  /**
975
- * <p>The Amazon Resource Number (ARN) of the table bucket.</p>
1053
+ * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
976
1054
  * @public
977
1055
  */
978
1056
  arn: string | undefined;
@@ -1012,7 +1090,7 @@ export interface ListTableBucketsResponse {
1012
1090
  */
1013
1091
  export interface ListTablesRequest {
1014
1092
  /**
1015
- * <p>The Amazon resource Number (ARN) of the table bucket.</p>
1093
+ * <p>The Amazon resource Name (ARN) of the table bucket.</p>
1016
1094
  * @public
1017
1095
  */
1018
1096
  tableBucketARN: string | undefined;
@@ -1061,7 +1139,7 @@ export interface TableSummary {
1061
1139
  */
1062
1140
  type: TableType | undefined;
1063
1141
  /**
1064
- * <p>The Amazon Resource Number (ARN) of the table.</p>
1142
+ * <p>The Amazon Resource Name (ARN) of the table.</p>
1065
1143
  * @public
1066
1144
  */
1067
1145
  tableARN: string | undefined;
@@ -1117,12 +1195,12 @@ export interface PutTableBucketMaintenanceConfigurationRequest {
1117
1195
  */
1118
1196
  export interface PutTableBucketPolicyRequest {
1119
1197
  /**
1120
- * <p>The Amazon Resource Number (ARN) of the table bucket.</p>
1198
+ * <p>The Amazon Resource Name (ARN) of the table bucket.</p>
1121
1199
  * @public
1122
1200
  */
1123
1201
  tableBucketARN: string | undefined;
1124
1202
  /**
1125
- * <p>The name of the resource policy.</p>
1203
+ * <p>The <code>JSON</code> that defines the policy.</p>
1126
1204
  * @public
1127
1205
  */
1128
1206
  resourcePolicy: string | undefined;
@@ -1163,7 +1241,7 @@ export interface PutTableMaintenanceConfigurationRequest {
1163
1241
  */
1164
1242
  export interface PutTablePolicyRequest {
1165
1243
  /**
1166
- * <p>The Amazon Resource Number (ARN) of the table bucket that contains the table.</p>
1244
+ * <p>The Amazon Resource Name (ARN) of the table bucket that contains the table.</p>
1167
1245
  * @public
1168
1246
  */
1169
1247
  tableBucketARN: string | undefined;
@@ -1178,7 +1256,7 @@ export interface PutTablePolicyRequest {
1178
1256
  */
1179
1257
  name: string | undefined;
1180
1258
  /**
1181
- * <p>The name of the resource policy.</p>
1259
+ * <p>The <code>JSON</code> that defines the policy.</p>
1182
1260
  * @public
1183
1261
  */
1184
1262
  resourcePolicy: string | undefined;
@@ -1258,7 +1336,7 @@ export interface UpdateTableMetadataLocationResponse {
1258
1336
  */
1259
1337
  name: string | undefined;
1260
1338
  /**
1261
- * <p>The Amazon Resource Number (ARN) of the table.</p>
1339
+ * <p>The Amazon Resource Name (ARN) of the table.</p>
1262
1340
  * @public
1263
1341
  */
1264
1342
  tableARN: string | undefined;
@@ -56,11 +56,41 @@ export declare const OpenTableFormat: {
56
56
  };
57
57
  export type OpenTableFormat =
58
58
  (typeof OpenTableFormat)[keyof typeof OpenTableFormat];
59
+ export interface SchemaField {
60
+ name: string | undefined;
61
+ type: string | undefined;
62
+ required?: boolean | undefined;
63
+ }
64
+ export interface IcebergSchema {
65
+ fields: SchemaField[] | undefined;
66
+ }
67
+ export interface IcebergMetadata {
68
+ schema: IcebergSchema | undefined;
69
+ }
70
+ export type TableMetadata =
71
+ | TableMetadata.IcebergMember
72
+ | TableMetadata.$UnknownMember;
73
+ export declare namespace TableMetadata {
74
+ interface IcebergMember {
75
+ iceberg: IcebergMetadata;
76
+ $unknown?: never;
77
+ }
78
+ interface $UnknownMember {
79
+ iceberg?: never;
80
+ $unknown: [string, any];
81
+ }
82
+ interface Visitor<T> {
83
+ iceberg: (value: IcebergMetadata) => T;
84
+ _: (name: string, value: any) => T;
85
+ }
86
+ const visit: <T>(value: TableMetadata, visitor: Visitor<T>) => T;
87
+ }
59
88
  export interface CreateTableRequest {
60
89
  tableBucketARN: string | undefined;
61
90
  namespace: string | undefined;
62
91
  name: string | undefined;
63
92
  format: OpenTableFormat | undefined;
93
+ metadata?: TableMetadata | undefined;
64
94
  }
65
95
  export interface CreateTableResponse {
66
96
  tableARN: string | undefined;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-s3tables",
3
3
  "description": "AWS SDK for JavaScript S3tables Client for Node.js, Browser and React Native",
4
- "version": "3.738.0",
4
+ "version": "3.739.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",