S3Tables / Client / list_tables

list_tables#

S3Tables.Client.list_tables(**kwargs)#

List tables in the given table bucket.

See also: AWS API Documentation

Request Syntax

response = client.list_tables(
    tableBucketARN='string',
    namespace='string',
    prefix='string',
    continuationToken='string',
    maxTables=123
)
Parameters:

  • tableBucketARN (string) –

    [REQUIRED]

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

  • namespace (string) – The namespace of the tables.

  • prefix (string) – The prefix of the tables.

  • 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.

  • maxTables (integer) – The maximum number of tables to return.

Return type:

dict

Returns:

Response Syntax

{
    'tables': [
        {
            'namespace': [
                'string',
            ],
            'name': 'string',
            'type': 'customer'|'aws',
            'tableARN': 'string',
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1)
        },
    ],
    'continuationToken': 'string'
}

Response Structure

  • (dict) –

    • tables (list) –

      A list of tables.

      • (dict) –

        Contains details about a table.

        • namespace (list) –

          The name of the namespace.

          • (string) –

        • name (string) –

          The name of the table.

        • type (string) –

          The type of the table.

        • tableARN (string) –

          The Amazon Resource Number (ARN) of the table.

        • createdAt (datetime) –

          The date and time the table was created at.

        • modifiedAt (datetime) –

          The date and time the table was last modified at.

    • 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.TooManyRequestsException

  • S3Tables.Client.exceptions.ConflictException

  • S3Tables.Client.exceptions.BadRequestException