Skip to content

Commit caebd1b

Browse files
author
awstools
committed
feat(client-s3tables): S3 Tables now supports getting details about a table via its table ARN.
1 parent b052704 commit caebd1b

34 files changed

+159
-381
lines changed

clients/client-s3tables/src/S3Tables.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,7 @@ export interface S3Tables {
317317
/**
318318
* @see {@link GetTableCommand}
319319
*/
320+
getTable(): Promise<GetTableCommandOutput>;
320321
getTable(args: GetTableCommandInput, options?: __HttpHandlerOptions): Promise<GetTableCommandOutput>;
321322
getTable(args: GetTableCommandInput, cb: (err: any, data?: GetTableCommandOutput) => void): void;
322323
getTable(

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ 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-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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:CreateNamespace</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -68,8 +62,7 @@ export interface CreateNamespaceCommandOutput extends CreateNamespaceResponse, _
6862
* <p>The request is invalid or malformed.</p>
6963
*
7064
* @throws {@link ConflictException} (client fault)
71-
* <p>The request failed because there is a conflict with a previous write. You can retry the
72-
* request.</p>
65+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
7366
*
7467
* @throws {@link ForbiddenException} (client fault)
7568
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,7 @@ export interface CreateTableBucketCommandInput extends CreateTableBucketRequest
2828
export interface CreateTableBucketCommandOutput extends CreateTableBucketResponse, __MetadataBearer {}
2929

3030
/**
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-
* <ul>
36-
* <li>
37-
* <p>You must have the <code>s3tables:CreateTableBucket</code> permission to use this operation. </p>
38-
* </li>
39-
* <li>
40-
* <p>If you use this operation with the optional <code>encryptionConfiguration</code> parameter you must have the <code>s3tables:PutTableBucketEncryption</code> permission.</p>
41-
* </li>
42-
* </ul>
43-
* </dd>
44-
* </dl>
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> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p>You must have the <code>s3tables:CreateTableBucket</code> permission to use this operation. </p> </li> <li> <p>If you use this operation with the optional <code>encryptionConfiguration</code> parameter you must have the <code>s3tables:PutTableBucketEncryption</code> permission.</p> </li> </ul> </dd> </dl>
4532
* @example
4633
* Use a bare-bones client and the command you need to make an API call.
4734
* ```javascript
@@ -73,8 +60,7 @@ export interface CreateTableBucketCommandOutput extends CreateTableBucketRespons
7360
* <p>The request is invalid or malformed.</p>
7461
*
7562
* @throws {@link ConflictException} (client fault)
76-
* <p>The request failed because there is a conflict with a previous write. You can retry the
77-
* request.</p>
63+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
7864
*
7965
* @throws {@link ForbiddenException} (client fault)
8066
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,7 @@ 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. 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-
* <ul>
36-
* <li>
37-
* <p>You must have the <code>s3tables:CreateTable</code> permission to use this operation. </p>
38-
* </li>
39-
* <li>
40-
* <p>If you use this operation with the optional <code>metadata</code> request parameter you must have the <code>s3tables:PutTableData</code> permission. </p>
41-
* </li>
42-
* <li>
43-
* <p>If you use this operation with the optional <code>encryptionConfiguration</code> request parameter you must have the <code>s3tables:PutTableEncryption</code> permission. </p>
44-
* </li>
45-
* </ul>
46-
* <note>
47-
* <p>Additionally, </p>
48-
* </note>
49-
* </dd>
50-
* </dl>
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> <dl> <dt>Permissions</dt> <dd> <ul> <li> <p>You must have the <code>s3tables:CreateTable</code> permission to use this operation. </p> </li> <li> <p>If you use this operation with the optional <code>metadata</code> request parameter you must have the <code>s3tables:PutTableData</code> permission. </p> </li> <li> <p>If you use this operation with the optional <code>encryptionConfiguration</code> request parameter you must have the <code>s3tables:PutTableEncryption</code> permission. </p> </li> </ul> <note> <p>Additionally, 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="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a>. </p> </note> </dd> </dl>
5132
* @example
5233
* Use a bare-bones client and the command you need to make an API call.
5334
* ```javascript
@@ -96,8 +77,7 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
9677
* <p>The request is invalid or malformed.</p>
9778
*
9879
* @throws {@link ConflictException} (client fault)
99-
* <p>The request failed because there is a conflict with a previous write. You can retry the
100-
* request.</p>
80+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
10181
*
10282
* @throws {@link ForbiddenException} (client fault)
10383
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface DeleteNamespaceCommandInput extends DeleteNamespaceRequest {}
2828
export interface DeleteNamespaceCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteNamespace</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -61,8 +55,7 @@ export interface DeleteNamespaceCommandOutput extends __MetadataBearer {}
6155
* <p>The request is invalid or malformed.</p>
6256
*
6357
* @throws {@link ConflictException} (client fault)
64-
* <p>The request failed because there is a conflict with a previous write. You can retry the
65-
* request.</p>
58+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
6659
*
6760
* @throws {@link ForbiddenException} (client fault)
6861
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface DeleteTableBucketCommandInput extends DeleteTableBucketRequest
2828
export interface DeleteTableBucketCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTableBucket</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -60,8 +54,7 @@ export interface DeleteTableBucketCommandOutput extends __MetadataBearer {}
6054
* <p>The request is invalid or malformed.</p>
6155
*
6256
* @throws {@link ConflictException} (client fault)
63-
* <p>The request failed because there is a conflict with a previous write. You can retry the
64-
* request.</p>
57+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
6558
*
6659
* @throws {@link ForbiddenException} (client fault)
6760
* <p>The caller isn't authorized to make the request.</p>

clients/client-s3tables/src/commands/DeleteTableBucketEncryptionCommand.ts

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,7 @@ export interface DeleteTableBucketEncryptionCommandInput extends DeleteTableBuck
3131
export interface DeleteTableBucketEncryptionCommandOutput extends __MetadataBearer {}
3232

3333
/**
34-
* <p>Deletes the encryption configuration for a table bucket.</p>
35-
* <dl>
36-
* <dt>Permissions</dt>
37-
* <dd>
38-
* <p>You must have the <code>s3tables:DeleteTableBucketEncryption</code> permission to use this operation.</p>
39-
* </dd>
40-
* </dl>
34+
* <p>Deletes the encryption configuration for a table bucket.</p> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTableBucketEncryption</code> permission to use this operation.</p> </dd> </dl>
4135
* @example
4236
* Use a bare-bones client and the command you need to make an API call.
4337
* ```javascript
@@ -63,8 +57,7 @@ export interface DeleteTableBucketEncryptionCommandOutput extends __MetadataBear
6357
* <p>The request is invalid or malformed.</p>
6458
*
6559
* @throws {@link ConflictException} (client fault)
66-
* <p>The request failed because there is a conflict with a previous write. You can retry the
67-
* request.</p>
60+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
6861
*
6962
* @throws {@link ForbiddenException} (client fault)
7063
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface DeleteTableBucketPolicyCommandInput extends DeleteTableBucketPo
2828
export interface DeleteTableBucketPolicyCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTableBucketPolicy</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -60,8 +54,7 @@ export interface DeleteTableBucketPolicyCommandOutput extends __MetadataBearer {
6054
* <p>The request is invalid or malformed.</p>
6155
*
6256
* @throws {@link ConflictException} (client fault)
63-
* <p>The request failed because there is a conflict with a previous write. You can retry the
64-
* request.</p>
57+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
6558
*
6659
* @throws {@link ForbiddenException} (client fault)
6760
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface DeleteTableCommandInput extends DeleteTableRequest {}
2828
export interface DeleteTableCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTable</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -63,8 +57,7 @@ export interface DeleteTableCommandOutput extends __MetadataBearer {}
6357
* <p>The request is invalid or malformed.</p>
6458
*
6559
* @throws {@link ConflictException} (client fault)
66-
* <p>The request failed because there is a conflict with a previous write. You can retry the
67-
* request.</p>
60+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
6861
*
6962
* @throws {@link ForbiddenException} (client fault)
7063
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface DeleteTablePolicyCommandInput extends DeleteTablePolicyRequest
2828
export interface DeleteTablePolicyCommandOutput extends __MetadataBearer {}
2929

3030
/**
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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:DeleteTablePolicy</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -62,8 +56,7 @@ export interface DeleteTablePolicyCommandOutput extends __MetadataBearer {}
6256
* <p>The request is invalid or malformed.</p>
6357
*
6458
* @throws {@link ConflictException} (client fault)
65-
* <p>The request failed because there is a conflict with a previous write. You can retry the
66-
* request.</p>
59+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
6760
*
6861
* @throws {@link ForbiddenException} (client fault)
6962
* <p>The caller isn't authorized to make the request.</p>

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

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface GetNamespaceCommandInput extends GetNamespaceRequest {}
2828
export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __MetadataBearer {}
2929

3030
/**
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>
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> <dl> <dt>Permissions</dt> <dd> <p>You must have the <code>s3tables:GetNamespace</code> permission to use this operation. </p> </dd> </dl>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -73,8 +67,7 @@ export interface GetNamespaceCommandOutput extends GetNamespaceResponse, __Metad
7367
* <p>The request is invalid or malformed.</p>
7468
*
7569
* @throws {@link ConflictException} (client fault)
76-
* <p>The request failed because there is a conflict with a previous write. You can retry the
77-
* request.</p>
70+
* <p>The request failed because there is a conflict with a previous write. You can retry the request.</p>
7871
*
7972
* @throws {@link ForbiddenException} (client fault)
8073
* <p>The caller isn't authorized to make the request.</p>

0 commit comments

Comments
 (0)