Skip to content

Commit 1991f3c

Browse files
author
awstools
committed
feat(client-keyspaces): This release provides change data capture (CDC) streams support through updates to the Amazon Keyspaces API.
1 parent 62c8210 commit 1991f3c

26 files changed

+619
-1345
lines changed

clients/client-keyspaces/README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,7 @@
66

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

9-
<p>Amazon Keyspaces (for Apache Cassandra) is a scalable,
10-
highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate,
11-
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,
12-
you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software. </p>
13-
<p>In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers,
14-
Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as
15-
infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes
16-
the supported DDL operations in detail.</p>
17-
<p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types
18-
in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer
19-
Guide</i>.</p>
20-
<p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer
21-
Guide</i>.</p>
22-
<p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>
9+
<p>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. </p> <p>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.</p> <p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>
2310

2411
## Installing
2512

clients/client-keyspaces/src/Keyspaces.ts

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -311,20 +311,7 @@ export interface Keyspaces {
311311
}
312312

313313
/**
314-
* <p>Amazon Keyspaces (for Apache Cassandra) is a scalable,
315-
* highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate,
316-
* 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,
317-
* you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software. </p>
318-
* <p>In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers,
319-
* Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as
320-
* infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes
321-
* the supported DDL operations in detail.</p>
322-
* <p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types
323-
* in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer
324-
* Guide</i>.</p>
325-
* <p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer
326-
* Guide</i>.</p>
327-
* <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>
314+
* <p>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. </p> <p>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.</p> <p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>
328315
* @public
329316
*/
330317
export class Keyspaces extends KeyspacesClient implements Keyspaces {}

clients/client-keyspaces/src/KeyspacesClient.ts

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -328,20 +328,7 @@ export type KeyspacesClientResolvedConfigType = __SmithyResolvedConfiguration<__
328328
export interface KeyspacesClientResolvedConfig extends KeyspacesClientResolvedConfigType {}
329329

330330
/**
331-
* <p>Amazon Keyspaces (for Apache Cassandra) is a scalable,
332-
* highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate,
333-
* 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,
334-
* you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software. </p>
335-
* <p>In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers,
336-
* Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as
337-
* infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes
338-
* the supported DDL operations in detail.</p>
339-
* <p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types
340-
* in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer
341-
* Guide</i>.</p>
342-
* <p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer
343-
* Guide</i>.</p>
344-
* <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>
331+
* <p>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. </p> <p>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.</p> <p>For the list of all supported CQL APIs, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cassandra-apis.html">Supported Cassandra APIs, operations, and data types in Amazon Keyspaces</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/logging-using-cloudtrail.html#service-name-info-in-cloudtrail">Amazon Keyspaces information in CloudTrail</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p> <p>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 <a href="https://docs.aws.amazon.com/general/latest/gr/aws-apis.html">Amazon Web Services APIs</a> in the <i>General Reference</i>.</p>
345332
* @public
346333
*/
347334
export class KeyspacesClient extends __Client<

