ListTablesCommand

Suggest an Edit

List tables in the given table bucket. For more information, see S3 Tables  in the Amazon Simple Storage Service User Guide.

Permissions

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

Example Syntax

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

import { S3TablesClient, ListTablesCommand } from "@aws-sdk/client-s3tables"; // ES Modules import
// const { S3TablesClient, ListTablesCommand } = require("@aws-sdk/client-s3tables"); // CommonJS import
const client = new S3TablesClient(config);
const input = { // ListTablesRequest
  tableBucketARN: "STRING_VALUE", // required
  namespace: "STRING_VALUE",
  prefix: "STRING_VALUE",
  continuationToken: "STRING_VALUE",
  maxTables: Number("int"),
};
const command = new ListTablesCommand(input);
const response = await client.send(command);
// { // ListTablesResponse
//   tables: [ // TableSummaryList // required
//     { // TableSummary
//       namespace: [ // NamespaceList // required
//         "STRING_VALUE",
//       ],
//       name: "STRING_VALUE", // required
//       type: "customer" || "aws", // required
//       tableARN: "STRING_VALUE", // required
//       createdAt: new Date("TIMESTAMP"), // required
//       modifiedAt: new Date("TIMESTAMP"), // required
//       namespaceId: "STRING_VALUE",
//       tableBucketId: "STRING_VALUE",
//     },
//   ],
//   continuationToken: "STRING_VALUE",
// };

ListTablesCommand Input

See ListTablesCommandInput for more details

Parameter
Type
Description
tableBucketARN
Required
string | undefined

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

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.

maxTables
number | undefined

The maximum number of tables to return.

namespace
string | undefined

The namespace of the tables.

prefix
string | undefined

The prefix of the tables.

ListTablesCommand Output

See ListTablesCommandOutput for details

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

A list of tables.

continuationToken
string | undefined

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

Throws

Name
Fault
Details
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.