Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListTableBuckets

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.

Request Syntax


GET /buckets?continuationToken=continuationToken&maxBuckets=maxBuckets&prefix=prefix&type=type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

continuationToken

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.

Length Constraints: Minimum length of 1. Maximum length of 2048.

maxBuckets

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

Valid Range: Minimum value of 1. Maximum value of 1000.

prefix

The prefix of the table buckets.

Length Constraints: Minimum length of 1. Maximum length of 63.

type

The type of table buckets to filter by in the list.

Valid Values: customer | aws

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "continuationToken": "string",
   "tableBuckets": [ 
      { 
         "arn": "string",
         "createdAt": "string",
         "name": "string",
         "ownerAccountId": "string",
         "tableBucketId": "string",
         "type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

continuationToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

tableBuckets

A list of table buckets.

Type: Array of TableBucketSummary objects

Errors

AccessDeniedException

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

HTTP Status Code: 403

BadRequestException

The request is invalid or malformed.

HTTP Status Code: 400

ConflictException

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

HTTP Status Code: 409

ForbiddenException

The caller isn't authorized to make the request.

HTTP Status Code: 403

InternalServerErrorException

The request failed due to an internal server error.

HTTP Status Code: 500

NotFoundException

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

HTTP Status Code: 404

TooManyRequestsException

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

HTTP Status Code: 429