Amazon Keyspaces Keyspaces Type API
The Keyspaces Type API from Amazon Keyspaces — 4 operation(s) for keyspaces type.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-keyspaces:amazon-keyspaces-type-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon Keyspaces Type API
version: '2022-02-10'
description: Generated from AWS's published Smithy model for Amazon Keyspaces. 4 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://cassandra.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/#CreateType:
post:
operationId: CreateType
summary: Create Type
description: 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.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/CreateTypeResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- KeyspacesService.CreateType
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/CreateTypeRequest'
tags:
- Type
/#DeleteType:
post:
operationId: DeleteType
summary: Delete Type
description: The DeleteType operation deletes a user-defined type (UDT). You can only delete a type that is not used
in a table or another UDT. To configure the required permissions, see Permissions to delete a UDT in the Amazon Keyspaces
Developer Guide.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DeleteTypeResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- KeyspacesService.DeleteType
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/DeleteTypeRequest'
tags:
- Type
/#GetType:
post:
operationId: GetType
summary: Get Type
description: 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.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/GetTypeResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- KeyspacesService.GetType
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/GetTypeRequest'
tags:
- Type
/#ListTypes:
post:
operationId: ListTypes
summary: List Types
description: 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.
responses:
'200':
description: Success
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListTypesResponse'
'403':
description: AccessDeniedException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalServerException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/InternalServerException'
'404':
description: ResourceNotFoundException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'402':
description: ServiceQuotaExceededException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ServiceQuotaExceededException'
'400':
description: ValidationException
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ValidationException'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- KeyspacesService.ListTypes
requestBody:
required: true
content:
application/x-amz-json-1.0:
schema:
$ref: '#/components/schemas/ListTypesRequest'
tags:
- Type
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: cassandra
schemas:
AccessDeniedException:
type: object
properties:
message:
type: string
description: You don't have the required permissions to perform this operation. Verify your IAM permissions and
try again.
ConflictException:
type: object
properties:
message:
type: string
description: The requested operation conflicts with the current state of the resource or another concurrent operation.
CreateTypeRequest:
type: object
properties:
keyspaceName:
type: string
description: The name of the keyspace.
typeName:
type: string
description: 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 dou
fieldDefinitions:
type: array
items:
$ref: '#/components/schemas/FieldDefinition'
description: The field definitions, consisting of names and types, that define this type.
required:
- keyspaceName
- typeName
- fieldDefinitions
CreateTypeResponse:
type: object
properties:
keyspaceArn:
type: string
description: The unique identifier of the keyspace that contains the new type in the format of an Amazon Resource
Name (ARN).
typeName:
type: string
description: 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.
required:
- keyspaceArn
- typeName
DeleteTypeRequest:
type: object
properties:
keyspaceName:
type: string
description: The name of the keyspace of the to be deleted type.
typeName:
type: string
description: The name of the type to be deleted.
required:
- keyspaceName
- typeName
DeleteTypeResponse:
type: object
properties:
keyspaceArn:
type: string
description: The unique identifier of the keyspace from which the type was deleted in the format of an Amazon Resource
Name (ARN).
typeName:
type: string
description: The name of the type that was deleted.
required:
- keyspaceArn
- typeName
FieldDefinition:
type: object
properties:
name:
type: string
description: The identifier.
type:
type: string
description: Any supported Cassandra data type, including collections and other user-defined types that are contained
in the same keyspace. For more information, see Cassandra data type support in the Amazon Keyspaces Developer
Guide.
required:
- name
- type
GetTypeRequest:
type: object
properties:
keyspaceName:
type: string
description: The name of the keyspace that contains this type.
typeName:
type: string
description: 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.
required:
- keyspaceName
- typeName
GetTypeResponse:
type: object
properties:
keyspaceName:
type: string
description: The name of the keyspace that contains this type.
typeName:
type: string
description: The name of the type.
fieldDefinitions:
type: array
items:
$ref: '#/components/schemas/FieldDefinition'
description: The names and types that define this type.
lastModifiedTimestamp:
type: string
format: date-time
description: The timestamp that shows when this type was last modified.
status:
type: string
description: The status of this type.
directReferringTables:
type: array
items:
type: string
description: The tables that use this type.
directParentTypes:
type: array
items:
type: string
description: The types that use this type.
maxNestingDepth:
type: integer
description: The level of nesting implemented for this type.
keyspaceArn:
type: string
description: The unique identifier of the keyspace that contains this type in the format of an Amazon Resource Name
(ARN).
required:
- keyspaceName
- typeName
- keyspaceArn
InternalServerException:
type: object
properties:
message:
type: string
description: An internal service error occurred. Retry your request. If the problem persists, contact Amazon Web
Services Support.
ListTypesRequest:
type: object
properties:
nextToken:
type: string
description: The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent
API invocation.
maxResults:
type: integer
description: 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.
keyspaceName:
type: string
description: The name of the keyspace that contains the listed types.
required:
- keyspaceName
ListTypesResponse:
type: object
properties:
nextToken:
type: string
description: The pagination token. To resume pagination, provide the NextToken value as an argument of a subsequent
API invocation.
types:
type: array
items:
type: string
description: The list of types contained in the specified keyspace.
required:
- types
ResourceNotFoundException:
type: object
properties:
message:
type: string
description: The specified resource was not found. Verify the resource identifier and ensure the resource exists
and is in an ACTIVE state.
resourceArn:
type: string
description: The unique identifier in the format of Amazon Resource Name (ARN) for the resource couldn't be found.
ServiceQuotaExceededException:
type: object
properties:
message:
type: string
description: The requested operation would exceed the service quota for this resource. Review the service quotas
and adjust your request accordingly.
ValidationException:
type: object
properties:
message:
type: string
description: The request parameters are invalid or malformed. Review the API documentation and correct the request
format.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/keyspaces/service/2022-02-10/keyspaces-2022-02-10.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)