ListTables
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
s3:ListTables
permission to use this operation.
Request Syntax
GET /tables/tableBucketARN
?continuationToken=continuationToken
&maxTables=maxTables
&namespace=namespace
&prefix=prefix
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 thisContinuationToken
for pagination of the list results.Length Constraints: Minimum length of 1. Maximum length of 2048.
- maxTables
-
The maximum number of tables to return.
Valid Range: Minimum value of 1. Maximum value of 1000.
- namespace
-
The namespace of the tables.
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[0-9a-z_]*
- prefix
-
The prefix of the tables.
Length Constraints: Minimum length of 1. Maximum length of 255.
- tableBucketARN
-
The Amazon resource Name (ARN) of the table bucket.
Pattern:
(arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:bucket/[a-z0-9_-]{3,63})
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"continuationToken": "string",
"tables": [
{
"createdAt": "string",
"modifiedAt": "string",
"name": "string",
"namespace": [ "string" ],
"tableARN": "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.
- tables
-
A list of tables.
Type: Array of TableSummary objects
Errors
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: