Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1419128123.4 KB

The CreateType operation creates a new user-defined type in the specified keyspace.

To configure the required permissions, see Permissions to create a UDT in the Amazon Keyspaces Developer Guide.

For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.

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

Headers

X-Amz-Target'KeyspacesService.CreateType' required

Request body

keyspaceNamestring required

The name of the keyspace.

typeNamestring required
<p> The name of the user-defined type. </p> <p>UDT names must contain 48 characters or less, must begin with an alphabetic character, and can only contain alpha-numeric characters and underscores. Amazon Keyspaces converts upper case characters automatically into lower case characters. </p> <p>Alternatively, you can declare a UDT name in double quotes. When declaring a UDT name inside double quotes, Amazon Keyspaces preserves upper casing and allows special characters.</p> <p>You can also use double quotes as part of the name when you create the UDT, but you must escape each double quote character with an additional double quote character.</p>

Response

Success

keyspaceArnstring required

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

typeNamestring required

The formatted name of the user-defined type that was created. Note that Amazon Keyspaces requires the formatted name of the type for other operations, for example <code>GetType</code>.