List Types

keyspaces_list_types

R Documentation

The ListTypes operation returns a list of types for a specified keyspace¶

Description¶

The list_types operation returns a list of types for a specified keyspace.

To read keyspace metadata using list_types, the IAM principal needs Select action permissions for the system keyspace. To configure the required permissions, see Permissions to view a UDT in the Amazon Keyspaces Developer Guide.

Usage¶

keyspaces_list_types(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 types to return in the output. If the total number of types 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 that contains the listed types.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  types = list(
    "string"
  )
)

Request syntax¶

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