feat(client-s3tables): You can now use the CreateTable API operation …

…to create tables with schemas by adding an optional metadata argument.
aws · Jan 30, 2025 · 7d53fdd · 7d53fdd
1 parent ebb8c7d
commit 7d53fdd
Show file tree

Hide file tree

Showing 29 changed files with 444 additions and 80 deletions.
diff --git a/clients/client-s3tables/src/commands/CreateNamespaceCommand.ts b/clients/client-s3tables/src/commands/CreateNamespaceCommand.ts
@@ -28,7 +28,13 @@ export interface CreateNamespaceCommandInput extends CreateNamespaceRequest {}
 export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, __MetadataBearer {}
 
 /**
- * <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>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:CreateNamespace</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

diff --git a/clients/client-s3tables/src/commands/CreateTableBucketCommand.ts b/clients/client-s3tables/src/commands/CreateTableBucketCommand.ts
@@ -28,7 +28,13 @@ export interface CreateTableBucketCommandInput extends CreateTableBucketRequest
 export interface CreateTableBucketCommandOutput extends CreateTableBucketResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:CreateTableBucket</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

diff --git a/clients/client-s3tables/src/commands/CreateTableCommand.ts b/clients/client-s3tables/src/commands/CreateTableCommand.ts
@@ -28,7 +28,16 @@ export interface CreateTableCommandInput extends CreateTableRequest {}
 export interface CreateTableCommandOutput extends CreateTableResponse, __MetadataBearer {}
 
 /**
- * <p>Creates a new table associated with the given namespace in a table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:CreateTable</code> permission to use this operation. </p>
+ *                <note>
+ *                   <p>Additionally, you must have the <code>s3tables:PutTableData</code> permission to use this operation with the optional <code>metadata</code> request parameter. </p>
+ *                </note>
+ *             </dd>
+ *          </dl>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -40,6 +49,19 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
  *   namespace: "STRING_VALUE", // required
  *   name: "STRING_VALUE", // required
  *   format: "ICEBERG", // required
+ *   metadata: { // TableMetadata Union: only one key present
+ *     iceberg: { // IcebergMetadata
+ *       schema: { // IcebergSchema
+ *         fields: [ // SchemaFieldList // required
+ *           { // SchemaField
+ *             name: "STRING_VALUE", // required
+ *             type: "STRING_VALUE", // required
+ *             required: true || false,
+ *           },
+ *         ],
+ *       },
+ *     },
+ *   },
  * };
  * const command = new CreateTableCommand(input);
  * const response = await client.send(command);

diff --git a/clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts b/clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts
@@ -28,7 +28,13 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {}
 export interface DeleteNamespaceCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a namespace.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:DeleteNamespace</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

diff --git a/clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts b/clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts
@@ -28,7 +28,13 @@ export interface DeleteTableBucketCommandInput extends DeleteTableBucketRequest
 export interface DeleteTableBucketCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:DeleteTableBucket</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

diff --git a/clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts b/clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts
@@ -28,7 +28,13 @@ export interface DeleteTableBucketPolicyCommandInput extends DeleteTableBucketPo
 export interface DeleteTableBucketPolicyCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a table bucket policy.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:DeleteTableBucketPolicy</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

diff --git a/clients/client-s3tables/src/commands/DeleteTableCommand.ts b/clients/client-s3tables/src/commands/DeleteTableCommand.ts
@@ -28,7 +28,13 @@ export interface DeleteTableCommandInput extends DeleteTableRequest {}
 export interface DeleteTableCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a table.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:DeleteTable</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

diff --git a/clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts b/clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts
@@ -28,7 +28,13 @@ export interface DeleteTablePolicyCommandInput extends DeleteTablePolicyRequest
 export interface DeleteTablePolicyCommandOutput extends __MetadataBearer {}
 
 /**
- * <p>Deletes a table policy.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:DeleteTablePolicy</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

diff --git a/clients/client-s3tables/src/commands/GetNamespaceCommand.ts b/clients/client-s3tables/src/commands/GetNamespaceCommand.ts
@@ -28,7 +28,13 @@ export interface GetNamespaceCommandInput extends GetNamespaceRequest {}
 export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __MetadataBearer {}
 
 /**
- * <p>Gets details about a namespace.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetNamespace</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

diff --git a/clients/client-s3tables/src/commands/GetTableBucketCommand.ts b/clients/client-s3tables/src/commands/GetTableBucketCommand.ts
@@ -28,7 +28,13 @@ export interface GetTableBucketCommandInput extends GetTableBucketRequest {}
 export interface GetTableBucketCommandOutput extends GetTableBucketResponse, __MetadataBearer {}
 
 /**
- * <p>Gets details on a table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableBucket</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

diff --git a/clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts
@@ -37,7 +37,13 @@ export interface GetTableBucketMaintenanceConfigurationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Gets details about a maintenance configuration for a given table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableBucketMaintenanceConfiguration</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

diff --git a/clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts b/clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts
@@ -28,7 +28,13 @@ export interface GetTableBucketPolicyCommandInput extends GetTableBucketPolicyRe
 export interface GetTableBucketPolicyCommandOutput extends GetTableBucketPolicyResponse, __MetadataBearer {}
 
 /**
- * <p>Gets details about a table bucket policy.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableBucketPolicy</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

diff --git a/clients/client-s3tables/src/commands/GetTableCommand.ts b/clients/client-s3tables/src/commands/GetTableCommand.ts
@@ -28,7 +28,13 @@ export interface GetTableCommandInput extends GetTableRequest {}
 export interface GetTableCommandOutput extends GetTableResponse, __MetadataBearer {}
 
 /**
- * <p>Gets details about a table.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTable</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

diff --git a/clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts
@@ -33,7 +33,13 @@ export interface GetTableMaintenanceConfigurationCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Gets details about the maintenance configuration of a table.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableMaintenanceConfiguration</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

diff --git a/clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts b/clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts
@@ -33,7 +33,13 @@ export interface GetTableMaintenanceJobStatusCommandOutput
     __MetadataBearer {}
 
 /**
- * <p>Gets the status of a maintenance job for a table.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableMaintenanceJobStatus</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

diff --git a/clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts b/clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts
@@ -29,6 +29,12 @@ export interface GetTableMetadataLocationCommandOutput extends GetTableMetadataL
 
 /**
  * <p>Gets the location of the table metadata.</p>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTableMetadataLocation</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

diff --git a/clients/client-s3tables/src/commands/GetTablePolicyCommand.ts b/clients/client-s3tables/src/commands/GetTablePolicyCommand.ts
@@ -28,7 +28,13 @@ export interface GetTablePolicyCommandInput extends GetTablePolicyRequest {}
 export interface GetTablePolicyCommandOutput extends GetTablePolicyResponse, __MetadataBearer {}
 
 /**
- * <p>Gets details about a table policy.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:GetTablePolicy</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

diff --git a/clients/client-s3tables/src/commands/ListNamespacesCommand.ts b/clients/client-s3tables/src/commands/ListNamespacesCommand.ts
@@ -28,7 +28,13 @@ export interface ListNamespacesCommandInput extends ListNamespacesRequest {}
 export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __MetadataBearer {}
 
 /**
- * <p>Lists the namespaces within a table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:ListNamespaces</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

diff --git a/clients/client-s3tables/src/commands/ListTableBucketsCommand.ts b/clients/client-s3tables/src/commands/ListTableBucketsCommand.ts
@@ -28,7 +28,13 @@ export interface ListTableBucketsCommandInput extends ListTableBucketsRequest {}
 export interface ListTableBucketsCommandOutput extends ListTableBucketsResponse, __MetadataBearer {}
 
 /**
- * <p>Lists table buckets for your account.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:ListTableBuckets</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

diff --git a/clients/client-s3tables/src/commands/ListTablesCommand.ts b/clients/client-s3tables/src/commands/ListTablesCommand.ts
@@ -28,7 +28,13 @@ export interface ListTablesCommandInput extends ListTablesRequest {}
 export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataBearer {}
 
 /**
- * <p>List tables in the given table bucket.</p>
+ * <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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:ListTables</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

diff --git a/clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts
@@ -33,7 +33,13 @@ export interface PutTableBucketMaintenanceConfigurationCommandOutput extends __M
 
 /**
  * <p>Creates a new maintenance configuration or replaces an existing maintenance configuration
- *       for a table bucket.</p>
+ *       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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:PutTableBucketMaintenanceConfiguration</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

diff --git a/clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts b/clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts
@@ -29,7 +29,13 @@ export interface PutTableBucketPolicyCommandOutput extends __MetadataBearer {}
 
 /**
  * <p>Creates a new maintenance configuration or replaces an existing table bucket policy for a
- *       table bucket. </p>
+ *       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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:PutTableBucketPolicy</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

diff --git a/clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts b/clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts
@@ -32,7 +32,13 @@ export interface PutTableMaintenanceConfigurationCommandOutput extends __Metadat
 
 /**
  * <p>Creates a new maintenance configuration or replaces an existing maintenance configuration
- *       for a table.</p>
+ *       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>
+ *          <dl>
+ *             <dt>Permissions</dt>
+ *             <dd>
+ *                <p>You must have the <code>s3tables:PutTableMaintenanceConfiguration</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