Keyspaces / Client / list_tables

list_tables#

Keyspaces.Client.list_tables(**kwargs)#

The ListTables operation returns a list of tables for a specified keyspace.

To read keyspace metadata using ListTables, the IAM principal needs Select action permissions for the system keyspace.

Request Syntax

response = client.list_tables(
    nextToken='string',
    maxResults=123,
    keyspaceName='string'
)

Parameters:

nextToken (string) – The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.
maxResults (integer) – The total number of tables to return in the output. If the total number of tables available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.
keyspaceName (string) –
[REQUIRED]

The name of the keyspace.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'tables': [
        {
            'keyspaceName': 'string',
            'tableName': 'string',
            'resourceArn': 'string'
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previously truncated response.
- tables (list) –
  
  A list of tables.
  - (dict) –
    
    Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).
    - keyspaceName (string) –
      
      The name of the keyspace that the table is stored in.
    - tableName (string) –
      
      The name of the table.
    - resourceArn (string) –
      
      The unique identifier of the table in the format of an Amazon Resource Name (ARN).

Exceptions

Keyspaces.Client.exceptions.ValidationException
Keyspaces.Client.exceptions.ServiceQuotaExceededException
Keyspaces.Client.exceptions.InternalServerException
Keyspaces.Client.exceptions.AccessDeniedException
Keyspaces.Client.exceptions.ResourceNotFoundException