Get Type

keyspaces_get_type

R Documentation

The GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables

Description

The get_type operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables.

To read keyspace metadata using get_type, 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_get_type(keyspaceName, typeName)

Arguments

keyspaceName

[required] The name of the keyspace that contains this type.

typeName

[required] The formatted name of the type. For example, if the name of the type was created without double quotes, Amazon Keyspaces saved the name in lower-case characters. If the name was created in double quotes, you must use double quotes to specify the type name.

Value

A list with the following syntax:

list(
  keyspaceName = "string",
  typeName = "string",
  fieldDefinitions = list(
    list(
      name = "string",
      type = "string"
    )
  ),
  lastModifiedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  status = "ACTIVE"|"CREATING"|"DELETING"|"RESTORING",
  directReferringTables = list(
    "string"
  ),
  directParentTypes = list(
    "string"
  ),
  maxNestingDepth = 123,
  keyspaceArn = "string"
)

Request syntax

svc$get_type(
  keyspaceName = "string",
  typeName = "string"
)