@aws-sdk/client-keyspaces 3.289.0 → 3.291.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +10 -2
- package/dist-cjs/protocols/Aws_json1_0.js +19 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +7 -0
- package/dist-es/protocols/Aws_json1_0.js +19 -0
- package/dist-types/Keyspaces.d.ts +29 -11
- package/dist-types/KeyspacesClient.d.ts +2 -1
- package/dist-types/commands/CreateKeyspaceCommand.d.ts +19 -0
- package/dist-types/commands/CreateTableCommand.d.ts +22 -0
- package/dist-types/commands/DeleteKeyspaceCommand.d.ts +22 -0
- package/dist-types/commands/DeleteTableCommand.d.ts +22 -0
- package/dist-types/commands/GetKeyspaceCommand.d.ts +17 -0
- package/dist-types/commands/GetTableCommand.d.ts +17 -0
- package/dist-types/commands/ListKeyspacesCommand.d.ts +17 -0
- package/dist-types/commands/ListTablesCommand.d.ts +17 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +17 -0
- package/dist-types/commands/RestoreTableCommand.d.ts +49 -10
- package/dist-types/commands/TagResourceCommand.d.ts +17 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +22 -0
- package/dist-types/commands/UpdateTableCommand.d.ts +22 -0
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +336 -99
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +12 -0
- package/package.json +29 -29
|
@@ -17,9 +17,15 @@ export declare enum ThroughputMode {
|
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
19
|
* <p>Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables: </p>
|
|
20
|
-
* <
|
|
21
|
-
*
|
|
22
|
-
*
|
|
20
|
+
* <ul>
|
|
21
|
+
* <li>
|
|
22
|
+
* <p>On-demand (default)</p>
|
|
23
|
+
* </li>
|
|
24
|
+
* <li>
|
|
25
|
+
* <p>Provisioned</p>
|
|
26
|
+
* </li>
|
|
27
|
+
* </ul>
|
|
28
|
+
* <p>The read/write capacity mode that you choose controls how you are charged for read and
|
|
23
29
|
* write throughput and how table throughput capacity is managed.</p>
|
|
24
30
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
25
31
|
* Guide</i>.</p>
|
|
@@ -27,9 +33,17 @@ export declare enum ThroughputMode {
|
|
|
27
33
|
export interface CapacitySpecification {
|
|
28
34
|
/**
|
|
29
35
|
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
30
|
-
* <
|
|
31
|
-
*
|
|
32
|
-
* <
|
|
36
|
+
* <ul>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>
|
|
39
|
+
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>
|
|
43
|
+
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
44
|
+
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
45
|
+
* </li>
|
|
46
|
+
* </ul>
|
|
33
47
|
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
34
48
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
35
49
|
* Guide</i>.</p>
|
|
@@ -48,17 +62,33 @@ export interface CapacitySpecification {
|
|
|
48
62
|
}
|
|
49
63
|
/**
|
|
50
64
|
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
51
|
-
* <
|
|
52
|
-
*
|
|
65
|
+
* <ul>
|
|
66
|
+
* <li>
|
|
67
|
+
* <p>
|
|
68
|
+
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
69
|
+
* </li>
|
|
70
|
+
* <li>
|
|
71
|
+
* <p>
|
|
72
|
+
* <code>throughputMode:PROVISIONED</code>.</p>
|
|
73
|
+
* </li>
|
|
74
|
+
* </ul>
|
|
53
75
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
54
76
|
* Guide</i>.</p>
|
|
55
77
|
*/
|
|
56
78
|
export interface CapacitySpecificationSummary {
|
|
57
79
|
/**
|
|
58
80
|
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
59
|
-
* <
|
|
60
|
-
*
|
|
61
|
-
* <
|
|
81
|
+
* <ul>
|
|
82
|
+
* <li>
|
|
83
|
+
* <p>
|
|
84
|
+
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
85
|
+
* </li>
|
|
86
|
+
* <li>
|
|
87
|
+
* <p>
|
|
88
|
+
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
89
|
+
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input. </p>
|
|
90
|
+
* </li>
|
|
91
|
+
* </ul>
|
|
62
92
|
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
63
93
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
64
94
|
* Guide</i>.</p>
|
|
@@ -79,6 +109,20 @@ export interface CapacitySpecificationSummary {
|
|
|
79
109
|
*/
|
|
80
110
|
lastUpdateToPayPerRequestTimestamp?: Date;
|
|
81
111
|
}
|
|
112
|
+
export declare enum ClientSideTimestampsStatus {
|
|
113
|
+
ENABLED = "ENABLED"
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* <p>The client-side timestamp setting of the table.</p>
|
|
117
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/client-side-timestamps-how-it-works.html">How it works: Amazon Keyspaces client-side timestamps</a> in the <i>Amazon Keyspaces Developer
|
|
118
|
+
* Guide</i>.</p>
|
|
119
|
+
*/
|
|
120
|
+
export interface ClientSideTimestamps {
|
|
121
|
+
/**
|
|
122
|
+
* <p>Shows how to enable client-side timestamps settings for the specified table.</p>
|
|
123
|
+
*/
|
|
124
|
+
status: ClientSideTimestampsStatus | string | undefined;
|
|
125
|
+
}
|
|
82
126
|
export declare enum SortOrder {
|
|
83
127
|
ASC = "ASC",
|
|
84
128
|
DESC = "DESC"
|
|
@@ -210,9 +254,15 @@ export declare enum EncryptionType {
|
|
|
210
254
|
/**
|
|
211
255
|
* <p>Amazon Keyspaces encrypts and decrypts the table data at rest transparently and integrates with Key Management Service for storing and managing the encryption key.
|
|
212
256
|
* You can choose one of the following KMS keys (KMS keys):</p>
|
|
213
|
-
* <
|
|
214
|
-
*
|
|
215
|
-
*
|
|
257
|
+
* <ul>
|
|
258
|
+
* <li>
|
|
259
|
+
* <p>Amazon Web Services owned key - This is the default encryption type. The key is owned by Amazon Keyspaces (no additional charge). </p>
|
|
260
|
+
* </li>
|
|
261
|
+
* <li>
|
|
262
|
+
* <p>Customer managed key - This key is stored in your account and is created, owned, and managed by you. You have full control over the customer
|
|
263
|
+
* managed key (KMS charges apply).</p>
|
|
264
|
+
* </li>
|
|
265
|
+
* </ul>
|
|
216
266
|
* <p>For more information about encryption at rest in Amazon Keyspaces, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
217
267
|
* Guide</i>.</p>
|
|
218
268
|
* <p>For more information about KMS, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">KMS management service concepts</a> in the <i>Key Management Service Developer Guide</i>.</p>
|
|
@@ -220,10 +270,18 @@ export declare enum EncryptionType {
|
|
|
220
270
|
export interface EncryptionSpecification {
|
|
221
271
|
/**
|
|
222
272
|
* <p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p>
|
|
223
|
-
* <
|
|
224
|
-
*
|
|
225
|
-
*
|
|
226
|
-
*
|
|
273
|
+
* <ul>
|
|
274
|
+
* <li>
|
|
275
|
+
* <p>
|
|
276
|
+
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
277
|
+
* </li>
|
|
278
|
+
* <li>
|
|
279
|
+
* <p>
|
|
280
|
+
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
281
|
+
* This option
|
|
282
|
+
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p>
|
|
283
|
+
* </li>
|
|
284
|
+
* </ul>
|
|
227
285
|
* <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p>
|
|
228
286
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
229
287
|
* Guide</i>.</p>
|
|
@@ -246,10 +304,18 @@ export declare enum PointInTimeRecoveryStatus {
|
|
|
246
304
|
export interface PointInTimeRecovery {
|
|
247
305
|
/**
|
|
248
306
|
* <p>The options are:</p>
|
|
249
|
-
* <
|
|
250
|
-
*
|
|
251
|
-
*
|
|
252
|
-
*
|
|
307
|
+
* <ul>
|
|
308
|
+
* <li>
|
|
309
|
+
* <p>
|
|
310
|
+
* <code>status=ENABLED</code>
|
|
311
|
+
* </p>
|
|
312
|
+
* </li>
|
|
313
|
+
* <li>
|
|
314
|
+
* <p>
|
|
315
|
+
* <code>status=DISABLED</code>
|
|
316
|
+
* </p>
|
|
317
|
+
* </li>
|
|
318
|
+
* </ul>
|
|
253
319
|
*/
|
|
254
320
|
status: PointInTimeRecoveryStatus | string | undefined;
|
|
255
321
|
}
|
|
@@ -321,30 +387,61 @@ export interface CreateTableRequest {
|
|
|
321
387
|
* <p>The <code>schemaDefinition</code> consists of the
|
|
322
388
|
* following parameters.</p>
|
|
323
389
|
* <p>For each column to be created:</p>
|
|
324
|
-
* <
|
|
325
|
-
*
|
|
326
|
-
*
|
|
327
|
-
*
|
|
328
|
-
*
|
|
390
|
+
* <ul>
|
|
391
|
+
* <li>
|
|
392
|
+
* <p>
|
|
393
|
+
* <code>name</code> - The name
|
|
394
|
+
* of the column.</p>
|
|
395
|
+
* </li>
|
|
396
|
+
* <li>
|
|
397
|
+
* <p>
|
|
398
|
+
* <code>type</code> - An Amazon Keyspaces
|
|
399
|
+
* data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer
|
|
400
|
+
* Guide</i>.</p>
|
|
401
|
+
* </li>
|
|
402
|
+
* </ul>
|
|
329
403
|
* <p>The primary key of the table consists of the
|
|
330
404
|
* following columns:</p>
|
|
331
|
-
* <
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
335
|
-
*
|
|
336
|
-
*
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
*
|
|
345
|
-
*
|
|
346
|
-
*
|
|
347
|
-
*
|
|
405
|
+
* <ul>
|
|
406
|
+
* <li>
|
|
407
|
+
* <p>
|
|
408
|
+
* <code>partitionKeys</code> - The partition key can be a single column, or it can be a
|
|
409
|
+
* compound value composed of two or more columns. The partition
|
|
410
|
+
* key portion of the primary key is required and determines how
|
|
411
|
+
* Amazon Keyspaces stores your data.</p>
|
|
412
|
+
* </li>
|
|
413
|
+
* <li>
|
|
414
|
+
* <p>
|
|
415
|
+
* <code>name</code> - The name of each partition key column.</p>
|
|
416
|
+
* </li>
|
|
417
|
+
* <li>
|
|
418
|
+
* <p>
|
|
419
|
+
* <code>clusteringKeys</code> - The optional clustering column portion of your primary key
|
|
420
|
+
* determines how the data is clustered and sorted within each
|
|
421
|
+
* partition.</p>
|
|
422
|
+
* </li>
|
|
423
|
+
* <li>
|
|
424
|
+
* <p>
|
|
425
|
+
* <code>name</code> - The name of the clustering column. </p>
|
|
426
|
+
* </li>
|
|
427
|
+
* <li>
|
|
428
|
+
* <p>
|
|
429
|
+
* <code>orderBy</code> - Sets the
|
|
430
|
+
* ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p>
|
|
431
|
+
* <p>To define a column as static use <code>staticColumns</code> -
|
|
432
|
+
* Static columns store values that are shared by all rows in the same partition:</p>
|
|
433
|
+
* </li>
|
|
434
|
+
* <li>
|
|
435
|
+
* <p>
|
|
436
|
+
* <code>name</code> - The name
|
|
437
|
+
* of the column.</p>
|
|
438
|
+
* </li>
|
|
439
|
+
* <li>
|
|
440
|
+
* <p>
|
|
441
|
+
* <code>type</code> - An Amazon Keyspaces
|
|
442
|
+
* data type.</p>
|
|
443
|
+
* </li>
|
|
444
|
+
* </ul>
|
|
348
445
|
*/
|
|
349
446
|
schemaDefinition: SchemaDefinition | undefined;
|
|
350
447
|
/**
|
|
@@ -353,9 +450,17 @@ export interface CreateTableRequest {
|
|
|
353
450
|
comment?: Comment;
|
|
354
451
|
/**
|
|
355
452
|
* <p>Specifies the read/write throughput capacity mode for the table. The options are:</p>
|
|
356
|
-
* <
|
|
357
|
-
*
|
|
358
|
-
*
|
|
453
|
+
* <ul>
|
|
454
|
+
* <li>
|
|
455
|
+
* <p>
|
|
456
|
+
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
457
|
+
* </li>
|
|
458
|
+
* <li>
|
|
459
|
+
* <p>
|
|
460
|
+
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
461
|
+
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
462
|
+
* </li>
|
|
463
|
+
* </ul>
|
|
359
464
|
* <p>The default is
|
|
360
465
|
* <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
361
466
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
@@ -365,11 +470,19 @@ export interface CreateTableRequest {
|
|
|
365
470
|
/**
|
|
366
471
|
* <p>Specifies how the encryption key for encryption at rest is managed for the table.
|
|
367
472
|
* You can choose one of the following KMS key (KMS key):</p>
|
|
368
|
-
* <
|
|
369
|
-
*
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
473
|
+
* <ul>
|
|
474
|
+
* <li>
|
|
475
|
+
* <p>
|
|
476
|
+
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
477
|
+
* </li>
|
|
478
|
+
* <li>
|
|
479
|
+
* <p>
|
|
480
|
+
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
481
|
+
* This option
|
|
482
|
+
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input.</p>
|
|
483
|
+
* </li>
|
|
484
|
+
* </ul>
|
|
485
|
+
* <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p>
|
|
373
486
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
374
487
|
* Guide</i>.</p>
|
|
375
488
|
*/
|
|
@@ -377,12 +490,20 @@ export interface CreateTableRequest {
|
|
|
377
490
|
/**
|
|
378
491
|
* <p>Specifies if <code>pointInTimeRecovery</code> is enabled or disabled for the
|
|
379
492
|
* table. The options are:</p>
|
|
380
|
-
* <
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
493
|
+
* <ul>
|
|
494
|
+
* <li>
|
|
495
|
+
* <p>
|
|
496
|
+
* <code>status=ENABLED</code>
|
|
497
|
+
* </p>
|
|
498
|
+
* </li>
|
|
499
|
+
* <li>
|
|
500
|
+
* <p>
|
|
501
|
+
* <code>status=DISABLED</code>
|
|
502
|
+
* </p>
|
|
503
|
+
* </li>
|
|
504
|
+
* </ul>
|
|
384
505
|
* <p>If it's not specified, the
|
|
385
|
-
* default is <code>DISABLED</code>.</p>
|
|
506
|
+
* default is <code>status=DISABLED</code>.</p>
|
|
386
507
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
387
508
|
* Guide</i>.</p>
|
|
388
509
|
*/
|
|
@@ -390,10 +511,18 @@ export interface CreateTableRequest {
|
|
|
390
511
|
/**
|
|
391
512
|
* <p>Enables Time to Live custom settings for the
|
|
392
513
|
* table. The options are:</p>
|
|
393
|
-
* <
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
*
|
|
514
|
+
* <ul>
|
|
515
|
+
* <li>
|
|
516
|
+
* <p>
|
|
517
|
+
* <code>status:enabled</code>
|
|
518
|
+
* </p>
|
|
519
|
+
* </li>
|
|
520
|
+
* <li>
|
|
521
|
+
* <p>
|
|
522
|
+
* <code>status:disabled</code>
|
|
523
|
+
* </p>
|
|
524
|
+
* </li>
|
|
525
|
+
* </ul>
|
|
397
526
|
* <p>The default is <code>status:disabled</code>. After
|
|
398
527
|
* <code>ttl</code> is enabled, you can't disable it
|
|
399
528
|
* for the table.</p>
|
|
@@ -415,6 +544,20 @@ export interface CreateTableRequest {
|
|
|
415
544
|
* Guide</i>.</p>
|
|
416
545
|
*/
|
|
417
546
|
tags?: Tag[];
|
|
547
|
+
/**
|
|
548
|
+
* <p>
|
|
549
|
+
* Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
|
|
550
|
+
* client-side timestamps with the following option:</p>
|
|
551
|
+
* <ul>
|
|
552
|
+
* <li>
|
|
553
|
+
* <p>
|
|
554
|
+
* <code>status: "enabled"</code>
|
|
555
|
+
* </p>
|
|
556
|
+
* </li>
|
|
557
|
+
* </ul>
|
|
558
|
+
* <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
559
|
+
*/
|
|
560
|
+
clientSideTimestamps?: ClientSideTimestamps;
|
|
418
561
|
}
|
|
419
562
|
export interface CreateTableResponse {
|
|
420
563
|
/**
|
|
@@ -532,10 +675,18 @@ export interface GetTableResponse {
|
|
|
532
675
|
schemaDefinition?: SchemaDefinition;
|
|
533
676
|
/**
|
|
534
677
|
* <p>The read/write throughput capacity mode for a table. The options are:</p>
|
|
535
|
-
* <
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
678
|
+
* <ul>
|
|
679
|
+
* <li>
|
|
680
|
+
* <p>
|
|
681
|
+
* <code>throughputMode:PAY_PER_REQUEST</code>
|
|
682
|
+
* </p>
|
|
683
|
+
* </li>
|
|
684
|
+
* <li>
|
|
685
|
+
* <p>
|
|
686
|
+
* <code>throughputMode:PROVISIONED</code>
|
|
687
|
+
* </p>
|
|
688
|
+
* </li>
|
|
689
|
+
* </ul>
|
|
539
690
|
*/
|
|
540
691
|
capacitySpecification?: CapacitySpecificationSummary;
|
|
541
692
|
/**
|
|
@@ -551,13 +702,18 @@ export interface GetTableResponse {
|
|
|
551
702
|
*/
|
|
552
703
|
ttl?: TimeToLive;
|
|
553
704
|
/**
|
|
554
|
-
* <p>The default Time to Live settings of the specified table.</p>
|
|
705
|
+
* <p>The default Time to Live settings in seconds of the specified table.</p>
|
|
555
706
|
*/
|
|
556
707
|
defaultTimeToLive?: number;
|
|
557
708
|
/**
|
|
558
709
|
* <p>The the description of the specified table.</p>
|
|
559
710
|
*/
|
|
560
711
|
comment?: Comment;
|
|
712
|
+
/**
|
|
713
|
+
* <p>
|
|
714
|
+
* The client-side timestamps setting of the table.</p>
|
|
715
|
+
*/
|
|
716
|
+
clientSideTimestamps?: ClientSideTimestamps;
|
|
561
717
|
}
|
|
562
718
|
export interface ListKeyspacesRequest {
|
|
563
719
|
/**
|
|
@@ -686,10 +842,18 @@ export interface RestoreTableRequest {
|
|
|
686
842
|
restoreTimestamp?: Date;
|
|
687
843
|
/**
|
|
688
844
|
* <p>Specifies the read/write throughput capacity mode for the target table. The options are:</p>
|
|
689
|
-
* <
|
|
690
|
-
*
|
|
691
|
-
*
|
|
845
|
+
* <ul>
|
|
846
|
+
* <li>
|
|
847
|
+
* <p>
|
|
848
|
+
* <code>throughputMode:PAY_PER_REQUEST</code>
|
|
849
|
+
* </p>
|
|
850
|
+
* </li>
|
|
851
|
+
* <li>
|
|
852
|
+
* <p>
|
|
853
|
+
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
692
854
|
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
855
|
+
* </li>
|
|
856
|
+
* </ul>
|
|
693
857
|
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
694
858
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
695
859
|
* Guide</i>.</p>
|
|
@@ -697,10 +861,18 @@ export interface RestoreTableRequest {
|
|
|
697
861
|
capacitySpecificationOverride?: CapacitySpecification;
|
|
698
862
|
/**
|
|
699
863
|
* <p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p>
|
|
700
|
-
* <
|
|
701
|
-
*
|
|
702
|
-
*
|
|
703
|
-
*
|
|
864
|
+
* <ul>
|
|
865
|
+
* <li>
|
|
866
|
+
* <p>
|
|
867
|
+
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
868
|
+
* </li>
|
|
869
|
+
* <li>
|
|
870
|
+
* <p>
|
|
871
|
+
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
872
|
+
* This option
|
|
873
|
+
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p>
|
|
874
|
+
* </li>
|
|
875
|
+
* </ul>
|
|
704
876
|
* <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p>
|
|
705
877
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
706
878
|
* Guide</i>.</p>
|
|
@@ -709,11 +881,19 @@ export interface RestoreTableRequest {
|
|
|
709
881
|
/**
|
|
710
882
|
* <p>Specifies the <code>pointInTimeRecovery</code> settings for the target
|
|
711
883
|
* table. The options are:</p>
|
|
712
|
-
* <
|
|
713
|
-
*
|
|
714
|
-
*
|
|
715
|
-
*
|
|
716
|
-
*
|
|
884
|
+
* <ul>
|
|
885
|
+
* <li>
|
|
886
|
+
* <p>
|
|
887
|
+
* <code>status=ENABLED</code>
|
|
888
|
+
* </p>
|
|
889
|
+
* </li>
|
|
890
|
+
* <li>
|
|
891
|
+
* <p>
|
|
892
|
+
* <code>status=DISABLED</code>
|
|
893
|
+
* </p>
|
|
894
|
+
* </li>
|
|
895
|
+
* </ul>
|
|
896
|
+
* <p>If it's not specified, the default is <code>status=DISABLED</code>.</p>
|
|
717
897
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
718
898
|
* Guide</i>.</p>
|
|
719
899
|
*/
|
|
@@ -767,18 +947,34 @@ export interface UpdateTableRequest {
|
|
|
767
947
|
tableName: string | undefined;
|
|
768
948
|
/**
|
|
769
949
|
* <p>For each column to be added to the specified table:</p>
|
|
770
|
-
* <
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
*
|
|
774
|
-
*
|
|
950
|
+
* <ul>
|
|
951
|
+
* <li>
|
|
952
|
+
* <p>
|
|
953
|
+
* <code>name</code> - The name
|
|
954
|
+
* of the column.</p>
|
|
955
|
+
* </li>
|
|
956
|
+
* <li>
|
|
957
|
+
* <p>
|
|
958
|
+
* <code>type</code> - An Amazon Keyspaces
|
|
959
|
+
* data type. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/cql.elements.html#cql.data-types">Data types</a> in the <i>Amazon Keyspaces Developer
|
|
960
|
+
* Guide</i>.</p>
|
|
961
|
+
* </li>
|
|
962
|
+
* </ul>
|
|
775
963
|
*/
|
|
776
964
|
addColumns?: ColumnDefinition[];
|
|
777
965
|
/**
|
|
778
966
|
* <p>Modifies the read/write throughput capacity mode for the table. The options are:</p>
|
|
779
|
-
* <
|
|
780
|
-
*
|
|
781
|
-
* <
|
|
967
|
+
* <ul>
|
|
968
|
+
* <li>
|
|
969
|
+
* <p>
|
|
970
|
+
* <code>throughputMode:PAY_PER_REQUEST</code> and </p>
|
|
971
|
+
* </li>
|
|
972
|
+
* <li>
|
|
973
|
+
* <p>
|
|
974
|
+
* <code>throughputMode:PROVISIONED</code> - Provisioned capacity mode requires
|
|
975
|
+
* <code>readCapacityUnits</code> and <code>writeCapacityUnits</code> as input.</p>
|
|
976
|
+
* </li>
|
|
977
|
+
* </ul>
|
|
782
978
|
* <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
|
|
783
979
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/ReadWriteCapacityMode.html">Read/write capacity modes</a> in the <i>Amazon Keyspaces Developer
|
|
784
980
|
* Guide</i>.</p>
|
|
@@ -786,10 +982,18 @@ export interface UpdateTableRequest {
|
|
|
786
982
|
capacitySpecification?: CapacitySpecification;
|
|
787
983
|
/**
|
|
788
984
|
* <p>Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):</p>
|
|
789
|
-
* <
|
|
790
|
-
*
|
|
791
|
-
*
|
|
792
|
-
*
|
|
985
|
+
* <ul>
|
|
986
|
+
* <li>
|
|
987
|
+
* <p>
|
|
988
|
+
* <code>type:AWS_OWNED_KMS_KEY</code> - This key is owned by Amazon Keyspaces. </p>
|
|
989
|
+
* </li>
|
|
990
|
+
* <li>
|
|
991
|
+
* <p>
|
|
992
|
+
* <code>type:CUSTOMER_MANAGED_KMS_KEY</code> - This key is stored in your account and is created, owned, and managed by you.
|
|
993
|
+
* This option
|
|
994
|
+
* requires the <code>kms_key_identifier</code> of the KMS key in Amazon Resource Name (ARN) format as input. </p>
|
|
995
|
+
* </li>
|
|
996
|
+
* </ul>
|
|
793
997
|
* <p>The default is <code>AWS_OWNED_KMS_KEY</code>.</p>
|
|
794
998
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/EncryptionAtRest.html">Encryption at rest</a> in the <i>Amazon Keyspaces Developer
|
|
795
999
|
* Guide</i>.</p>
|
|
@@ -797,21 +1001,37 @@ export interface UpdateTableRequest {
|
|
|
797
1001
|
encryptionSpecification?: EncryptionSpecification;
|
|
798
1002
|
/**
|
|
799
1003
|
* <p>Modifies the <code>pointInTimeRecovery</code> settings of the table. The options are:</p>
|
|
800
|
-
* <
|
|
801
|
-
*
|
|
802
|
-
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
1004
|
+
* <ul>
|
|
1005
|
+
* <li>
|
|
1006
|
+
* <p>
|
|
1007
|
+
* <code>status=ENABLED</code>
|
|
1008
|
+
* </p>
|
|
1009
|
+
* </li>
|
|
1010
|
+
* <li>
|
|
1011
|
+
* <p>
|
|
1012
|
+
* <code>status=DISABLED</code>
|
|
1013
|
+
* </p>
|
|
1014
|
+
* </li>
|
|
1015
|
+
* </ul>
|
|
1016
|
+
* <p>If it's not specified, the default is <code>status=DISABLED</code>.</p>
|
|
805
1017
|
* <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/PointInTimeRecovery.html">Point-in-time recovery</a> in the <i>Amazon Keyspaces Developer
|
|
806
1018
|
* Guide</i>.</p>
|
|
807
1019
|
*/
|
|
808
1020
|
pointInTimeRecovery?: PointInTimeRecovery;
|
|
809
1021
|
/**
|
|
810
1022
|
* <p>Modifies Time to Live custom settings for the table. The options are:</p>
|
|
811
|
-
* <
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
*
|
|
1023
|
+
* <ul>
|
|
1024
|
+
* <li>
|
|
1025
|
+
* <p>
|
|
1026
|
+
* <code>status:enabled</code>
|
|
1027
|
+
* </p>
|
|
1028
|
+
* </li>
|
|
1029
|
+
* <li>
|
|
1030
|
+
* <p>
|
|
1031
|
+
* <code>status:disabled</code>
|
|
1032
|
+
* </p>
|
|
1033
|
+
* </li>
|
|
1034
|
+
* </ul>
|
|
815
1035
|
* <p>The default is <code>status:disabled</code>. After
|
|
816
1036
|
* <code>ttl</code> is enabled, you can't disable it
|
|
817
1037
|
* for the table.</p>
|
|
@@ -825,6 +1045,19 @@ export interface UpdateTableRequest {
|
|
|
825
1045
|
* Guide</i>.</p>
|
|
826
1046
|
*/
|
|
827
1047
|
defaultTimeToLive?: number;
|
|
1048
|
+
/**
|
|
1049
|
+
* <p>Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
|
|
1050
|
+
* client-side timestamps with the following option:</p>
|
|
1051
|
+
* <ul>
|
|
1052
|
+
* <li>
|
|
1053
|
+
* <p>
|
|
1054
|
+
* <code>status: "enabled"</code>
|
|
1055
|
+
* </p>
|
|
1056
|
+
* </li>
|
|
1057
|
+
* </ul>
|
|
1058
|
+
* <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
|
|
1059
|
+
*/
|
|
1060
|
+
clientSideTimestamps?: ClientSideTimestamps;
|
|
828
1061
|
}
|
|
829
1062
|
export interface UpdateTableResponse {
|
|
830
1063
|
/**
|
|
@@ -840,6 +1073,10 @@ export declare const CapacitySpecificationFilterSensitiveLog: (obj: CapacitySpec
|
|
|
840
1073
|
* @internal
|
|
841
1074
|
*/
|
|
842
1075
|
export declare const CapacitySpecificationSummaryFilterSensitiveLog: (obj: CapacitySpecificationSummary) => any;
|
|
1076
|
+
/**
|
|
1077
|
+
* @internal
|
|
1078
|
+
*/
|
|
1079
|
+
export declare const ClientSideTimestampsFilterSensitiveLog: (obj: ClientSideTimestamps) => any;
|
|
843
1080
|
/**
|
|
844
1081
|
* @internal
|
|
845
1082
|
*/
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region?: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|