@aws-sdk/client-keyspaces

Description

AWS SDK for JavaScript Keyspaces Client for Node.js, Browser and React Native.

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.

Installing

To install this package, simply type add or install @aws-sdk/client-keyspaces
using your favorite package manager:
- npm install @aws-sdk/client-keyspaces
- yarn add @aws-sdk/client-keyspaces
- pnpm add @aws-sdk/client-keyspaces

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the KeyspacesClient and
the commands you need, for example ListKeyspacesCommand:

``js
// ES5 example
const { KeyspacesClient, ListKeyspacesCommand } = require("@aws-sdk/client-keyspaces");
`

`ts
// ES6+ example
import { KeyspacesClient, ListKeyspacesCommand } from "@aws-sdk/client-keyspaces";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new KeyspacesClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListKeyspacesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-keyspaces";
const client = new AWS.Keyspaces({ region: "REGION" });

// async/await.
try {
const data = await client.listKeyspaces(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listKeyspaces(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listKeyspaces(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-keyspaces` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CreateKeyspace

Command API Reference / Input / Output

CreateTable

Command API Reference / Input / Output

CreateType

Command API Reference / Input / Output

DeleteKeyspace

Command API Reference / Input / Output

DeleteTable

Command API Reference / Input / Output

DeleteType

Command API Reference / Input / Output

GetKeyspace

Command API Reference / Input / Output

GetTable

Command API Reference / Input / Output

GetTableAutoScalingSettings

Command API Reference / Input / Output

GetType

Command API Reference / Input / Output

ListKeyspaces

Command API Reference / Input / Output

ListTables

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListTypes

Command API Reference / Input / Output

RestoreTable

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateKeyspace

Command API Reference / Input / Output

UpdateTable

Command API Reference / Input / Output