GetTableBucketCommand

Suggest an Edit

Gets details on a table bucket. For more information, see Viewing details about an Amazon S3 table bucket  in the Amazon Simple Storage Service User Guide.

Permissions

You must have the s3tables:GetTableBucket permission to use this operation.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { S3TablesClient, GetTableBucketCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, GetTableBucketCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // GetTableBucketRequest
  tableBucketARN: "STRING_VALUE", // required
};
const command = new GetTableBucketCommand(input);
const response = await client.send(command);
// { // GetTableBucketResponse
//   arn: "STRING_VALUE", // required
//   name: "STRING_VALUE", // required
//   ownerAccountId: "STRING_VALUE", // required
//   createdAt: new Date("TIMESTAMP"), // required
//   tableBucketId: "STRING_VALUE",
// };

GetTableBucketCommand Input

See GetTableBucketCommandInput for more details

Parameter
Type
Description
tableBucketARN
Required
string | undefined

The Amazon Resource Name (ARN) of the table bucket.

GetTableBucketCommand Output

See GetTableBucketCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
Required
string | undefined

The Amazon Resource Name (ARN) of the table bucket.

createdAt
Required
Date | undefined

The date and time the table bucket was created.

name
Required
string | undefined

The name of the table bucket

ownerAccountId
Required
string | undefined

The ID of the account that owns the table bucket.

tableBucketId
string | undefined

The unique identifier of the table bucket.

Throws

Name
Fault
Details
AccessDeniedException
client

The action cannot be performed because you do not have the required permission.

BadRequestException
client

The request is invalid or malformed.

ConflictException
client

The request failed because there is a conflict with a previous write. You can retry the request.

ForbiddenException
client

The caller isn't authorized to make the request.

InternalServerErrorException
server

The request failed due to an internal server error.

NotFoundException
client

The request was rejected because the specified resource could not be found.

TooManyRequestsException
client

The limit on the number of requests per second was exceeded.

S3TablesServiceException
Base exception class for all service exceptions from S3Tables service.