Skip to content

Commit 7d53fdd

Browse files
author
awstools
committed
feat(client-s3tables): You can now use the CreateTable API operation to create tables with schemas by adding an optional metadata argument.
1 parent ebb8c7d commit 7d53fdd

29 files changed

+444
-80
lines changed

‎clients/client-s3tables/src/commands/CreateNamespaceCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface CreateNamespaceCommandInput extends CreateNamespaceRequest {}
2828
export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <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>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:CreateNamespace</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/CreateTableBucketCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface CreateTableBucketCommandInput extends CreateTableBucketRequest
2828
export interface CreateTableBucketCommandOutput extends CreateTableBucketResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a table bucket.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:CreateTableBucket</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/CreateTableCommand.ts

+23-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,16 @@ export interface CreateTableCommandInput extends CreateTableRequest {}
2828
export interface CreateTableCommandOutput extends CreateTableResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Creates a new table associated with the given namespace in a table bucket.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:CreateTable</code> permission to use this operation. </p>
36+
* <note>
37+
* <p>Additionally, you must have the <code>s3tables:PutTableData</code> permission to use this operation with the optional <code>metadata</code> request parameter. </p>
38+
* </note>
39+
* </dd>
40+
* </dl>
3241
* @example
3342
* Use a bare-bones client and the command you need to make an API call.
3443
* ```javascript
@@ -40,6 +49,19 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
4049
* namespace: "STRING_VALUE", // required
4150
* name: "STRING_VALUE", // required
4251
* format: "ICEBERG", // required
52+
* metadata: { // TableMetadata Union: only one key present
53+
* iceberg: { // IcebergMetadata
54+
* schema: { // IcebergSchema
55+
* fields: [ // SchemaFieldList // required
56+
* { // SchemaField
57+
* name: "STRING_VALUE", // required
58+
* type: "STRING_VALUE", // required
59+
* required: true || false,
60+
* },
61+
* ],
62+
* },
63+
* },
64+
* },
4365
* };
4466
* const command = new CreateTableCommand(input);
4567
* const response = await client.send(command);

‎clients/client-s3tables/src/commands/DeleteNamespaceCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {}
2828
export interface DeleteNamespaceCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a namespace.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:DeleteNamespace</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/DeleteTableBucketCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface DeleteTableBucketCommandInput extends DeleteTableBucketRequest
2828
export interface DeleteTableBucketCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a table bucket.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:DeleteTableBucket</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/DeleteTableBucketPolicyCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface DeleteTableBucketPolicyCommandInput extends DeleteTableBucketPo
2828
export interface DeleteTableBucketPolicyCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a table bucket policy.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:DeleteTableBucketPolicy</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/DeleteTableCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface DeleteTableCommandInput extends DeleteTableRequest {}
2828
export interface DeleteTableCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a table.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:DeleteTable</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/DeleteTablePolicyCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface DeleteTablePolicyCommandInput extends DeleteTablePolicyRequest
2828
export interface DeleteTablePolicyCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a table policy.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:DeleteTablePolicy</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/GetNamespaceCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface GetNamespaceCommandInput extends GetNamespaceRequest {}
2828
export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets details about a namespace.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:GetNamespace</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/GetTableBucketCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface GetTableBucketCommandInput extends GetTableBucketRequest {}
2828
export interface GetTableBucketCommandOutput extends GetTableBucketResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets details on a table bucket.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:GetTableBucket</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/GetTableBucketMaintenanceConfigurationCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,13 @@ export interface GetTableBucketMaintenanceConfigurationCommandOutput
3737
__MetadataBearer {}
3838

3939
/**
40-
* <p>Gets details about a maintenance configuration for a given table bucket.</p>
40+
* <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>
41+
* <dl>
42+
* <dt>Permissions</dt>
43+
* <dd>
44+
* <p>You must have the <code>s3tables:GetTableBucketMaintenanceConfiguration</code> permission to use this operation. </p>
45+
* </dd>
46+
* </dl>
4147
* @example
4248
* Use a bare-bones client and the command you need to make an API call.
4349
* ```javascript

