ListTableBucketsCommand

Suggest an Edit

Lists table buckets for your account. For more information, see S3 Table buckets  in the Amazon Simple Storage Service User Guide.

Permissions

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

Example Syntax

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

import { S3TablesClient, ListTableBucketsCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, ListTableBucketsCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // ListTableBucketsRequest
  prefix: "STRING_VALUE",
  continuationToken: "STRING_VALUE",
  maxBuckets: Number("int"),
};
const command = new ListTableBucketsCommand(input);
const response = await client.send(command);
// { // ListTableBucketsResponse
//   tableBuckets: [ // TableBucketSummaryList // required
//     { // TableBucketSummary
//       arn: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       ownerAccountId: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       tableBucketId: "STRING_VALUE",
//     },
//   ],
//   continuationToken: "STRING_VALUE",
// };

ListTableBucketsCommand Input

See ListTableBucketsCommandInput for more details

Parameter
Type
Description
continuationToken
string | undefined

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

maxBuckets
number | undefined

The maximum number of table buckets to return in the list.

prefix
string | undefined

The prefix of the table buckets.

ListTableBucketsCommand Output

See ListTableBucketsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
tableBuckets
Required
TableBucketSummary[] | undefined

A list of table buckets.

continuationToken
string | undefined

You can use this ContinuationToken for pagination of the list results.

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.