@aws-sdk/client-keyspaces 3.529.1 → 3.535.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.
Files changed (41) hide show
  1. package/dist-types/Keyspaces.d.ts +2 -1
  2. package/dist-types/KeyspacesClient.d.ts +1 -1
  3. package/dist-types/commands/CreateKeyspaceCommand.d.ts +2 -1
  4. package/dist-types/commands/CreateTableCommand.d.ts +2 -1
  5. package/dist-types/commands/DeleteKeyspaceCommand.d.ts +2 -1
  6. package/dist-types/commands/DeleteTableCommand.d.ts +2 -1
  7. package/dist-types/commands/GetKeyspaceCommand.d.ts +2 -1
  8. package/dist-types/commands/GetTableAutoScalingSettingsCommand.d.ts +2 -1
  9. package/dist-types/commands/GetTableCommand.d.ts +2 -1
  10. package/dist-types/commands/ListKeyspacesCommand.d.ts +2 -1
  11. package/dist-types/commands/ListTablesCommand.d.ts +2 -1
  12. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
  13. package/dist-types/commands/RestoreTableCommand.d.ts +2 -1
  14. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  15. package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
  16. package/dist-types/commands/UpdateTableCommand.d.ts +2 -1
  17. package/dist-types/models/models_0.d.ts +177 -177
  18. package/dist-types/runtimeConfig.browser.d.ts +2 -2
  19. package/dist-types/runtimeConfig.d.ts +2 -2
  20. package/dist-types/runtimeConfig.native.d.ts +2 -2
  21. package/dist-types/runtimeConfig.shared.d.ts +2 -2
  22. package/dist-types/ts3.4/Keyspaces.d.ts +1 -0
  23. package/dist-types/ts3.4/commands/CreateKeyspaceCommand.d.ts +9 -0
  24. package/dist-types/ts3.4/commands/CreateTableCommand.d.ts +9 -0
  25. package/dist-types/ts3.4/commands/DeleteKeyspaceCommand.d.ts +9 -0
  26. package/dist-types/ts3.4/commands/DeleteTableCommand.d.ts +9 -0
  27. package/dist-types/ts3.4/commands/GetKeyspaceCommand.d.ts +9 -0
  28. package/dist-types/ts3.4/commands/GetTableAutoScalingSettingsCommand.d.ts +9 -0
  29. package/dist-types/ts3.4/commands/GetTableCommand.d.ts +9 -0
  30. package/dist-types/ts3.4/commands/ListKeyspacesCommand.d.ts +9 -0
  31. package/dist-types/ts3.4/commands/ListTablesCommand.d.ts +9 -0
  32. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
  33. package/dist-types/ts3.4/commands/RestoreTableCommand.d.ts +9 -0
  34. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
  35. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
  36. package/dist-types/ts3.4/commands/UpdateTableCommand.d.ts +9 -0
  37. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
  38. package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
  39. package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
  40. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  41. package/package.json +40 -40
@@ -1,8 +1,8 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { KeyspacesServiceException as __BaseException } from "./KeyspacesServiceException";
3
3
  /**
4
- * @public
5
4
  * <p>You don't have sufficient access permissions to perform this action. </p>
5
+ * @public
6
6
  */
