GetType
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.
Request Syntax
{
"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.
- keyspaceName
-
The name of the keyspace that contains this type.
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 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Required: Yes
Response Syntax
{
"directParentTypes": [ "string" ],
"directReferringTables": [ "string" ],
"fieldDefinitions": [
{
"name": "string",
"type": "string"
}
],
"keyspaceArn": "string",
"keyspaceName": "string",
"lastModifiedTimestamp": number,
"maxNestingDepth": number,
"status": "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.
- directParentTypes
-
The types that use this type.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 48.
- directReferringTables
-
The tables that use this type.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47} - fieldDefinitions
-
The names and types that define this type.
Type: Array of FieldDefinition objects
Array Members: Minimum number of 1 item.
- keyspaceArn
-
The unique identifier of the keyspace that contains this 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:.+.* - keyspaceName
-
The name of the keyspace that contains this type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 48.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_]{0,47} - lastModifiedTimestamp
-
The timestamp that shows when this type was last modified.
Type: Timestamp
- maxNestingDepth
-
The level of nesting implemented for this type.
Type: Integer
- status
-
The status of this type.
Type: String
Valid Values:
ACTIVE | CREATING | DELETING | RESTORING - typeName
-
The name of the type.
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
- 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:
