Skip to content

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

Description

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

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

Usage

keyspaces_list_tables(nextToken, maxResults, keyspaceName)

Arguments

  • nextToken

    The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

  • maxResults

    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

    [required] The name of the keyspace.

Value

A list with the following syntax:

list(
  nextToken = "string",
  tables = list(
    list(
      keyspaceName = "string",
      tableName = "string",
      resourceArn = "string"
    )
  )
)

Request syntax

svc$list_tables(
  nextToken = "string",
  maxResults = 123,
  keyspaceName = "string"
)