Navigation Guide
You are on the package index page for the Client of a service. Return to the Client landing page

@aws-sdk/client-keyspaces

Description

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.

Installation

NPM

npm install @aws-sdk/client-keyspaces

Yarn

yarn add @aws-sdk/client-keyspaces

pnpm

pnpm add @aws-sdk/client-keyspaces

Types

Type Name	Type
AccessDeniedException	Class
AutoScalingPolicy	Interface
AutoScalingSettings	Interface
AutoScalingSpecification	Interface
CapacitySpecification	Interface
CapacitySpecificationSummary	Interface
ClientDefaults	Interface
ClientInputEndpointParameters	Interface
ClientSideTimestamps	Interface
ClientSideTimestampsStatus	TypeAlias
ClientSideTimestampsStatusenum	Variable
ClusteringKey	Interface
ColumnDefinition	Interface
Comment	Interface
ConflictException	Class
CreateKeyspaceCommand	Class
CreateKeyspaceCommandInput	Interface
CreateKeyspaceCommandOutput	Interface
CreateKeyspaceRequest	Interface
CreateKeyspaceResponse	Interface
CreateTableCommand	Class
CreateTableCommandInput	Interface
CreateTableCommandOutput	Interface
CreateTableRequest	Interface
CreateTableResponse	Interface
CreateTypeCommand	Class
CreateTypeCommandInput	Interface
CreateTypeCommandOutput	Interface
CreateTypeRequest	Interface
CreateTypeResponse	Interface
DeleteKeyspaceCommand	Class
DeleteKeyspaceCommandInput	Interface
DeleteKeyspaceCommandOutput	Interface
DeleteKeyspaceRequest	Interface
DeleteKeyspaceResponse	Interface
DeleteTableCommand	Class
DeleteTableCommandInput	Interface
DeleteTableCommandOutput	Interface
DeleteTableRequest	Interface
DeleteTableResponse	Interface
DeleteTypeCommand	Class
DeleteTypeCommandInput	Interface
DeleteTypeCommandOutput	Interface
DeleteTypeRequest	Interface
DeleteTypeResponse	Interface
EncryptionSpecification	Interface
EncryptionType	TypeAlias
EncryptionTypeenum	Variable
FieldDefinition	Interface
GetKeyspaceCommand	Class
GetKeyspaceCommandInput	Interface
GetKeyspaceCommandOutput	Interface
GetKeyspaceRequest	Interface
GetKeyspaceResponse	Interface
GetTableAutoScalingSettingsCommand	Class
GetTableAutoScalingSettingsCommandInput	Interface
GetTableAutoScalingSettingsCommandOutput	Interface
GetTableAutoScalingSettingsRequest	Interface
GetTableAutoScalingSettingsResponse	Interface
GetTableCommand	Class
GetTableCommandInput	Interface
GetTableCommandOutput	Interface
GetTableRequest	Interface
GetTableResponse	Interface
GetTypeCommand	Class
GetTypeCommandInput	Interface
GetTypeCommandOutput	Interface
GetTypeRequest	Interface
GetTypeResponse	Interface
InternalServerException	Class
Keyspaces	Class
Keyspaces	Interface
KeyspacesClient	Class
KeyspacesClientConfig	Interface
KeyspacesClientConfigType	TypeAlias
KeyspacesClientResolvedConfig	Interface
KeyspacesClientResolvedConfigType	TypeAlias
KeyspacesPaginationConfiguration	Interface
KeyspacesServiceException	Class
KeyspaceStatus	TypeAlias
KeyspaceStatusenum	Variable
KeyspaceSummary	Interface
ListKeyspacesCommand	Class
ListKeyspacesCommandInput	Interface
ListKeyspacesCommandOutput	Interface
ListKeyspacesRequest	Interface
ListKeyspacesResponse	Interface
ListTablesCommand	Class
ListTablesCommandInput	Interface
ListTablesCommandOutput	Interface
ListTablesRequest	Interface
ListTablesResponse	Interface
ListTagsForResourceCommand	Class
ListTagsForResourceCommandInput	Interface
ListTagsForResourceCommandOutput	Interface
ListTagsForResourceRequest	Interface
ListTagsForResourceResponse	Interface
ListTypesCommand	Class
ListTypesCommandInput	Interface
ListTypesCommandOutput	Interface
ListTypesRequest	Interface
ListTypesResponse	Interface
paginateListKeyspaces	Variable
paginateListTables	Variable
paginateListTagsForResource	Variable
paginateListTypes	Variable
PartitionKey	Interface
PointInTimeRecovery	Interface
PointInTimeRecoveryStatus	TypeAlias
PointInTimeRecoveryStatusenum	Variable
PointInTimeRecoverySummary	Interface
ReplicaAutoScalingSpecification	Interface
ReplicaSpecification	Interface
ReplicaSpecificationSummary	Interface
ReplicationGroupStatus	Interface
ReplicationSpecification	Interface
ResourceNotFoundException	Class
RestoreTableCommand	Class
RestoreTableCommandInput	Interface
RestoreTableCommandOutput	Interface
RestoreTableRequest	Interface
RestoreTableResponse	Interface
Rs	TypeAlias
Rsenum	Variable
RuntimeExtension	Interface
SchemaDefinition	Interface
ServiceInputTypes	TypeAlias
ServiceOutputTypes	TypeAlias
ServiceQuotaExceededException	Class
SortOrder	TypeAlias
SortOrderenum	Variable
StaticColumn	Interface
TableStatus	TypeAlias
TableStatusenum	Variable
TableSummary	Interface
Tag	Interface
TagResourceCommand	Class
TagResourceCommandInput	Interface
TagResourceCommandOutput	Interface
TagResourceRequest	Interface
TagResourceResponse	Interface
TargetTrackingScalingPolicyConfiguration	Interface
ThroughputMode	TypeAlias
ThroughputModeenum	Variable
TimeToLive	Interface
TimeToLiveStatus	TypeAlias
TimeToLiveStatusenum	Variable
TypeStatus	TypeAlias
TypeStatusenum	Variable
UntagResourceCommand	Class
UntagResourceCommandInput	Interface
UntagResourceCommandOutput	Interface
UntagResourceRequest	Interface
UntagResourceResponse	Interface
UpdateKeyspaceCommand	Class
UpdateKeyspaceCommandInput	Interface
UpdateKeyspaceCommandOutput	Interface
UpdateKeyspaceRequest	Interface
UpdateKeyspaceResponse	Interface
UpdateTableCommand	Class
UpdateTableCommandInput	Interface
UpdateTableCommandOutput	Interface
UpdateTableRequest	Interface
UpdateTableResponse	Interface
ValidationException	Class

Getting Started

References

@aws-sdk/client-keyspaces

Description

Installation

Types