clients/client-keyspaces/src/commands/CreateKeyspaceCommand.ts

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ export interface CreateKeyspaceCommandInput extends CreateKeyspaceRequest {}
2828
export interface CreateKeyspaceCommandOutput extends CreateKeyspaceResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>The <code>CreateKeyspace</code> operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names
32-
* must be unique within each Region.</p>
33-
* <p>
34-
* <code>CreateKeyspace</code> is an asynchronous operation. You can monitor the creation status of the new keyspace
35-
* by using the <code>GetKeyspace</code> operation.</p>
36-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.keyspaces.html">Create a keyspace</a> in the <i>Amazon Keyspaces Developer
37-
* Guide</i>.</p>
31+
* <p>The <code>CreateKeyspace</code> operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.</p> <p> <code>CreateKeyspace</code> is an asynchronous operation. You can monitor the creation status of the new keyspace by using the <code>GetKeyspace</code> operation.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.keyspaces.html">Create a keyspace</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
3832
* @example
3933
* Use a bare-bones client and the command you need to make an API call.
4034
* ```javascript
@@ -74,16 +68,13 @@ export interface CreateKeyspaceCommandOutput extends CreateKeyspaceResponse, __M
7468
* <p>You don't have sufficient access permissions to perform this action. </p>
7569
*
7670
* @throws {@link ConflictException} (client fault)
77-
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to
78-
* perform an action and the same or a different action is already
79-
* in progress, or if you try to create a resource that already exists. </p>
71+
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists. </p>
8072
*
8173
* @throws {@link InternalServerException} (server fault)
8274
* <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
8375
*
8476
* @throws {@link ServiceQuotaExceededException} (client fault)
85-
* <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
86-
* Guide</i>.</p>
77+
* <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
8778
*
8879
* @throws {@link ValidationException} (client fault)
8980
* <p>The operation failed due to an invalid or malformed request.</p>

clients/client-keyspaces/src/commands/CreateTableCommand.ts

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,7 @@ export interface CreateTableCommandInput extends CreateTableRequest {}
2828
export interface CreateTableCommandOutput extends CreateTableResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>The <code>CreateTable</code> operation adds a new table to the specified keyspace. Within a keyspace, table names
32-
* must be unique.</p>
33-
* <p>
34-
* <code>CreateTable</code> is an asynchronous operation. When the request is received, the status of the table is set to <code>CREATING</code>.
35-
* You can monitor the creation status of the new table by using the <code>GetTable</code>
36-
* operation, which returns the current <code>status</code> of the table. You can start using a table when the status is <code>ACTIVE</code>.</p>
37-
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.tables.html">Create a table</a> in the <i>Amazon Keyspaces Developer
38-
* Guide</i>.</p>
31+
* <p>The <code>CreateTable</code> operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.</p> <p> <code>CreateTable</code> is an asynchronous operation. When the request is received, the status of the table is set to <code>CREATING</code>. You can monitor the creation status of the new table by using the <code>GetTable</code> operation, which returns the current <code>status</code> of the table. You can start using a table when the status is <code>ACTIVE</code>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/getting-started.tables.html">Create a table</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
3932
* @example
4033
* Use a bare-bones client and the command you need to make an API call.
4134
* ```javascript
@@ -144,6 +137,17 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
144137
* },
145138
* },
146139
* ],
140+
* cdcSpecification: { // CdcSpecification
141+
* status: "STRING_VALUE", // required
142+
* viewType: "STRING_VALUE",
143+
* tags: [
144+
* {
145+
* key: "STRING_VALUE", // required
146+
* value: "STRING_VALUE", // required
147+
* },
148+
* ],
149+
* propagateTags: "STRING_VALUE",
150+
* },
147151
* };
148152
* const command = new CreateTableCommand(input);
149153
* const response = await client.send(command);
@@ -163,20 +167,16 @@ export interface CreateTableCommandOutput extends CreateTableResponse, __Metadat
163167
* <p>You don't have sufficient access permissions to perform this action. </p>
164168
*
165169
* @throws {@link ConflictException} (client fault)
166-
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to
167-
* perform an action and the same or a different action is already
168-
* in progress, or if you try to create a resource that already exists. </p>
170+
* <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to perform an action and the same or a different action is already in progress, or if you try to create a resource that already exists. </p>
169171
*
170172
* @throws {@link InternalServerException} (server fault)
171173
* <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
172174
*
173175
* @throws {@link ResourceNotFoundException} (client fault)
174-
* <p>The operation tried to access a keyspace, table, or type that doesn't exist. The resource might not be specified correctly,
175-
* or its status might not be <code>ACTIVE</code>.</p>
176+
* <p>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 <code>ACTIVE</code>.</p>
176177
*
177178
* @throws {@link ServiceQuotaExceededException} (client fault)
178-
* <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer
179-
* Guide</i>.</p>
179+
* <p>The operation exceeded the service quota for this resource. For more information on service quotas, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/quotas.html">Quotas</a> in the <i>Amazon Keyspaces Developer Guide</i>.</p>
180180
*
181181
* @throws {@link ValidationException} (client fault)
182182
* <p>The operation failed due to an invalid or malformed request.</p>

0 commit comments

Comments
 (0)