7
7
  export declare class AccessDeniedException extends __BaseException {
8
8
  readonly name: "AccessDeniedException";
@@ -13,56 +13,55 @@ export declare class AccessDeniedException extends __BaseException {
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
15
  /**
16
- * @public
17
16
  * <p>The auto scaling policy that scales a table based on the ratio of consumed to provisioned capacity.</p>
17
+ * @public
18
18
  */
19
19
  export interface TargetTrackingScalingPolicyConfiguration {
20
20
  /**
21
- * @public
22
21
  * <p>Specifies if <code>scale-in</code> is enabled.</p>
23
22
  * <p>When auto scaling automatically decreases capacity for a table,
24
23
  * the table <i>scales in</i>. When scaling policies are set, they can't
25
24
  * scale in the table lower than its minimum capacity.</p>
25
+ * @public
26
26
  */
27
27
  disableScaleIn?: boolean;
28
28
  /**
29
- * @public
30
29
  * <p>Specifies a <code>scale-in</code> cool down period.</p>
31
30
  * <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
31
+ * @public
32
32
  */
33
33
  scaleInCooldown?: number;
34
34
  /**
35
- * @public
36
35
  * <p>Specifies a scale out cool down period.</p>
37
36
  * <p>A cooldown period in seconds between scaling activities that lets the table stabilize before another scaling activity starts. </p>
37
+ * @public
38
38
  */
39
39
  scaleOutCooldown?: number;
40
40
  /**
41
- * @public
42
41
  * <p>Specifies the target value for the target tracking auto scaling policy.</p>
43
42
  * <p>Amazon Keyspaces auto scaling scales up capacity automatically when traffic exceeds this target utilization
44
43
  * rate, and then back down when it falls below the target. This ensures that the ratio of
45
44
  * consumed capacity to provisioned capacity stays at or near this value. You
46
45
  * define <code>targetValue</code> as a percentage. A <code>double</code> between 20 and 90.</p>
46
+ * @public
47
47
  */
48
48
  targetValue: number | undefined;
49
49
  }
50
50
  /**
51
- * @public
52
51
  * <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling
53
52
  * ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You
54
53
  * define the target value as a percentage between 20 and 90.</p>
54
+ * @public
55
55
  */
56
56
  export interface AutoScalingPolicy {
57
57
  /**
58
- * @public
59
58
  * <p>Auto scaling scales up capacity automatically when traffic exceeds this target utilization rate, and then back down
60
59
  * when it falls below the target. A <code>double</code> between 20 and 90.</p>
60
+ * @public
61
61
  */
62
62
  targetTrackingScalingPolicyConfiguration?: TargetTrackingScalingPolicyConfiguration;
63
63
  }
64
64
  /**
65
- * @public
66
65
  * <p>The optional auto scaling settings for a table with provisioned throughput capacity.</p>
67
66
  * <p>To turn on auto scaling for a table in <code>throughputMode:PROVISIONED</code>,
68
67
  * you must specify the following parameters. </p>
@@ -122,46 +121,47 @@ export interface AutoScalingPolicy {
122
121
  * </ul>
123
122
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
124
123
  * Guide</i>.</p>
124
+ * @public
125
125
  */
126
126
  export interface AutoScalingSettings {
127
127
  /**
128
- * @public
129
128
  * <p>This optional parameter enables auto scaling for the table if set to <code>false</code>.</p>
129
+ * @public
130
130
  */
131
131
  autoScalingDisabled?: boolean;
132
132
  /**
133
- * @public
134
133
  * <p>The minimum level of throughput the table should always be ready to support. The value must be between 1
135
134
  * and the max throughput per second quota for your account (40,000 by default).</p>
135
+ * @public
136
136
  */
137
137
  minimumUnits?: number;
138
138
  /**
139
- * @public
140
139
  * <p>Manage costs by specifying the maximum amount of throughput to provision. The value must be between 1
141
140
  * and the max throughput per second quota for your account (40,000 by default).</p>
141
+ * @public
142
142
  */
143
143
  maximumUnits?: number;
144
144
  /**
145
- * @public
146
145
  * <p>Amazon Keyspaces supports the <code>target tracking</code> auto scaling policy. With this policy, Amazon Keyspaces auto scaling
147
146
  * ensures that the table's ratio of consumed to provisioned capacity stays at or near the target value that you specify. You
148
147
  * define the target value as a percentage between 20 and 90.</p>
148
+ * @public
149
149
  */
150
150
  scalingPolicy?: AutoScalingPolicy;
151
151
  }
152
152
  /**
153
- * @public
154
153
  * <p>The optional auto scaling capacity settings for a table in provisioned capacity mode.</p>
154
+ * @public
155
155
  */
156
156
  export interface AutoScalingSpecification {
157
157
  /**
158
- * @public
159
158
  * <p>The auto scaling settings for the table's write capacity.</p>
159
+ * @public
160
160
  */
161
161
  writeCapacityAutoScaling?: AutoScalingSettings;
162
162
  /**
163
- * @public
164
163
  * <p>The auto scaling settings for the table's read capacity.</p>
164
+ * @public
165
165
  */
166
166
  readCapacityAutoScaling?: AutoScalingSettings;
167
167
  }
@@ -178,7 +178,6 @@ export declare const ThroughputMode: {
178
178
  */
179
179
  export type ThroughputMode = (typeof ThroughputMode)[keyof typeof ThroughputMode];
180
180
  /**
181
- * @public
182
181
  * <p>Amazon Keyspaces has two read/write capacity modes for processing reads and writes on your tables: </p>
183
182
  * <ul>
184
183
  * <li>
@@ -192,10 +191,10 @@ export type ThroughputMode = (typeof ThroughputMode)[keyof typeof ThroughputMode
192
191
  * write throughput and how table throughput capacity is managed.</p>
193
192
  * <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
194
193
  * Guide</i>.</p>
194
+ * @public
195
195
  */
196
196
  export interface CapacitySpecification {
197
197
  /**
198
- * @public
199
198
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
200
199
  * <ul>
201
200
  * <li>
@@ -211,23 +210,23 @@ export interface CapacitySpecification {
211
210
  * <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
212
211
  * <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
213
212
  * Guide</i>.</p>
213
+ * @public
214
214
  */
215
215
  throughputMode: ThroughputMode | undefined;
216
216
  /**
217
- * @public
218
217
  * <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code>
219
218
  * <code>(RCUs)</code>.</p>
219
+ * @public
220
220
  */
221
221
  readCapacityUnits?: number;
222
222
  /**
223
- * @public
224
223
  * <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code>
225
224
  * <code>(WCUs)</code>.</p>
225
+ * @public
226
226
  */
227
227
  writeCapacityUnits?: number;
228
228
  }
229
229
  /**
230
- * @public
231
230
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
232
231
  * <ul>
233
232
  * <li>
@@ -241,10 +240,10 @@ export interface CapacitySpecification {
241
240
  * </ul>
242
241
  * <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
243
242
  * Guide</i>.</p>
243
+ * @public
244
244
  */
245
245
  export interface CapacitySpecificationSummary {
246
246
  /**
247
- * @public
248
247
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
249
248
  * <ul>
250
249
  * <li>
@@ -260,23 +259,24 @@ export interface CapacitySpecificationSummary {
260
259
  * <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
261
260
  * <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
262
261
  * Guide</i>.</p>
262
+ * @public
263
263
  */
264
264
  throughputMode: ThroughputMode | undefined;
265
265
  /**
266
- * @public
267
266
  * <p>The throughput capacity specified for <code>read</code> operations defined in <code>read capacity units</code>
268
267
  * <code>(RCUs)</code>.</p>
268
+ * @public
269
269
  */
270
270
  readCapacityUnits?: number;
271
271
  /**
272
- * @public
273
272
  * <p>The throughput capacity specified for <code>write</code> operations defined in <code>write capacity units</code>
274
273
  * <code>(WCUs)</code>.</p>
274
+ * @public
275
275
  */
276
276
  writeCapacityUnits?: number;
277
277
  /**
278
- * @public
279
278
  * <p>The timestamp of the last operation that changed the provisioned throughput capacity of a table.</p>
279
+ * @public
280
280
  */
281
281
  lastUpdateToPayPerRequestTimestamp?: Date;
282
282
  }
@@ -292,15 +292,15 @@ export declare const ClientSideTimestampsStatus: {
292
292
  */
293
293
  export type ClientSideTimestampsStatus = (typeof ClientSideTimestampsStatus)[keyof typeof ClientSideTimestampsStatus];
294
294
  /**
295
- * @public
296
295
  * <p>The client-side timestamp setting of the table.</p>
297
296
  * <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
298
297
  * Guide</i>.</p>
298
+ * @public
299
299
  */
300
300
  export interface ClientSideTimestamps {
301
301
  /**
302
- * @public
303
302
  * <p>Shows how to enable client-side timestamps settings for the specified table.</p>
303
+ * @public
304
304
  */
305
305
  status: ClientSideTimestampsStatus | undefined;
306
306
  }
@@ -317,54 +317,54 @@ export declare const SortOrder: {
317
317
  */
318
318
  export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
319
319
  /**
320
- * @public
321
320
  * <p>The optional clustering column portion of your primary key determines how the data is clustered and sorted within each partition.</p>
321
+ * @public
322
322
  */
323
323
  export interface ClusteringKey {
324
324
  /**
325
- * @public
326
325
  * <p>The name(s) of the clustering column(s).</p>
326
+ * @public
327
327
  */
328
328
  name: string | undefined;
329
329
  /**
330
- * @public
331
330
  * <p>Sets the ascendant (<code>ASC</code>) or descendant (<code>DESC</code>) order modifier.</p>
331
+ * @public
332
332
  */
333
333
  orderBy: SortOrder | undefined;
334
334
  }
335
335
  /**
336
- * @public
337
336
  * <p>The names and data types of regular columns.</p>
337
+ * @public
338
338
  */
339
339
  export interface ColumnDefinition {
340
340
  /**
341
- * @public
342
341
  * <p>The name of the column.</p>
342
+ * @public
343
343
  */
344
344
  name: string | undefined;
345
345
  /**
346
- * @public
347
346
  * <p>The data type of the column. For a list of available data types, 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
348
347
  * Guide</i>.</p>
348
+ * @public
349
349
  */
350
350
  type: string | undefined;
351
351
  }
352
352
  /**
353
- * @public
354
353
  * <p>An optional comment that describes the table.</p>
354
+ * @public
355
355
  */
356
356
  export interface Comment {
357
357
  /**
358
- * @public
359
358
  * <p>An optional description of the table.</p>
359
+ * @public
360
360
  */
361
361
  message: string | undefined;
362
362
  }
363
363
  /**
364
- * @public
365
364
  * <p>Amazon Keyspaces couldn't complete the requested action. This error may occur if you try to
366
365
  * perform an action and the same or a different action is already
367
366
  * in progress, or if you try to create a resource that already exists. </p>
367
+ * @public
368
368
  */
369
369
  export declare class ConflictException extends __BaseException {
370
370
  readonly name: "ConflictException";
@@ -387,7 +387,6 @@ export declare const Rs: {
387
387
  */
388
388
  export type Rs = (typeof Rs)[keyof typeof Rs];
389
389
  /**
390
- * @public
391
390
  * <p>
392
391
  * The replication specification of the keyspace includes:</p>
393
392
  * <ul>
@@ -401,43 +400,44 @@ export type Rs = (typeof Rs)[keyof typeof Rs];
401
400
  * <code>MULTI_REGION</code>.</p>
402
401
  * </li>
403
402
  * </ul>
403
+ * @public
404
404
  */
405
405
  export interface ReplicationSpecification {
406
406
  /**
407
- * @public
408
407
  * <p>
409
408
  * The <code>replicationStrategy</code> of a keyspace, the required value is <code>SINGLE_REGION</code> or
410
409
  * <code>MULTI_REGION</code>.
411
410
  * </p>
411
+ * @public
412
412
  */
413
413
  replicationStrategy: Rs | undefined;
414
414
  /**
415
- * @public
416
415
  * <p>
417
416
  * The <code>regionList</code> can contain up to six Amazon Web Services Regions where the keyspace is replicated in.
418
417
  * </p>
418
+ * @public
419
419
  */
420
420
  regionList?: string[];
421
421
  }
422
422
  /**
423
- * @public
424
423
  * <p>Describes a tag. A tag is a key-value pair. You can add up to 50 tags to a single Amazon Keyspaces resource.</p>
425
424
  * <p>Amazon Web Services-assigned tag names and values are automatically assigned the <code>aws:</code> prefix, which the user cannot assign.
426
425
  * Amazon Web Services-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the
427
426
  * prefix <code>user:</code> in the Cost Allocation Report. You cannot backdate the application of a tag.</p>
428
427
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
429
428
  * Guide</i>.</p>
429
+ * @public
430
430
  */
431
431
  export interface Tag {
432
432
  /**
433
- * @public
434
433
  * <p>The key of the tag. Tag keys are case sensitive. Each Amazon Keyspaces resource can only have up to one tag with the same key. If you try to add an
435
434
  * existing tag (same key), the existing tag value will be updated to the new value.</p>
435
+ * @public
436
436
  */
437
437
  key: string | undefined;
438
438
  /**
439
- * @public
440
439
  * <p>The value of the tag. Tag values are case-sensitive and can be null.</p>
440
+ * @public
441
441
  */
442
442
  value: string | undefined;
443
443
  }
@@ -446,19 +446,18 @@ export interface Tag {
446
446
  */
447
447
  export interface CreateKeyspaceRequest {
448
448
  /**
449
- * @public
450
449
  * <p>The name of the keyspace to be created.</p>
450
+ * @public
451
451
  */
452
452
  keyspaceName: string | undefined;
453
453
  /**
454
- * @public
455
454
  * <p>A list of key-value pair tags to be attached to the keyspace.</p>
456
455
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
457
456
  * Guide</i>.</p>
457
+ * @public
458
458
  */
459
459
  tags?: Tag[];
460
460
  /**
461
- * @public
462
461
  * <p>
463
462
  * The replication specification of the keyspace includes:</p>
464
463
  * <ul>
@@ -475,6 +474,7 @@ export interface CreateKeyspaceRequest {
475
474
  * Region is six.</p>
476
475
  * </li>
477
476
  * </ul>
477
+ * @public
478
478
  */
479
479
  replicationSpecification?: ReplicationSpecification;
480
480
  }
@@ -483,14 +483,14 @@ export interface CreateKeyspaceRequest {
483
483
  */
484
484
  export interface CreateKeyspaceResponse {
485
485
  /**
486
- * @public
487
486
  * <p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>
487
+ * @public
488
488
  */
489
489
  resourceArn: string | undefined;
490
490
  }
491
491
  /**
492
- * @public
493
492
  * <p>Amazon Keyspaces was unable to fully process this request because of an internal server error.</p>
493
+ * @public
494
494
  */
495
495
  export declare class InternalServerException extends __BaseException {
496
496
  readonly name: "InternalServerException";
@@ -501,9 +501,9 @@ export declare class InternalServerException extends __BaseException {
501
501
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
502
502
  }
503
503
  /**
504
- * @public
505
504
  * <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
506
505
  * Guide</i>.</p>
506
+ * @public
507
507
  */
508
508
  export declare class ServiceQuotaExceededException extends __BaseException {
509
509
  readonly name: "ServiceQuotaExceededException";
@@ -514,8 +514,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
514
514
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
515
515
  }
516
516
  /**
517
- * @public
518
517
  * <p>The operation failed due to an invalid or malformed request.</p>
518
+ * @public
519
519
  */
520
520
  export declare class ValidationException extends __BaseException {
521
521
  readonly name: "ValidationException";
@@ -538,7 +538,6 @@ export declare const EncryptionType: {
538
538
  */
539
539
  export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
540
540
  /**
541
- * @public
542
541
  * <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.
543
542
  * You can choose one of the following KMS keys (KMS keys):</p>
544
543
  * <ul>
@@ -553,10 +552,10 @@ export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType
553
552
  * <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
554
553
  * Guide</i>.</p>
555
554
  * <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>
555
+ * @public
556
556
  */
557
557
  export interface EncryptionSpecification {
558
558
  /**
559
- * @public
560
559
  * <p>The encryption option specified for the table. You can choose one of the following KMS keys (KMS keys):</p>
561
560
  * <ul>
562
561
  * <li>
@@ -573,11 +572,12 @@ export interface EncryptionSpecification {
573
572
  * <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>. </p>
574
573
  * <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
575
574
  * Guide</i>.</p>
575
+ * @public
576
576
  */
577
577
  type: EncryptionType | undefined;
578
578
  /**
579
- * @public
580
579
  * <p>The Amazon Resource Name (ARN) of the customer managed KMS key, for example <code>kms_key_identifier:ARN</code>.</p>
580
+ * @public
581
581
  */
582
582
  kmsKeyIdentifier?: string;
583
583
  }
@@ -594,14 +594,13 @@ export declare const PointInTimeRecoveryStatus: {
594
594
  */
595
595
  export type PointInTimeRecoveryStatus = (typeof PointInTimeRecoveryStatus)[keyof typeof PointInTimeRecoveryStatus];
596
596
  /**
597
- * @public
598
597
  * <p>Point-in-time recovery (PITR) helps protect your Amazon Keyspaces tables from accidental write or delete operations by providing you continuous backups of your table data.</p>
599
598
  * <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
600
599
  * Guide</i>.</p>
600
+ * @public
601
601
  */
602
602
  export interface PointInTimeRecovery {
603
603
  /**
604
- * @public
605
604
  * <p>The options are:</p>
606
605
  * <ul>
607
606
  * <li>
@@ -615,11 +614,11 @@ export interface PointInTimeRecovery {
615
614
  * </p>
616
615
  * </li>
617
616
  * </ul>
617
+ * @public
618
618
  */
619
619
  status: PointInTimeRecoveryStatus | undefined;
620
620
  }
621
621
  /**
622
- * @public
623
622
  * <p>The Amazon Web Services Region specific settings of a multi-Region table.</p>
624
623
  * <p>For a multi-Region table, you can configure the table's read capacity differently per Amazon Web Services Region. You can do this by configuring the following parameters.</p>
625
624
  * <ul>
@@ -636,72 +635,73 @@ export interface PointInTimeRecovery {
636
635
  * <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional)</p>
637
636
  * </li>
638
637
  * </ul>
638
+ * @public
639
639
  */
640
640
  export interface ReplicaSpecification {
641
641
  /**
642
- * @public
643
642
  * <p>The Amazon Web Services Region.</p>
643
+ * @public
644
644
  */
645
645
  region: string | undefined;
646
646
  /**
647
- * @public
648
647
  * <p>The provisioned read capacity units for the multi-Region table in the specified Amazon Web Services Region.</p>
648
+ * @public
649
649
  */
650
650
  readCapacityUnits?: number;
651
651
  /**
652
- * @public
653
652
  * <p>The read capacity auto scaling settings for the multi-Region
654
653
  * table in the specified Amazon Web Services Region.</p>
654
+ * @public
655
655
  */
656
656
  readCapacityAutoScaling?: AutoScalingSettings;
657
657
  }
658
658
  /**
659
- * @public
660
659
  * <p>The partition key portion of the primary key is required
661
660
  * and determines how Amazon Keyspaces stores the data.
662
661
  * The partition key can be a single column, or it can be a compound value composed of two or more columns.</p>
662
+ * @public
663
663
  */
664
664
  export interface PartitionKey {
665
665
  /**
666
- * @public
667
666
  * <p>The name(s) of the partition key column(s).</p>
667
+ * @public
668
668
  */
669
669
  name: string | undefined;
670
670
  }
671
671
  /**
672
- * @public
673
672
  * <p>The static columns of the table. Static columns store values that are shared by all rows in the same partition.</p>
673
+ * @public
674
674
  */
675
675
  export interface StaticColumn {
676
676
  /**
677
- * @public
678
677
  * <p>The name of the static column.</p>
678
+ * @public
679
679
  */
680
680
  name: string | undefined;
681
681
  }
682
682
  /**
683
- * @public
684
683
  * <p>Describes the schema of the table.</p>
684
+ * @public
685
685
  */
686
686
  export interface SchemaDefinition {
687
687
  /**
688
- * @public
689
688
  * <p>The regular columns of the table.</p>
689
+ * @public
690
690
  */
691
691
  allColumns: ColumnDefinition[] | undefined;
692
692
  /**
693
- * @public
694
693
  * <p>The columns that are part of the partition key of the table .</p>
694
+ * @public
695
695
  */
696
696
  partitionKeys: PartitionKey[] | undefined;
697
697
  /**
698
- * @public
699
698
  * <p>The columns that are part of the clustering key of the table.</p>
699
+ * @public
700
700
  */
701
701
  clusteringKeys?: ClusteringKey[];
702
702
  /**
703
- * @public
704
703
  * <p>The columns that have been defined as <code>STATIC</code>. Static columns store values that are shared by all rows in the same partition.</p>
704
+ * @public
705
705
  */
706
706
  staticColumns?: StaticColumn[];
707
707
  }
@@ -717,15 +717,15 @@ export declare const TimeToLiveStatus: {
717
717
  */
718
718
  export type TimeToLiveStatus = (typeof TimeToLiveStatus)[keyof typeof TimeToLiveStatus];
719
719
  /**
720
- * @public
721
720
  * <p>Enable custom Time to Live (TTL) settings for rows and columns without setting a TTL default for the specified table.</p>
722
721
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_enabling">Enabling TTL on tables</a> in the <i>Amazon Keyspaces Developer
723
722
  * Guide</i>.</p>
723
+ * @public
724
724
  */
725
725
  export interface TimeToLive {
726
726
  /**
727
- * @public
728
727
  * <p>Shows how to enable custom Time to Live (TTL) settings for the specified table.</p>
728
+ * @public
729
729
  */
730
730
  status: TimeToLiveStatus | undefined;
731
731
  }
@@ -734,17 +734,16 @@ export interface TimeToLive {
734
734
  */
735
735
  export interface CreateTableRequest {
736
736
  /**
737
- * @public
738
737
  * <p>The name of the keyspace that the table is going to be created in.</p>
738
+ * @public
739
739
  */
740
740
  keyspaceName: string | undefined;
741
741
  /**
742
- * @public
743
742
  * <p>The name of the table.</p>
743
+ * @public
744
744
  */
745
745
  tableName: string | undefined;
746
746
  /**
747
- * @public
748
747
  * <p>The <code>schemaDefinition</code> consists of the
749
748
  * following parameters.</p>
750
749
  * <p>For each column to be created:</p>
@@ -803,15 +802,15 @@ export interface CreateTableRequest {
803
802
  * data type.</p>
804
803
  * </li>
805
804
  * </ul>
805
+ * @public
806
806
  */
807
807
  schemaDefinition: SchemaDefinition | undefined;
808
808
  /**
809
- * @public
810
809
  * <p>This parameter allows to enter a description of the table.</p>
810
+ * @public
811
811
  */
812
812
  comment?: Comment;
813
813
  /**
814
- * @public
815
814
  * <p>Specifies the read/write throughput capacity mode for the table. The options are:</p>
816
815
  * <ul>
817
816
  * <li>
@@ -828,10 +827,10 @@ export interface CreateTableRequest {
828
827
  * <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
829
828
  * <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
830
829
  * Guide</i>.</p>
830
+ * @public
831
831
  */
832
832
  capacitySpecification?: CapacitySpecification;
833
833
  /**
834
- * @public
835
834
  * <p>Specifies how the encryption key for encryption at rest is managed for the table.
836
835
  * You can choose one of the following KMS key (KMS key):</p>
837
836
  * <ul>
@@ -849,10 +848,10 @@ export interface CreateTableRequest {
849
848
  * <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p>
850
849
  * <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
851
850
  * Guide</i>.</p>
851
+ * @public
852
852
  */
853
853
  encryptionSpecification?: EncryptionSpecification;
854
854
  /**
855
- * @public
856
855
  * <p>Specifies if <code>pointInTimeRecovery</code> is enabled or disabled for the
857
856
  * table. The options are:</p>
858
857
  * <ul>
@@ -871,10 +870,10 @@ export interface CreateTableRequest {
871
870
  * default is <code>status=DISABLED</code>.</p>
872
871
  * <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
873
872
  * Guide</i>.</p>
873
+ * @public
874
874
  */
875
875
  pointInTimeRecovery?: PointInTimeRecovery;
876
876
  /**
877
- * @public
878
877
  * <p>Enables Time to Live custom settings for the
879
878
  * table. The options are:</p>
880
879
  * <ul>
@@ -894,26 +893,26 @@ export interface CreateTableRequest {
894
893
  * for the table.</p>
895
894
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer
896
895
  * Guide</i>.</p>
896
+ * @public
897
897
  */
898
898
  ttl?: TimeToLive;
899
899
  /**
900
- * @public
901
900
  * <p>The default Time to Live setting in seconds for the
902
901
  * table.</p>
903
902
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer
904
903
  * Guide</i>.</p>
904
+ * @public
905
905
  */
906
906
  defaultTimeToLive?: number;
907
907
  /**
908
- * @public
909
908
  * <p>A list of key-value pair tags to be
910
909
  * attached to the resource. </p>
911
910
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
912
911
  * Guide</i>.</p>
912
+ * @public
913
913
  */
914
914
  tags?: Tag[];
915
915
  /**
916
- * @public
917
916
  * <p>
918
917
  * Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
919
918
  * client-side timestamps with the following option:</p>
@@ -925,20 +924,20 @@ export interface CreateTableRequest {
925
924
  * </li>
926
925
  * </ul>
927
926
  * <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
927
+ * @public
928
928
  */
929
929
  clientSideTimestamps?: ClientSideTimestamps;
930
930
  /**
931
- * @public
932
931
  * <p>The optional auto scaling settings for a table in provisioned capacity mode. Specifies if the service can manage throughput capacity
933
932
  * automatically on your behalf.</p>
934
933
  * <p>Auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing
935
934
  * your table's read and write capacity automatically in response to application traffic. For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
936
935
  * Guide</i>.</p>
937
936
  * <p>By default, auto scaling is disabled for a table. </p>
937
+ * @public
938
938
  */
939
939
  autoScalingSpecification?: AutoScalingSpecification;
940
940
  /**
941
- * @public
942
941
  * <p>The optional Amazon Web Services Region specific settings of a multi-Region table.
943
942
  * These settings overwrite the general settings of the table for the specified Region. </p>
944
943
  * <p>For a multi-Region table in provisioned capacity mode, you can configure the table's read capacity differently for each Region's replica. The write capacity, however,
@@ -958,6 +957,7 @@ export interface CreateTableRequest {
958
957
  * <code>readCapacityAutoScaling</code>: The read capacity auto scaling settings for the table. (Optional) </p>
959
958
  * </li>
960
959
  * </ul>
960
+ * @public
961
961
  */
962
962
  replicaSpecifications?: ReplicaSpecification[];
963
963
  }
@@ -966,21 +966,21 @@ export interface CreateTableRequest {
966
966
  */
967
967
  export interface CreateTableResponse {
968
968
  /**
969
- * @public
970
969
  * <p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>
970
+ * @public
971
971
  */
972
972
  resourceArn: string | undefined;
973
973
  }
974
974
  /**
975
- * @public
976
975
  * <p>The operation tried to access a keyspace or table that doesn't exist. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
976
+ * @public
977
977
  */
978
978
  export declare class ResourceNotFoundException extends __BaseException {
979
979
  readonly name: "ResourceNotFoundException";
980
980
  readonly $fault: "client";
981
981
  /**
982
- * @public
983
982
  * <p>The unique identifier in the format of Amazon Resource Name (ARN), for the resource not found.</p>
983
+ * @public
984
984
  */
985
985
  resourceArn?: string;
986
986
  /**
@@ -993,8 +993,8 @@ export declare class ResourceNotFoundException extends __BaseException {
993
993
  */
994
994
  export interface DeleteKeyspaceRequest {
995
995
  /**
996
- * @public
997
996
  * <p>The name of the keyspace to be deleted.</p>
997
+ * @public
998
998
  */
999
999
  keyspaceName: string | undefined;
1000
1000
  }
@@ -1008,13 +1008,13 @@ export interface DeleteKeyspaceResponse {
1008
1008
  */
1009
1009
  export interface DeleteTableRequest {
1010
1010
  /**
1011
- * @public
1012
1011
  * <p>The name of the keyspace of the to be deleted table.</p>
1012
+ * @public
1013
1013
  */
1014
1014
  keyspaceName: string | undefined;
1015
1015
  /**
1016
- * @public
1017
1016
  * <p>The name of the table to be deleted.</p>
1017
+ * @public
1018
1018
  */
1019
1019
  tableName: string | undefined;
1020
1020
  }
@@ -1028,8 +1028,8 @@ export interface DeleteTableResponse {
1028
1028
  */
1029
1029
  export interface GetKeyspaceRequest {
1030
1030
  /**
1031
- * @public
1032
1031
  * <p>The name of the keyspace.</p>
1032
+ * @public
1033
1033
  */
1034
1034
  keyspaceName: string | undefined;
1035
1035
  }
@@ -1038,27 +1038,27 @@ export interface GetKeyspaceRequest {
1038
1038
  */
1039
1039
  export interface GetKeyspaceResponse {
1040
1040
  /**
1041
- * @public
1042
1041
  * <p>The name of the keyspace.</p>
1042
+ * @public
1043
1043
  */
1044
1044
  keyspaceName: string | undefined;
1045
1045
  /**
1046
- * @public
1047
1046
  * <p>Returns the ARN of the keyspace.</p>
1047
+ * @public
1048
1048
  */
1049
1049
  resourceArn: string | undefined;
1050
1050
  /**
1051
- * @public
1052
1051
  * <p>
1053
1052
  * Returns the replication strategy of the keyspace. The options are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
1054
1053
  * </p>
1054
+ * @public
1055
1055
  */
1056
1056
  replicationStrategy: Rs | undefined;
1057
1057
  /**
1058
- * @public
1059
1058
  * <p>
1060
1059
  * If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
1061
1060
  * </p>
1061
+ * @public
1062
1062
  */
1063
1063
  replicationRegions?: string[];
1064
1064
  }
@@ -1067,29 +1067,29 @@ export interface GetKeyspaceResponse {
1067
1067
  */
1068
1068
  export interface GetTableRequest {
1069
1069
  /**
1070
- * @public
1071
1070
  * <p>The name of the keyspace that the table is stored in.</p>
1071
+ * @public
1072
1072
  */
1073
1073
  keyspaceName: string | undefined;
1074
1074
  /**
1075
- * @public
1076
1075
  * <p>The name of the table.</p>
1076
+ * @public
1077
1077
  */
1078
1078
  tableName: string | undefined;
1079
1079
  }
1080
1080
  /**
1081
- * @public
1082
1081
  * <p>The point-in-time recovery status of the specified table.</p>
1082
+ * @public
1083
1083
  */
1084
1084
  export interface PointInTimeRecoverySummary {
1085
1085
  /**
1086
- * @public
1087
1086
  * <p>Shows if point-in-time recovery is enabled or disabled for the specified table.</p>
1087
+ * @public
1088
1088
  */
1089
1089
  status: PointInTimeRecoveryStatus | undefined;
1090
1090
  /**
1091
- * @public
1092
1091
  * <p>Specifies the earliest possible restore point of the table in ISO 8601 format.</p>
1092
+ * @public
1093
1093
  */
1094
1094
  earliestRestorableTimestamp?: Date;
1095
1095
  }
@@ -1111,26 +1111,25 @@ export declare const TableStatus: {
1111
1111
  */
1112
1112
  export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
1113
1113
  /**
1114
- * @public
1115
1114
  * <p>The Region-specific settings of a multi-Region table in the specified Amazon Web Services Region.</p>
1116
1115
  * <p>If the multi-Region table is using provisioned capacity and has optional auto scaling policies configured, note that
1117
1116
  * the Region specific summary returns both read and write capacity settings. But only Region specific read capacity settings can be configured for a
1118
1117
  * multi-Region table. In a multi-Region table, your write capacity units will be synced across all Amazon Web Services Regions to ensure that there is enough
1119
1118
  * capacity to replicate write events across Regions.</p>
1119
+ * @public
1120
1120
  */
1121
1121
  export interface ReplicaSpecificationSummary {
1122
1122
  /**
1123
- * @public
1124
1123
  * <p>The Amazon Web Services Region.</p>
1124
+ * @public
1125
1125
  */
1126
1126
  region?: string;
1127
1127
  /**
1128
- * @public
1129
1128
  * <p>The status of the multi-Region table in the specified Amazon Web Services Region.</p>
1129
+ * @public
1130
1130
  */
1131
1131
  status?: TableStatus;
1132
1132
  /**
1133
- * @public
1134
1133
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
1135
1134
  * <ul>
1136
1135
  * <li>
@@ -1144,6 +1143,7 @@ export interface ReplicaSpecificationSummary {
1144
1143
  * </ul>
1145
1144
  * <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
1146
1145
  * Guide</i>.</p>
1146
+ * @public
1147
1147
  */
1148
1148
  capacitySpecification?: CapacitySpecificationSummary;
1149
1149
  }
@@ -1152,37 +1152,36 @@ export interface ReplicaSpecificationSummary {
1152
1152
  */
1153
1153
  export interface GetTableResponse {
1154
1154
  /**
1155
- * @public
1156
1155
  * <p>The name of the keyspace that the specified table is stored in.</p>
1156
+ * @public
1157
1157
  */
1158
1158
  keyspaceName: string | undefined;
1159
1159
  /**
1160
- * @public
1161
1160
  * <p>The name of the specified table.</p>
1161
+ * @public
1162
1162
  */
1163
1163
  tableName: string | undefined;
1164
1164
  /**
1165
- * @public
1166
1165
  * <p>The Amazon Resource Name (ARN) of the specified table.</p>
1166
+ * @public
1167
1167
  */
1168
1168
  resourceArn: string | undefined;
1169
1169
  /**
1170
- * @public
1171
1170
  * <p>The creation timestamp of the specified table.</p>
1171
+ * @public
1172
1172
  */
1173
1173
  creationTimestamp?: Date;
1174
1174
  /**
1175
- * @public
1176
1175
  * <p>The current status of the specified table.</p>
1176
+ * @public
1177
1177
  */
1178
1178
  status?: TableStatus;
1179
1179
  /**
1180
- * @public
1181
1180
  * <p>The schema definition of the specified table.</p>
1181
+ * @public
1182
1182
  */
1183
1183
  schemaDefinition?: SchemaDefinition;
1184
1184
  /**
1185
- * @public
1186
1185
  * <p>The read/write throughput capacity mode for a table. The options are:</p>
1187
1186
  * <ul>
1188
1187
  * <li>
@@ -1196,42 +1195,43 @@ export interface GetTableResponse {
1196
1195
  * </p>
1197
1196
  * </li>
1198
1197
  * </ul>
1198
+ * @public
1199
1199
  */
1200
1200
  capacitySpecification?: CapacitySpecificationSummary;
1201
1201
  /**
1202
- * @public
1203
1202
  * <p>The encryption settings of the specified table.</p>
1203
+ * @public
1204
1204
  */
1205
1205
  encryptionSpecification?: EncryptionSpecification;
1206
1206
  /**
1207
- * @public
1208
1207
  * <p>The point-in-time recovery status of the specified table.</p>
1208
+ * @public
1209
1209
  */
1210
1210
  pointInTimeRecovery?: PointInTimeRecoverySummary;
1211
1211
  /**
1212
- * @public
1213
1212
  * <p>The custom Time to Live settings of the specified table.</p>
1213
+ * @public
1214
1214
  */
1215
1215
  ttl?: TimeToLive;
1216
1216
  /**
1217
- * @public
1218
1217
  * <p>The default Time to Live settings in seconds of the specified table.</p>
1218
+ * @public
1219
1219
  */
1220
1220
  defaultTimeToLive?: number;
1221
1221
  /**
1222
- * @public
1223
1222
  * <p>The the description of the specified table.</p>
1223
+ * @public
1224
1224
  */
1225
1225
  comment?: Comment;
1226
1226
  /**
1227
- * @public
1228
1227
  * <p>
1229
1228
  * The client-side timestamps setting of the table.</p>
1229
+ * @public
1230
1230
  */
1231
1231
  clientSideTimestamps?: ClientSideTimestamps;
1232
1232
  /**
1233
- * @public
1234
1233
  * <p>Returns the Amazon Web Services Region specific settings of all Regions a multi-Region table is replicated in.</p>
1234
+ * @public
1235
1235
  */
1236
1236
  replicaSpecifications?: ReplicaSpecificationSummary[];
1237
1237
  }
@@ -1240,29 +1240,29 @@ export interface GetTableResponse {
1240
1240
  */
1241
1241
  export interface GetTableAutoScalingSettingsRequest {
1242
1242
  /**
1243
- * @public
1244
1243
  * <p>The name of the keyspace.</p>
1244
+ * @public
1245
1245
  */
1246
1246
  keyspaceName: string | undefined;
1247
1247
  /**
1248
- * @public
1249
1248
  * <p>The name of the table.</p>
1249
+ * @public
1250
1250
  */
1251
1251
  tableName: string | undefined;
1252
1252
  }
1253
1253
  /**
1254
- * @public
1255
1254
  * <p>The auto scaling settings of a multi-Region table in the specified Amazon Web Services Region.</p>
1255
+ * @public
1256
1256
  */
1257
1257
  export interface ReplicaAutoScalingSpecification {
1258
1258
  /**
1259
- * @public
1260
1259
  * <p>The Amazon Web Services Region.</p>
1260
+ * @public
1261
1261
  */
1262
1262
  region?: string;
1263
1263
  /**
1264
- * @public
1265
1264
  * <p>The auto scaling settings for a multi-Region table in the specified Amazon Web Services Region.</p>
1265
+ * @public
1266
1266
  */
1267
1267
  autoScalingSpecification?: AutoScalingSpecification;
1268
1268
  }
@@ -1271,28 +1271,28 @@ export interface ReplicaAutoScalingSpecification {
1271
1271
  */
1272
1272
  export interface GetTableAutoScalingSettingsResponse {
1273
1273
  /**
1274
- * @public
1275
1274
  * <p>The name of the keyspace.</p>
1275
+ * @public
1276
1276
  */
1277
1277
  keyspaceName: string | undefined;
1278
1278
  /**
1279
- * @public
1280
1279
  * <p>The name of the table.</p>
1280
+ * @public
1281
1281
  */
1282
1282
  tableName: string | undefined;
1283
1283
  /**
1284
- * @public
1285
1284
  * <p>The Amazon Resource Name (ARN) of the table.</p>
1285
+ * @public
1286
1286
  */
1287
1287
  resourceArn: string | undefined;
1288
1288
  /**
1289
- * @public
1290
1289
  * <p>The auto scaling settings of the table.</p>
1290
+ * @public
1291
1291
  */
1292
1292
  autoScalingSpecification?: AutoScalingSpecification;
1293
1293
  /**
1294
- * @public
1295
1294
  * <p>The Amazon Web Services Region specific settings of a multi-Region table. Returns the settings for all Regions the table is replicated in.</p>
1295
+ * @public
1296
1296
  */
1297
1297
  replicaSpecifications?: ReplicaAutoScalingSpecification[];
1298
1298
  }
@@ -1301,46 +1301,46 @@ export interface GetTableAutoScalingSettingsResponse {
1301
1301
  */
1302
1302
  export interface ListKeyspacesRequest {
1303
1303
  /**
1304
- * @public
1305
1304
  * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>
1305
+ * @public
1306
1306
  */
1307
1307
  nextToken?: string;
1308
1308
  /**
1309
- * @public
1310
1309
  * <p>The total number of keyspaces to return in the output. If the total number of keyspaces available
1311
1310
  * is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
1312
1311
  * provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
1312
+ * @public
1313
1313
  */
1314
1314
  maxResults?: number;
1315
1315
  }
1316
1316
  /**
1317
- * @public
1318
1317
  * <p>Represents the properties of a keyspace.</p>
1318
+ * @public
1319
1319
  */
1320
1320
  export interface KeyspaceSummary {
1321
1321
  /**
1322
- * @public
1323
1322
  * <p>The name of the keyspace.</p>
1323
+ * @public
1324
1324
  */
1325
1325
  keyspaceName: string | undefined;
1326
1326
  /**
1327
- * @public
1328
1327
  * <p>The unique identifier of the keyspace in the format of an Amazon Resource Name (ARN).</p>
1328
+ * @public
1329
1329
  */
1330
1330
  resourceArn: string | undefined;
1331
1331
  /**
1332
- * @public
1333
1332
  * <p>
1334
1333
  * This property specifies if a keyspace is a single Region keyspace or a multi-Region keyspace. The available
1335
1334
  * values are <code>SINGLE_REGION</code> or <code>MULTI_REGION</code>.
1336
1335
  * </p>
1336
+ * @public
1337
1337
  */
1338
1338
  replicationStrategy: Rs | undefined;
1339
1339
  /**
1340
- * @public
1341
1340
  * <p>
1342
1341
  * If the <code>replicationStrategy</code> of the keyspace is <code>MULTI_REGION</code>, a list of replication Regions is returned.
1343
1342
  * </p>
1343
+ * @public
1344
1344
  */
1345
1345
  replicationRegions?: string[];
1346
1346
  }
@@ -1349,13 +1349,13 @@ export interface KeyspaceSummary {
1349
1349
  */
1350
1350
  export interface ListKeyspacesResponse {
1351
1351
  /**
1352
- * @public
1353
1352
  * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
1353
+ * @public
1354
1354
  */
1355
1355
  nextToken?: string;
1356
1356
  /**
1357
- * @public
1358
1357
  * <p>A list of keyspaces.</p>
1358
+ * @public
1359
1359
  */
1360
1360
  keyspaces: KeyspaceSummary[] | undefined;
1361
1361
  }
@@ -1364,41 +1364,41 @@ export interface ListKeyspacesResponse {
1364
1364
  */
1365
1365
  export interface ListTablesRequest {
1366
1366
  /**
1367
- * @public
1368
1367
  * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
1368
+ * @public
1369
1369
  */
1370
1370
  nextToken?: string;
1371
1371
  /**
1372
- * @public
1373
1372
  * <p>The total number of tables to return in the output. If the total number of tables available
1374
1373
  * is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
1375
1374
  * provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
1375
+ * @public
1376
1376
  */
1377
1377
  maxResults?: number;
1378
1378
  /**
1379
- * @public
1380
1379
  * <p>The name of the keyspace.</p>
1380
+ * @public
1381
1381
  */
1382
1382
  keyspaceName: string | undefined;
1383
1383
  }
1384
1384
  /**
1385
- * @public
1386
1385
  * <p>Returns the name of the specified table, the keyspace it is stored in, and the unique identifier in the format of an Amazon Resource Name (ARN).</p>
1386
+ * @public
1387
1387
  */
1388
1388
  export interface TableSummary {
1389
1389
  /**
1390
- * @public
1391
1390
  * <p>The name of the keyspace that the table is stored in.</p>
1391
+ * @public
1392
1392
  */
1393
1393
  keyspaceName: string | undefined;
1394
1394
  /**
1395
- * @public
1396
1395
  * <p>The name of the table.</p>
1396
+ * @public
1397
1397
  */
1398
1398
  tableName: string | undefined;
1399
1399
  /**
1400
- * @public
1401
1400
  * <p>The unique identifier of the table in the format of an Amazon Resource Name (ARN).</p>
1401
+ * @public
1402
1402
  */
1403
1403
  resourceArn: string | undefined;
1404
1404
  }
@@ -1407,13 +1407,13 @@ export interface TableSummary {
1407
1407
  */
1408
1408
  export interface ListTablesResponse {
1409
1409
  /**
1410
- * @public
1411
1410
  * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
1411
+ * @public
1412
1412
  */
1413
1413
  nextToken?: string;
1414
1414
  /**
1415
- * @public
1416
1415
  * <p>A list of tables.</p>
1416
+ * @public
1417
1417
  */
1418
1418
  tables?: TableSummary[];
1419
1419
  }
@@ -1422,20 +1422,20 @@ export interface ListTablesResponse {
1422
1422
  */
1423
1423
  export interface ListTagsForResourceRequest {
1424
1424
  /**
1425
- * @public
1426
1425
  * <p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource.</p>
1426
+ * @public
1427
1427
  */
1428
1428
  resourceArn: string | undefined;
1429
1429
  /**
1430
- * @public
1431
1430
  * <p>The pagination token. To resume pagination, provide the <code>NextToken</code> value as argument of a subsequent API invocation.</p>
1431
+ * @public
1432
1432
  */
1433
1433
  nextToken?: string;
1434
1434
  /**
1435
- * @public
1436
1435
  * <p>The total number of tags to return in the output. If the total number of tags available
1437
1436
  * is more than the value specified, a <code>NextToken</code> is provided in the output. To resume pagination,
1438
1437
  * provide the <code>NextToken</code> value as an argument of a subsequent API invocation.</p>
1438
+ * @public
1439
1439
  */
1440
1440
  maxResults?: number;
1441
1441
  }
@@ -1444,13 +1444,13 @@ export interface ListTagsForResourceRequest {
1444
1444
  */
1445
1445
  export interface ListTagsForResourceResponse {
1446
1446
  /**
1447
- * @public
1448
1447
  * <p>A token to specify where to start paginating. This is the <code>NextToken</code> from a previously truncated response.</p>
1448
+ * @public
1449
1449
  */
1450
1450
  nextToken?: string;
1451
1451
  /**
1452
- * @public
1453
1452
  * <p>A list of tags.</p>
1453
+ * @public
1454
1454
  */
1455
1455
  tags?: Tag[];
1456
1456
  }
@@ -1459,32 +1459,31 @@ export interface ListTagsForResourceResponse {
1459
1459
  */
1460
1460
  export interface RestoreTableRequest {
1461
1461
  /**
1462
- * @public
1463
1462
  * <p>The keyspace name of the source table.</p>
1463
+ * @public
1464
1464
  */
1465
1465
  sourceKeyspaceName: string | undefined;
1466
1466
  /**
1467
- * @public
1468
1467
  * <p>The name of the source table.</p>
1468
+ * @public
1469
1469
  */
1470
1470
  sourceTableName: string | undefined;
1471
1471
  /**
1472
- * @public
1473
1472
  * <p>The name of the target keyspace.</p>
1473
+ * @public
1474
1474
  */
1475
1475
  targetKeyspaceName: string | undefined;
1476
1476
  /**
1477
- * @public
1478
1477
  * <p>The name of the target table.</p>
1478
+ * @public
1479
1479
  */
1480
1480
  targetTableName: string | undefined;
1481
1481
  /**
1482
- * @public
1483
1482
  * <p>The restore timestamp in ISO 8601 format.</p>
1483
+ * @public
1484
1484
  */
1485
1485
  restoreTimestamp?: Date;
1486
1486
  /**
1487
- * @public
1488
1487
  * <p>Specifies the read/write throughput capacity mode for the target table. The options are:</p>
1489
1488
  * <ul>
1490
1489
  * <li>
@@ -1501,10 +1500,10 @@ export interface RestoreTableRequest {
1501
1500
  * <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
1502
1501
  * <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
1503
1502
  * Guide</i>.</p>
1503
+ * @public
1504
1504
  */
1505
1505
  capacitySpecificationOverride?: CapacitySpecification;
1506
1506
  /**
1507
- * @public
1508
1507
  * <p>Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):</p>
1509
1508
  * <ul>
1510
1509
  * <li>
@@ -1521,10 +1520,10 @@ export interface RestoreTableRequest {
1521
1520
  * <p>The default is <code>type:AWS_OWNED_KMS_KEY</code>.</p>
1522
1521
  * <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
1523
1522
  * Guide</i>.</p>
1523
+ * @public
1524
1524
  */
1525
1525
  encryptionSpecificationOverride?: EncryptionSpecification;
1526
1526
  /**
1527
- * @public
1528
1527
  * <p>Specifies the <code>pointInTimeRecovery</code> settings for the target
1529
1528
  * table. The options are:</p>
1530
1529
  * <ul>
@@ -1542,18 +1541,18 @@ export interface RestoreTableRequest {
1542
1541
  * <p>If it's not specified, the default is <code>status=DISABLED</code>.</p>
1543
1542
  * <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
1544
1543
  * Guide</i>.</p>
1544
+ * @public
1545
1545
  */
1546
1546
  pointInTimeRecoveryOverride?: PointInTimeRecovery;
1547
1547
  /**
1548
- * @public
1549
1548
  * <p>A list of key-value pair tags to be
1550
1549
  * attached to the restored table. </p>
1551
1550
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/tagging-keyspaces.html">Adding tags and labels to Amazon Keyspaces resources</a> in the <i>Amazon Keyspaces Developer
1552
1551
  * Guide</i>.</p>
1552
+ * @public
1553
1553
  */
1554
1554
  tagsOverride?: Tag[];
1555
1555
  /**
1556
- * @public
1557
1556
  * <p>The optional auto scaling settings for the restored table in provisioned capacity mode.
1558
1557
  * Specifies if the service can manage throughput capacity of a provisioned table
1559
1558
  * automatically on your behalf.
@@ -1561,11 +1560,12 @@ export interface RestoreTableRequest {
1561
1560
  * your table's read and write capacity automatically in response to application traffic.</p>
1562
1561
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
1563
1562
  * Guide</i>.</p>
1563
+ * @public
1564
1564
  */
1565
1565
  autoScalingSpecification?: AutoScalingSpecification;
1566
1566
  /**
1567
- * @public
1568
1567
  * <p>The optional Region specific settings of a multi-Regional table.</p>
1568
+ * @public
1569
1569
  */
1570
1570
  replicaSpecifications?: ReplicaSpecification[];
1571
1571
  }
@@ -1574,8 +1574,8 @@ export interface RestoreTableRequest {
1574
1574
  */
1575
1575
  export interface RestoreTableResponse {
1576
1576
  /**
1577
- * @public
1578
1577
  * <p>The Amazon Resource Name (ARN) of the restored table.</p>
1578
+ * @public
1579
1579
  */
1580
1580
  restoredTableARN: string | undefined;
1581
1581
  }
@@ -1584,13 +1584,13 @@ export interface RestoreTableResponse {
1584
1584
  */
1585
1585
  export interface TagResourceRequest {
1586
1586
  /**
1587
- * @public
1588
1587
  * <p>The Amazon Resource Name (ARN) of the Amazon Keyspaces resource to which to add tags.</p>
1588
+ * @public
1589
1589
  */
1590
1590
  resourceArn: string | undefined;
1591
1591
  /**
1592
- * @public
1593
1592
  * <p>The tags to be assigned to the Amazon Keyspaces resource.</p>
1593
+ * @public
1594
1594
  */
1595
1595
  tags: Tag[] | undefined;
1596
1596
  }
@@ -1604,13 +1604,13 @@ export interface TagResourceResponse {
1604
1604
  */
1605
1605
  export interface UntagResourceRequest {
1606
1606
  /**
1607
- * @public
1608
1607
  * <p>The Amazon Keyspaces resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).</p>
1608
+ * @public
1609
1609
  */
1610
1610
  resourceArn: string | undefined;
1611
1611
  /**
1612
- * @public
1613
1612
  * <p>A list of existing tags to be removed from the Amazon Keyspaces resource.</p>
1613
+ * @public
1614
1614
  */
1615
1615
  tags: Tag[] | undefined;
1616
1616
  }
@@ -1624,17 +1624,16 @@ export interface UntagResourceResponse {
1624
1624
  */
1625
1625
  export interface UpdateTableRequest {
1626
1626
  /**
1627
- * @public
1628
1627
  * <p>The name of the keyspace the specified table is stored in.</p>
1628
+ * @public
1629
1629
  */
1630
1630
  keyspaceName: string | undefined;
1631
1631
  /**
1632
- * @public
1633
1632
  * <p>The name of the table.</p>
1633
+ * @public
1634
1634
  */
1635
1635
  tableName: string | undefined;
1636
1636
  /**
1637
- * @public
1638
1637
  * <p>For each column to be added to the specified table:</p>
1639
1638
  * <ul>
1640
1639
  * <li>
@@ -1649,10 +1648,10 @@ export interface UpdateTableRequest {
1649
1648
  * Guide</i>.</p>
1650
1649
  * </li>
1651
1650
  * </ul>
1651
+ * @public
1652
1652
  */
1653
1653
  addColumns?: ColumnDefinition[];
1654
1654
  /**
1655
- * @public
1656
1655
  * <p>Modifies the read/write throughput capacity mode for the table. The options are:</p>
1657
1656
  * <ul>
1658
1657
  * <li>
@@ -1668,10 +1667,10 @@ export interface UpdateTableRequest {
1668
1667
  * <p>The default is <code>throughput_mode:PAY_PER_REQUEST</code>.</p>
1669
1668
  * <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
1670
1669
  * Guide</i>.</p>
1670
+ * @public
1671
1671
  */
1672
1672
  capacitySpecification?: CapacitySpecification;
1673
1673
  /**
1674
- * @public
1675
1674
  * <p>Modifies the encryption settings of the table. You can choose one of the following KMS key (KMS key):</p>
1676
1675
  * <ul>
1677
1676
  * <li>
@@ -1688,10 +1687,10 @@ export interface UpdateTableRequest {
1688
1687
  * <p>The default is <code>AWS_OWNED_KMS_KEY</code>.</p>
1689
1688
  * <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
1690
1689
  * Guide</i>.</p>
1690
+ * @public
1691
1691
  */
1692
1692
  encryptionSpecification?: EncryptionSpecification;
1693
1693
  /**
1694
- * @public
1695
1694
  * <p>Modifies the <code>pointInTimeRecovery</code> settings of the table. The options are:</p>
1696
1695
  * <ul>
1697
1696
  * <li>
@@ -1708,10 +1707,10 @@ export interface UpdateTableRequest {
1708
1707
  * <p>If it's not specified, the default is <code>status=DISABLED</code>.</p>
1709
1708
  * <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
1710
1709
  * Guide</i>.</p>
1710
+ * @public
1711
1711
  */
1712
1712
  pointInTimeRecovery?: PointInTimeRecovery;
1713
1713
  /**
1714
- * @public
1715
1714
  * <p>Modifies Time to Live custom settings for the table. The options are:</p>
1716
1715
  * <ul>
1717
1716
  * <li>
@@ -1730,17 +1729,17 @@ export interface UpdateTableRequest {
1730
1729
  * for the table.</p>
1731
1730
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL.html">Expiring data by using Amazon Keyspaces Time to Live (TTL)</a> in the <i>Amazon Keyspaces Developer
1732
1731
  * Guide</i>.</p>
1732
+ * @public
1733
1733
  */
1734
1734
  ttl?: TimeToLive;
1735
1735
  /**
1736
- * @public
1737
1736
  * <p>The default Time to Live setting in seconds for the table.</p>
1738
1737
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/TTL-how-it-works.html#ttl-howitworks_default_ttl">Setting the default TTL value for a table</a> in the <i>Amazon Keyspaces Developer
1739
1738
  * Guide</i>.</p>
1739
+ * @public
1740
1740
  */
1741
1741
  defaultTimeToLive?: number;
1742
1742
  /**
1743
- * @public
1744
1743
  * <p>Enables client-side timestamps for the table. By default, the setting is disabled. You can enable
1745
1744
  * client-side timestamps with the following option:</p>
1746
1745
  * <ul>
@@ -1751,10 +1750,10 @@ export interface UpdateTableRequest {
1751
1750
  * </li>
1752
1751
  * </ul>
1753
1752
  * <p>Once client-side timestamps are enabled for a table, this setting cannot be disabled.</p>
1753
+ * @public
1754
1754
  */
1755
1755
  clientSideTimestamps?: ClientSideTimestamps;
1756
1756
  /**
1757
- * @public
1758
1757
  * <p>The optional auto scaling settings to update for a table in provisioned capacity mode.
1759
1758
  * Specifies if the service can manage throughput capacity of a provisioned table
1760
1759
  * automatically on your behalf.
@@ -1764,11 +1763,12 @@ export interface UpdateTableRequest {
1764
1763
  * auto scaling policy settings independently.</p>
1765
1764
  * <p>For more information, see <a href="https://docs.aws.amazon.com/keyspaces/latest/devguide/autoscaling.html">Managing throughput capacity automatically with Amazon Keyspaces auto scaling</a> in the <i>Amazon Keyspaces Developer
1766
1765
  * Guide</i>.</p>
1766
+ * @public
1767
1767
  */
1768
1768
  autoScalingSpecification?: AutoScalingSpecification;
1769
1769
  /**
1770
- * @public
1771
1770
  * <p>The Region specific settings of a multi-Regional table.</p>
1771
+ * @public
1772
1772
  */
1773
1773
  replicaSpecifications?: ReplicaSpecification[];
1774
1774
  }
@@ -1777,8 +1777,8 @@ export interface UpdateTableRequest {
1777
1777
  */
1778
1778
  export interface UpdateTableResponse {
1779
1779
  /**
1780
- * @public
1781
1780
  * <p>The Amazon Resource Name (ARN) of the modified table.</p>
1781
+ * @public
1782
1782
  */
1783
1783
  resourceArn: string | undefined;
1784
1784
  }