S3Tables / Client / list_table_buckets

list_table_buckets¶

S3Tables.Client.list_table_buckets(**kwargs)¶

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

response = client.list_table_buckets(
    prefix='string',
    continuationToken='string',
    maxBuckets=123,
    type='customer'|'aws'
)

Parameters:

prefix (string) – The prefix of the table buckets.
continuationToken (string) – 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 (integer) – The maximum number of table buckets to return in the list.
type (string) – The type of table buckets to filter by in the list.

Return type:

dict

Returns:

Response Syntax

{
    'tableBuckets': [
        {
            'arn': 'string',
            'name': 'string',
            'ownerAccountId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'tableBucketId': 'string',
            'type': 'customer'|'aws'
        },
    ],
    'continuationToken': 'string'
}

Response Structure

(dict) –
- tableBuckets (list) –
  
  A list of table buckets.
  - (dict) –
    
    Contains details about a table bucket.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the table bucket.
    - name (string) –
      
      The name of the table bucket.
    - ownerAccountId (string) –
      
      The ID of the account that owns the table bucket.
    - createdAt (datetime) –
      
      The date and time the table bucket was created at.
    - tableBucketId (string) –
      
      The system-assigned unique identifier for the table bucket.
    - type (string) –
      
      The type of the table bucket.
- continuationToken (string) –
  
  You can use this ContinuationToken for pagination of the list results.

Exceptions

S3Tables.Client.exceptions.InternalServerErrorException
S3Tables.Client.exceptions.ForbiddenException
S3Tables.Client.exceptions.NotFoundException
S3Tables.Client.exceptions.AccessDeniedException
S3Tables.Client.exceptions.TooManyRequestsException
S3Tables.Client.exceptions.ConflictException
S3Tables.Client.exceptions.BadRequestException