Amazon Web Services, Inc.

Amazon Keyspaces

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software. In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail. For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide . To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide . For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference .

Endpoints 19

  • POSTCreate keyspace/#X-Amz-Target=KeyspacesService.CreateKeyspaceThe CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.…
  • POSTCreate table/#X-Amz-Target=KeyspacesService.CreateTableThe CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique. CreateTable is an asynchronous operation.…
  • POSTCreate type/#X-Amz-Target=KeyspacesService.CreateTypeThe CreateType operation creates a new user-defined type in the specified keyspace. To configure the required permissions, see Permissions to create a UDT in…
  • POSTDelete keyspace/#X-Amz-Target=KeyspacesService.DeleteKeyspaceThe DeleteKeyspace operation deletes a keyspace and all of its tables.
  • POSTDelete table/#X-Amz-Target=KeyspacesService.DeleteTableThe DeleteTable operation deletes a table and all of its data. After a DeleteTable request is received, the specified table is in the DELETING state until…
  • POSTDelete type/#X-Amz-Target=KeyspacesService.DeleteTypeThe 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…
  • POSTGet keyspace/#X-Amz-Target=KeyspacesService.GetKeyspaceReturns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region…
  • POSTGet table/#X-Amz-Target=KeyspacesService.GetTableReturns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata. To read table…
  • POSTGet table auto scaling settings/#X-Amz-Target=KeyspacesService.GetTableAutoScalingSettingsReturns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific…
  • POSTGet type/#X-Amz-Target=KeyspacesService.GetTypeThe GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of…
  • POSTList keyspaces/#X-Amz-Target=KeyspacesService.ListKeyspacesThe ListKeyspaces operation returns a list of keyspaces.
  • POSTList tables/#X-Amz-Target=KeyspacesService.ListTablesThe ListTables operation returns a list of tables for a specified keyspace. To read keyspace metadata using ListTables , the IAM principal needs Select action…
  • POSTList tags for resource/#X-Amz-Target=KeyspacesService.ListTagsForResourceReturns a list of all tags associated with the specified Amazon Keyspaces resource. To read keyspace metadata using ListTagsForResource , the IAM principal…
  • POSTList types/#X-Amz-Target=KeyspacesService.ListTypesThe ListTypes operation returns a list of types for a specified keyspace. To read keyspace metadata using ListTypes , the IAM principal needs Select action…
  • POSTRestore table/#X-Amz-Target=KeyspacesService.RestoreTableRestores the table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points,…
  • POSTTag resource/#X-Amz-Target=KeyspacesService.TagResourceAssociates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console…
  • POSTUntag resource/#X-Amz-Target=KeyspacesService.UntagResourceRemoves the association of tags from a Amazon Keyspaces resource.
  • POSTUpdate keyspace/#X-Amz-Target=KeyspacesService.UpdateKeyspaceAdds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon…
  • POSTUpdate table/#X-Amz-Target=KeyspacesService.UpdateTableAdds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl…

API details

Base URL
https://cassandra.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
19 operations on 19 pathsPOST 19
Description format
AWS Smithy model, API version 2022-02-10

How to test the Amazon Keyspaces in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Keyspaces collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create keyspace” (POST /#X-Amz-Target=KeyspacesService.CreateKeyspace), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Keyspaces?

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it… It is listed under Developer tools and has 19 endpoints.

Who publishes the Amazon Keyspaces?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Keyspaces?

Requests go to https://cassandra.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Keyspaces?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Keyspaces have?

19 operations on 19 paths (19 POST).

Is forking the Amazon Keyspaces free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.