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.
Request Syntax
{
"fieldDefinitions": [
{
"name": "string",
"type": "string"
}
],
"keyspaceName": "string",
"typeName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- fieldDefinitions
-
The field definitions, consisting of names and types, that define this type.
Type: Array of FieldDefinition objects
Array Members: Minimum number of 1 item.
Required: Yes
- keyspaceName
-
The name of the keyspace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47}Required: Yes
- typeName
-
The name of the user-defined type.
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.
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.
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Required: Yes
Response Syntax
{
"keyspaceArn": "string",
"typeName": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- keyspaceArn
-
The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource Name (ARN).
Type: String
Length Constraints: Minimum length of 20. Maximum length of 1000.
Pattern:
arn:(aws[a-zA-Z0-9-]*):cassandra:.+.* - typeName
-
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
GetType.Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have sufficient access permissions to perform this action.
HTTP Status Code: 400
- ConflictException
-
Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists.
HTTP Status Code: 400
- InternalServerException
-
Amazon Keyspaces was unable to fully process this request because of an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly, or its status might not be
ACTIVE.HTTP Status Code: 400
- ServiceQuotaExceededException
-
The operation exceeded the service quota for this resource. For more information on service quotas, see Quotas in the Amazon Keyspaces Developer Guide.
HTTP Status Code: 400
- ValidationException
-
The operation failed due to an invalid or malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
