Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1419128123.4 KB

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.

To read keyspace metadata using GetType, 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.

post/#X-Amz-Target=KeyspacesService.GetType

Headers

X-Amz-Target'KeyspacesService.GetType' required

Request body

keyspaceNamestring required

The name of the keyspace that contains this type.

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

Response

Success

keyspaceNamestring required

The name of the keyspace that contains this type.

typeNamestring required

The name of the type.

lastModifiedTimestampstring date-time

The timestamp that shows when this type was last modified.

status'ACTIVE' | 'CREATING' | 'DELETING' | 'RESTORING'

The status of this type.

directReferringTablesTableName[]

The tables that use this type.

directParentTypesTypeName[]

The types that use this type.

maxNestingDepthinteger

The level of nesting implemented for this type.

keyspaceArnstring required

The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name (ARN).