Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListTypes

The ListTypes operation returns a list of types for a specified keyspace.

To read keyspace metadata using ListTypes, 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",
   "maxResults": number,
   "nextToken": "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 the listed types.

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

maxResults

The total number of types to return in the output. If the total number of types available is more than the value specified, a NextToken is provided in the output. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

Response Syntax


{
   "nextToken": "string",
   "types": [ "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.

nextToken

The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent API invocation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

types

The list of types contained in the specified keyspace.

Type: Array of strings

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