‎clients/client-s3tables/src/commands/GetTableBucketPolicyCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface GetTableBucketPolicyCommandInput extends GetTableBucketPolicyRe
2828
export interface GetTableBucketPolicyCommandOutput extends GetTableBucketPolicyResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets details about a table bucket policy.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:GetTableBucketPolicy</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/GetTableCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface GetTableCommandInput extends GetTableRequest {}
2828
export interface GetTableCommandOutput extends GetTableResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets details about a table.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:GetTable</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/GetTableMaintenanceConfigurationCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@ export interface GetTableMaintenanceConfigurationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Gets details about the maintenance configuration of a table.</p>
36+
* <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>
37+
* <dl>
38+
* <dt>Permissions</dt>
39+
* <dd>
40+
* <p>You must have the <code>s3tables:GetTableMaintenanceConfiguration</code> permission to use this operation. </p>
41+
* </dd>
42+
* </dl>
3743
* @example
3844
* Use a bare-bones client and the command you need to make an API call.
3945
* ```javascript

‎clients/client-s3tables/src/commands/GetTableMaintenanceJobStatusCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@ export interface GetTableMaintenanceJobStatusCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Gets the status of a maintenance job for a table.</p>
36+
* <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>
37+
* <dl>
38+
* <dt>Permissions</dt>
39+
* <dd>
40+
* <p>You must have the <code>s3tables:GetTableMaintenanceJobStatus</code> permission to use this operation. </p>
41+
* </dd>
42+
* </dl>
3743
* @example
3844
* Use a bare-bones client and the command you need to make an API call.
3945
* ```javascript

‎clients/client-s3tables/src/commands/GetTableMetadataLocationCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ export interface GetTableMetadataLocationCommandOutput extends GetTableMetadataL
2929

3030
/**
3131
* <p>Gets the location of the table metadata.</p>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:GetTableMetadataLocation</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/GetTablePolicyCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface GetTablePolicyCommandInput extends GetTablePolicyRequest {}
2828
export interface GetTablePolicyCommandOutput extends GetTablePolicyResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets details about a table policy.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:GetTablePolicy</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/ListNamespacesCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface ListNamespacesCommandInput extends ListNamespacesRequest {}
2828
export interface ListNamespacesCommandOutput extends ListNamespacesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists the namespaces within a table bucket.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:ListNamespaces</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/ListTableBucketsCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface ListTableBucketsCommandInput extends ListTableBucketsRequest {}
2828
export interface ListTableBucketsCommandOutput extends ListTableBucketsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists table buckets for your account.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:ListTableBuckets</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/ListTablesCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,13 @@ export interface ListTablesCommandInput extends ListTablesRequest {}
2828
export interface ListTablesCommandOutput extends ListTablesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>List tables in the given table bucket.</p>
31+
* <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>
32+
* <dl>
33+
* <dt>Permissions</dt>
34+
* <dd>
35+
* <p>You must have the <code>s3tables:ListTables</code> permission to use this operation. </p>
36+
* </dd>
37+
* </dl>
3238
* @example
3339
* Use a bare-bones client and the command you need to make an API call.
3440
* ```javascript

‎clients/client-s3tables/src/commands/PutTableBucketMaintenanceConfigurationCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,13 @@ export interface PutTableBucketMaintenanceConfigurationCommandOutput extends __M
3333

3434
/**
3535
* <p>Creates a new maintenance configuration or replaces an existing maintenance configuration
36-
* for a table bucket.</p>
36+
* 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>
37+
* <dl>
38+
* <dt>Permissions</dt>
39+
* <dd>
40+
* <p>You must have the <code>s3tables:PutTableBucketMaintenanceConfiguration</code> permission to use this operation. </p>
41+
* </dd>
42+
* </dl>
3743
* @example
3844
* Use a bare-bones client and the command you need to make an API call.
3945
* ```javascript

‎clients/client-s3tables/src/commands/PutTableBucketPolicyCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@ export interface PutTableBucketPolicyCommandOutput extends __MetadataBearer {}
2929

3030
/**
3131
* <p>Creates a new maintenance configuration or replaces an existing table bucket policy for a
32-
* table bucket. </p>
32+
* 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>
33+
* <dl>
34+
* <dt>Permissions</dt>
35+
* <dd>
36+
* <p>You must have the <code>s3tables:PutTableBucketPolicy</code> permission to use this operation. </p>
37+
* </dd>
38+
* </dl>
3339
* @example
3440
* Use a bare-bones client and the command you need to make an API call.
3541
* ```javascript

‎clients/client-s3tables/src/commands/PutTableMaintenanceConfigurationCommand.ts

+7-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,13 @@ export interface PutTableMaintenanceConfigurationCommandOutput extends __Metadat
3232

3333
/**
3434
* <p>Creates a new maintenance configuration or replaces an existing maintenance configuration
35-
* for a table.</p>
35+
* 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>
36+
* <dl>
37+
* <dt>Permissions</dt>
38+
* <dd>
39+
* <p>You must have the <code>s3tables:PutTableMaintenanceConfiguration</code> permission to use this operation. </p>
40+
* </dd>
41+
* </dl>
3642
* @example
3743
* Use a bare-bones client and the command you need to make an API call.
3844
* ```javascript

0 commit comments

Comments
 (0)