@aws-sdk/client-dynamodb 3.379.1 → 3.382.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/dist-types/models/models_0.d.ts +729 -0
- package/package.json +5 -5
|
@@ -6,11 +6,13 @@ import { DynamoDBServiceException as __BaseException } from "./DynamoDBServiceEx
|
|
|
6
6
|
*/
|
|
7
7
|
export interface ArchivalSummary {
|
|
8
8
|
/**
|
|
9
|
+
* @public
|
|
9
10
|
* <p>The date and time when table archival was initiated by DynamoDB, in UNIX epoch time
|
|
10
11
|
* format.</p>
|
|
11
12
|
*/
|
|
12
13
|
ArchivalDateTime?: Date;
|
|
13
14
|
/**
|
|
15
|
+
* @public
|
|
14
16
|
* <p>The reason DynamoDB archived the table. Currently, the only possible value is:</p>
|
|
15
17
|
* <ul>
|
|
16
18
|
* <li>
|
|
@@ -23,6 +25,7 @@ export interface ArchivalSummary {
|
|
|
23
25
|
*/
|
|
24
26
|
ArchivalReason?: string;
|
|
25
27
|
/**
|
|
28
|
+
* @public
|
|
26
29
|
* <p>The Amazon Resource Name (ARN) of the backup the table was archived to, when
|
|
27
30
|
* applicable in the archival reason. If you wish to restore this backup to the same table
|
|
28
31
|
* name, you will need to delete the original table.</p>
|
|
@@ -62,10 +65,12 @@ export type ScalarAttributeType = (typeof ScalarAttributeType)[keyof typeof Scal
|
|
|
62
65
|
*/
|
|
63
66
|
export interface AttributeDefinition {
|
|
64
67
|
/**
|
|
68
|
+
* @public
|
|
65
69
|
* <p>A name for the attribute.</p>
|
|
66
70
|
*/
|
|
67
71
|
AttributeName: string | undefined;
|
|
68
72
|
/**
|
|
73
|
+
* @public
|
|
69
74
|
* <p>The data type for the attribute, where:</p>
|
|
70
75
|
* <ul>
|
|
71
76
|
* <li>
|
|
@@ -90,6 +95,7 @@ export interface AttributeDefinition {
|
|
|
90
95
|
*/
|
|
91
96
|
export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription {
|
|
92
97
|
/**
|
|
98
|
+
* @public
|
|
93
99
|
* <p>Indicates whether scale in by the target tracking policy is disabled. If the value is
|
|
94
100
|
* true, scale in is disabled and the target tracking policy won't remove capacity from the
|
|
95
101
|
* scalable resource. Otherwise, scale in is enabled and the target tracking policy can
|
|
@@ -97,6 +103,7 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription
|
|
|
97
103
|
*/
|
|
98
104
|
DisableScaleIn?: boolean;
|
|
99
105
|
/**
|
|
106
|
+
* @public
|
|
100
107
|
* <p>The amount of time, in seconds, after a scale in activity completes before another
|
|
101
108
|
* scale in activity can start. The cooldown period is used to block subsequent scale in
|
|
102
109
|
* requests until it has expired. You should scale in conservatively to protect your
|
|
@@ -106,6 +113,7 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription
|
|
|
106
113
|
*/
|
|
107
114
|
ScaleInCooldown?: number;
|
|
108
115
|
/**
|
|
116
|
+
* @public
|
|
109
117
|
* <p>The amount of time, in seconds, after a scale out activity completes before another
|
|
110
118
|
* scale out activity can start. While the cooldown period is in effect, the capacity that
|
|
111
119
|
* has been added by the previous scale out event that initiated the cooldown is calculated
|
|
@@ -114,6 +122,7 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription
|
|
|
114
122
|
*/
|
|
115
123
|
ScaleOutCooldown?: number;
|
|
116
124
|
/**
|
|
125
|
+
* @public
|
|
117
126
|
* <p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)
|
|
118
127
|
* or 2e-360 to 2e360 (Base 2).</p>
|
|
119
128
|
*/
|
|
@@ -125,10 +134,12 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription
|
|
|
125
134
|
*/
|
|
126
135
|
export interface AutoScalingPolicyDescription {
|
|
127
136
|
/**
|
|
137
|
+
* @public
|
|
128
138
|
* <p>The name of the scaling policy.</p>
|
|
129
139
|
*/
|
|
130
140
|
PolicyName?: string;
|
|
131
141
|
/**
|
|
142
|
+
* @public
|
|
132
143
|
* <p>Represents a target tracking scaling policy configuration.</p>
|
|
133
144
|
*/
|
|
134
145
|
TargetTrackingScalingPolicyConfiguration?: AutoScalingTargetTrackingScalingPolicyConfigurationDescription;
|
|
@@ -140,6 +151,7 @@ export interface AutoScalingPolicyDescription {
|
|
|
140
151
|
*/
|
|
141
152
|
export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
|
|
142
153
|
/**
|
|
154
|
+
* @public
|
|
143
155
|
* <p>Indicates whether scale in by the target tracking policy is disabled. If the value is
|
|
144
156
|
* true, scale in is disabled and the target tracking policy won't remove capacity from the
|
|
145
157
|
* scalable resource. Otherwise, scale in is enabled and the target tracking policy can
|
|
@@ -147,6 +159,7 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
|
|
|
147
159
|
*/
|
|
148
160
|
DisableScaleIn?: boolean;
|
|
149
161
|
/**
|
|
162
|
+
* @public
|
|
150
163
|
* <p>The amount of time, in seconds, after a scale in activity completes before another
|
|
151
164
|
* scale in activity can start. The cooldown period is used to block subsequent scale in
|
|
152
165
|
* requests until it has expired. You should scale in conservatively to protect your
|
|
@@ -156,6 +169,7 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
|
|
|
156
169
|
*/
|
|
157
170
|
ScaleInCooldown?: number;
|
|
158
171
|
/**
|
|
172
|
+
* @public
|
|
159
173
|
* <p>The amount of time, in seconds, after a scale out activity completes before another
|
|
160
174
|
* scale out activity can start. While the cooldown period is in effect, the capacity that
|
|
161
175
|
* has been added by the previous scale out event that initiated the cooldown is calculated
|
|
@@ -164,6 +178,7 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
|
|
|
164
178
|
*/
|
|
165
179
|
ScaleOutCooldown?: number;
|
|
166
180
|
/**
|
|
181
|
+
* @public
|
|
167
182
|
* <p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)
|
|
168
183
|
* or 2e-360 to 2e360 (Base 2).</p>
|
|
169
184
|
*/
|
|
@@ -175,10 +190,12 @@ export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
|
|
|
175
190
|
*/
|
|
176
191
|
export interface AutoScalingPolicyUpdate {
|
|
177
192
|
/**
|
|
193
|
+
* @public
|
|
178
194
|
* <p>The name of the scaling policy.</p>
|
|
179
195
|
*/
|
|
180
196
|
PolicyName?: string;
|
|
181
197
|
/**
|
|
198
|
+
* @public
|
|
182
199
|
* <p>Represents a target tracking scaling policy configuration.</p>
|
|
183
200
|
*/
|
|
184
201
|
TargetTrackingScalingPolicyConfiguration: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate | undefined;
|
|
@@ -190,24 +207,29 @@ export interface AutoScalingPolicyUpdate {
|
|
|
190
207
|
*/
|
|
191
208
|
export interface AutoScalingSettingsDescription {
|
|
192
209
|
/**
|
|
210
|
+
* @public
|
|
193
211
|
* <p>The minimum capacity units that a global table or global secondary index should be
|
|
194
212
|
* scaled down to.</p>
|
|
195
213
|
*/
|
|
196
214
|
MinimumUnits?: number;
|
|
197
215
|
/**
|
|
216
|
+
* @public
|
|
198
217
|
* <p>The maximum capacity units that a global table or global secondary index should be
|
|
199
218
|
* scaled up to.</p>
|
|
200
219
|
*/
|
|
201
220
|
MaximumUnits?: number;
|
|
202
221
|
/**
|
|
222
|
+
* @public
|
|
203
223
|
* <p>Disabled auto scaling for this global table or global secondary index.</p>
|
|
204
224
|
*/
|
|
205
225
|
AutoScalingDisabled?: boolean;
|
|
206
226
|
/**
|
|
227
|
+
* @public
|
|
207
228
|
* <p>Role ARN used for configuring the auto scaling policy.</p>
|
|
208
229
|
*/
|
|
209
230
|
AutoScalingRoleArn?: string;
|
|
210
231
|
/**
|
|
232
|
+
* @public
|
|
211
233
|
* <p>Information about the scaling policies.</p>
|
|
212
234
|
*/
|
|
213
235
|
ScalingPolicies?: AutoScalingPolicyDescription[];
|
|
@@ -219,24 +241,29 @@ export interface AutoScalingSettingsDescription {
|
|
|
219
241
|
*/
|
|
220
242
|
export interface AutoScalingSettingsUpdate {
|
|
221
243
|
/**
|
|
244
|
+
* @public
|
|
222
245
|
* <p>The minimum capacity units that a global table or global secondary index should be
|
|
223
246
|
* scaled down to.</p>
|
|
224
247
|
*/
|
|
225
248
|
MinimumUnits?: number;
|
|
226
249
|
/**
|
|
250
|
+
* @public
|
|
227
251
|
* <p>The maximum capacity units that a global table or global secondary index should be
|
|
228
252
|
* scaled up to.</p>
|
|
229
253
|
*/
|
|
230
254
|
MaximumUnits?: number;
|
|
231
255
|
/**
|
|
256
|
+
* @public
|
|
232
257
|
* <p>Disabled auto scaling for this global table or global secondary index.</p>
|
|
233
258
|
*/
|
|
234
259
|
AutoScalingDisabled?: boolean;
|
|
235
260
|
/**
|
|
261
|
+
* @public
|
|
236
262
|
* <p>Role ARN used for configuring auto scaling policy.</p>
|
|
237
263
|
*/
|
|
238
264
|
AutoScalingRoleArn?: string;
|
|
239
265
|
/**
|
|
266
|
+
* @public
|
|
240
267
|
* <p>The scaling policy to apply for scaling target global table or global secondary index
|
|
241
268
|
* capacity units.</p>
|
|
242
269
|
*/
|
|
@@ -274,23 +301,28 @@ export type BackupType = (typeof BackupType)[keyof typeof BackupType];
|
|
|
274
301
|
*/
|
|
275
302
|
export interface BackupDetails {
|
|
276
303
|
/**
|
|
304
|
+
* @public
|
|
277
305
|
* <p>ARN associated with the backup.</p>
|
|
278
306
|
*/
|
|
279
307
|
BackupArn: string | undefined;
|
|
280
308
|
/**
|
|
309
|
+
* @public
|
|
281
310
|
* <p>Name of the requested backup.</p>
|
|
282
311
|
*/
|
|
283
312
|
BackupName: string | undefined;
|
|
284
313
|
/**
|
|
314
|
+
* @public
|
|
285
315
|
* <p>Size of the backup in bytes. DynamoDB updates this value approximately every six
|
|
286
316
|
* hours. Recent changes might not be reflected in this value.</p>
|
|
287
317
|
*/
|
|
288
318
|
BackupSizeBytes?: number;
|
|
289
319
|
/**
|
|
320
|
+
* @public
|
|
290
321
|
* <p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED. </p>
|
|
291
322
|
*/
|
|
292
323
|
BackupStatus: BackupStatus | string | undefined;
|
|
293
324
|
/**
|
|
325
|
+
* @public
|
|
294
326
|
* <p>BackupType:</p>
|
|
295
327
|
* <ul>
|
|
296
328
|
* <li>
|
|
@@ -313,10 +345,12 @@ export interface BackupDetails {
|
|
|
313
345
|
*/
|
|
314
346
|
BackupType: BackupType | string | undefined;
|
|
315
347
|
/**
|
|
348
|
+
* @public
|
|
316
349
|
* <p>Time at which the backup was created. This is the request time of the backup. </p>
|
|
317
350
|
*/
|
|
318
351
|
BackupCreationDateTime: Date | undefined;
|
|
319
352
|
/**
|
|
353
|
+
* @public
|
|
320
354
|
* <p>Time at which the automatic on-demand backup created by DynamoDB will
|
|
321
355
|
* expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after
|
|
322
356
|
* its creation.</p>
|
|
@@ -363,10 +397,12 @@ export type KeyType = (typeof KeyType)[keyof typeof KeyType];
|
|
|
363
397
|
*/
|
|
364
398
|
export interface KeySchemaElement {
|
|
365
399
|
/**
|
|
400
|
+
* @public
|
|
366
401
|
* <p>The name of a key attribute.</p>
|
|
367
402
|
*/
|
|
368
403
|
AttributeName: string | undefined;
|
|
369
404
|
/**
|
|
405
|
+
* @public
|
|
370
406
|
* <p>The role that this key attribute will assume:</p>
|
|
371
407
|
* <ul>
|
|
372
408
|
* <li>
|
|
@@ -400,6 +436,7 @@ export interface KeySchemaElement {
|
|
|
400
436
|
*/
|
|
401
437
|
export interface ProvisionedThroughput {
|
|
402
438
|
/**
|
|
439
|
+
* @public
|
|
403
440
|
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
|
|
404
441
|
* returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
|
|
405
442
|
* Developer Guide</i>.</p>
|
|
@@ -408,6 +445,7 @@ export interface ProvisionedThroughput {
|
|
|
408
445
|
*/
|
|
409
446
|
ReadCapacityUnits: number | undefined;
|
|
410
447
|
/**
|
|
448
|
+
* @public
|
|
411
449
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
412
450
|
* <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
|
|
413
451
|
* Developer Guide</i>.</p>
|
|
@@ -422,38 +460,47 @@ export interface ProvisionedThroughput {
|
|
|
422
460
|
*/
|
|
423
461
|
export interface SourceTableDetails {
|
|
424
462
|
/**
|
|
463
|
+
* @public
|
|
425
464
|
* <p>The name of the table for which the backup was created. </p>
|
|
426
465
|
*/
|
|
427
466
|
TableName: string | undefined;
|
|
428
467
|
/**
|
|
468
|
+
* @public
|
|
429
469
|
* <p>Unique identifier for the table for which the backup was created. </p>
|
|
430
470
|
*/
|
|
431
471
|
TableId: string | undefined;
|
|
432
472
|
/**
|
|
473
|
+
* @public
|
|
433
474
|
* <p>ARN of the table for which backup was created. </p>
|
|
434
475
|
*/
|
|
435
476
|
TableArn?: string;
|
|
436
477
|
/**
|
|
478
|
+
* @public
|
|
437
479
|
* <p>Size of the table in bytes. Note that this is an approximate value.</p>
|
|
438
480
|
*/
|
|
439
481
|
TableSizeBytes?: number;
|
|
440
482
|
/**
|
|
483
|
+
* @public
|
|
441
484
|
* <p>Schema of the table. </p>
|
|
442
485
|
*/
|
|
443
486
|
KeySchema: KeySchemaElement[] | undefined;
|
|
444
487
|
/**
|
|
488
|
+
* @public
|
|
445
489
|
* <p>Time when the source table was created. </p>
|
|
446
490
|
*/
|
|
447
491
|
TableCreationDateTime: Date | undefined;
|
|
448
492
|
/**
|
|
493
|
+
* @public
|
|
449
494
|
* <p>Read IOPs and Write IOPS on the table when the backup was created.</p>
|
|
450
495
|
*/
|
|
451
496
|
ProvisionedThroughput: ProvisionedThroughput | undefined;
|
|
452
497
|
/**
|
|
498
|
+
* @public
|
|
453
499
|
* <p>Number of items in the table. Note that this is an approximate value. </p>
|
|
454
500
|
*/
|
|
455
501
|
ItemCount?: number;
|
|
456
502
|
/**
|
|
503
|
+
* @public
|
|
457
504
|
* <p>Controls how you are charged for read and write throughput and how you manage
|
|
458
505
|
* capacity. This setting can be changed later.</p>
|
|
459
506
|
* <ul>
|
|
@@ -494,6 +541,7 @@ export type ProjectionType = (typeof ProjectionType)[keyof typeof ProjectionType
|
|
|
494
541
|
*/
|
|
495
542
|
export interface Projection {
|
|
496
543
|
/**
|
|
544
|
+
* @public
|
|
497
545
|
* <p>The set of attributes that are projected into the index:</p>
|
|
498
546
|
* <ul>
|
|
499
547
|
* <li>
|
|
@@ -516,6 +564,7 @@ export interface Projection {
|
|
|
516
564
|
*/
|
|
517
565
|
ProjectionType?: ProjectionType | string;
|
|
518
566
|
/**
|
|
567
|
+
* @public
|
|
519
568
|
* <p>Represents the non-key attribute names which will be projected into the index.</p>
|
|
520
569
|
* <p>For local secondary indexes, the total count of <code>NonKeyAttributes</code> summed
|
|
521
570
|
* across all of the local secondary indexes, must not exceed 100. If you project the same
|
|
@@ -531,10 +580,12 @@ export interface Projection {
|
|
|
531
580
|
*/
|
|
532
581
|
export interface GlobalSecondaryIndexInfo {
|
|
533
582
|
/**
|
|
583
|
+
* @public
|
|
534
584
|
* <p>The name of the global secondary index.</p>
|
|
535
585
|
*/
|
|
536
586
|
IndexName?: string;
|
|
537
587
|
/**
|
|
588
|
+
* @public
|
|
538
589
|
* <p>The complete key schema for a global secondary index, which consists of one or more
|
|
539
590
|
* pairs of attribute names and key types:</p>
|
|
540
591
|
* <ul>
|
|
@@ -559,12 +610,14 @@ export interface GlobalSecondaryIndexInfo {
|
|
|
559
610
|
*/
|
|
560
611
|
KeySchema?: KeySchemaElement[];
|
|
561
612
|
/**
|
|
613
|
+
* @public
|
|
562
614
|
* <p>Represents attributes that are copied (projected) from the table into the global
|
|
563
615
|
* secondary index. These are in addition to the primary key attributes and index key
|
|
564
616
|
* attributes, which are automatically projected. </p>
|
|
565
617
|
*/
|
|
566
618
|
Projection?: Projection;
|
|
567
619
|
/**
|
|
620
|
+
* @public
|
|
568
621
|
* <p>Represents the provisioned throughput settings for the specified global secondary
|
|
569
622
|
* index. </p>
|
|
570
623
|
*/
|
|
@@ -577,10 +630,12 @@ export interface GlobalSecondaryIndexInfo {
|
|
|
577
630
|
*/
|
|
578
631
|
export interface LocalSecondaryIndexInfo {
|
|
579
632
|
/**
|
|
633
|
+
* @public
|
|
580
634
|
* <p>Represents the name of the local secondary index.</p>
|
|
581
635
|
*/
|
|
582
636
|
IndexName?: string;
|
|
583
637
|
/**
|
|
638
|
+
* @public
|
|
584
639
|
* <p>The complete key schema for a local secondary index, which consists of one or more
|
|
585
640
|
* pairs of attribute names and key types:</p>
|
|
586
641
|
* <ul>
|
|
@@ -606,6 +661,7 @@ export interface LocalSecondaryIndexInfo {
|
|
|
606
661
|
*/
|
|
607
662
|
KeySchema?: KeySchemaElement[];
|
|
608
663
|
/**
|
|
664
|
+
* @public
|
|
609
665
|
* <p>Represents attributes that are copied (projected) from the table into the global
|
|
610
666
|
* secondary index. These are in addition to the primary key attributes and index key
|
|
611
667
|
* attributes, which are automatically projected. </p>
|
|
@@ -645,6 +701,7 @@ export type SSEStatus = (typeof SSEStatus)[keyof typeof SSEStatus];
|
|
|
645
701
|
*/
|
|
646
702
|
export interface SSEDescription {
|
|
647
703
|
/**
|
|
704
|
+
* @public
|
|
648
705
|
* <p>Represents the current state of server-side encryption. The only supported values
|
|
649
706
|
* are:</p>
|
|
650
707
|
* <ul>
|
|
@@ -660,6 +717,7 @@ export interface SSEDescription {
|
|
|
660
717
|
*/
|
|
661
718
|
Status?: SSEStatus | string;
|
|
662
719
|
/**
|
|
720
|
+
* @public
|
|
663
721
|
* <p>Server-side encryption type. The only supported value is:</p>
|
|
664
722
|
* <ul>
|
|
665
723
|
* <li>
|
|
@@ -671,10 +729,12 @@ export interface SSEDescription {
|
|
|
671
729
|
*/
|
|
672
730
|
SSEType?: SSEType | string;
|
|
673
731
|
/**
|
|
732
|
+
* @public
|
|
674
733
|
* <p>The KMS key ARN used for the KMS encryption.</p>
|
|
675
734
|
*/
|
|
676
735
|
KMSMasterKeyArn?: string;
|
|
677
736
|
/**
|
|
737
|
+
* @public
|
|
678
738
|
* <p>Indicates the time, in UNIX epoch date format, when DynamoDB detected that
|
|
679
739
|
* the table's KMS key was inaccessible. This attribute will automatically
|
|
680
740
|
* be cleared when DynamoDB detects that the table's KMS key is accessible
|
|
@@ -702,11 +762,13 @@ export type StreamViewType = (typeof StreamViewType)[keyof typeof StreamViewType
|
|
|
702
762
|
*/
|
|
703
763
|
export interface StreamSpecification {
|
|
704
764
|
/**
|
|
765
|
+
* @public
|
|
705
766
|
* <p>Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the
|
|
706
767
|
* table.</p>
|
|
707
768
|
*/
|
|
708
769
|
StreamEnabled: boolean | undefined;
|
|
709
770
|
/**
|
|
771
|
+
* @public
|
|
710
772
|
* <p> When an item in the table is modified, <code>StreamViewType</code> determines what
|
|
711
773
|
* information is written to the stream for this table. Valid values for
|
|
712
774
|
* <code>StreamViewType</code> are:</p>
|
|
@@ -755,10 +817,12 @@ export type TimeToLiveStatus = (typeof TimeToLiveStatus)[keyof typeof TimeToLive
|
|
|
755
817
|
*/
|
|
756
818
|
export interface TimeToLiveDescription {
|
|
757
819
|
/**
|
|
820
|
+
* @public
|
|
758
821
|
* <p> The TTL status for the table.</p>
|
|
759
822
|
*/
|
|
760
823
|
TimeToLiveStatus?: TimeToLiveStatus | string;
|
|
761
824
|
/**
|
|
825
|
+
* @public
|
|
762
826
|
* <p> The name of the TTL attribute for items in the table.</p>
|
|
763
827
|
*/
|
|
764
828
|
AttributeName?: string;
|
|
@@ -770,26 +834,31 @@ export interface TimeToLiveDescription {
|
|
|
770
834
|
*/
|
|
771
835
|
export interface SourceTableFeatureDetails {
|
|
772
836
|
/**
|
|
837
|
+
* @public
|
|
773
838
|
* <p>Represents the LSI properties for the table when the backup was created. It includes
|
|
774
839
|
* the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
|
|
775
840
|
* </p>
|
|
776
841
|
*/
|
|
777
842
|
LocalSecondaryIndexes?: LocalSecondaryIndexInfo[];
|
|
778
843
|
/**
|
|
844
|
+
* @public
|
|
779
845
|
* <p>Represents the GSI properties for the table when the backup was created. It includes
|
|
780
846
|
* the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the
|
|
781
847
|
* table at the time of backup. </p>
|
|
782
848
|
*/
|
|
783
849
|
GlobalSecondaryIndexes?: GlobalSecondaryIndexInfo[];
|
|
784
850
|
/**
|
|
851
|
+
* @public
|
|
785
852
|
* <p>Stream settings on the table when the backup was created.</p>
|
|
786
853
|
*/
|
|
787
854
|
StreamDescription?: StreamSpecification;
|
|
788
855
|
/**
|
|
856
|
+
* @public
|
|
789
857
|
* <p>Time to Live settings on the table when the backup was created.</p>
|
|
790
858
|
*/
|
|
791
859
|
TimeToLiveDescription?: TimeToLiveDescription;
|
|
792
860
|
/**
|
|
861
|
+
* @public
|
|
793
862
|
* <p>The description of the server-side encryption status on the table when the backup was
|
|
794
863
|
* created.</p>
|
|
795
864
|
*/
|
|
@@ -801,14 +870,17 @@ export interface SourceTableFeatureDetails {
|
|
|
801
870
|
*/
|
|
802
871
|
export interface BackupDescription {
|
|
803
872
|
/**
|
|
873
|
+
* @public
|
|
804
874
|
* <p>Contains the details of the backup created for the table. </p>
|
|
805
875
|
*/
|
|
806
876
|
BackupDetails?: BackupDetails;
|
|
807
877
|
/**
|
|
878
|
+
* @public
|
|
808
879
|
* <p>Contains the details of the table when the backup was created. </p>
|
|
809
880
|
*/
|
|
810
881
|
SourceTableDetails?: SourceTableDetails;
|
|
811
882
|
/**
|
|
883
|
+
* @public
|
|
812
884
|
* <p>Contains the details of the features enabled on the table when the backup was created.
|
|
813
885
|
* For example, LSIs, GSIs, streams, TTL.</p>
|
|
814
886
|
*/
|
|
@@ -845,40 +917,49 @@ export declare class BackupNotFoundException extends __BaseException {
|
|
|
845
917
|
*/
|
|
846
918
|
export interface BackupSummary {
|
|
847
919
|
/**
|
|
920
|
+
* @public
|
|
848
921
|
* <p>Name of the table.</p>
|
|
849
922
|
*/
|
|
850
923
|
TableName?: string;
|
|
851
924
|
/**
|
|
925
|
+
* @public
|
|
852
926
|
* <p>Unique identifier for the table.</p>
|
|
853
927
|
*/
|
|
854
928
|
TableId?: string;
|
|
855
929
|
/**
|
|
930
|
+
* @public
|
|
856
931
|
* <p>ARN associated with the table.</p>
|
|
857
932
|
*/
|
|
858
933
|
TableArn?: string;
|
|
859
934
|
/**
|
|
935
|
+
* @public
|
|
860
936
|
* <p>ARN associated with the backup.</p>
|
|
861
937
|
*/
|
|
862
938
|
BackupArn?: string;
|
|
863
939
|
/**
|
|
940
|
+
* @public
|
|
864
941
|
* <p>Name of the specified backup.</p>
|
|
865
942
|
*/
|
|
866
943
|
BackupName?: string;
|
|
867
944
|
/**
|
|
945
|
+
* @public
|
|
868
946
|
* <p>Time at which the backup was created.</p>
|
|
869
947
|
*/
|
|
870
948
|
BackupCreationDateTime?: Date;
|
|
871
949
|
/**
|
|
950
|
+
* @public
|
|
872
951
|
* <p>Time at which the automatic on-demand backup created by DynamoDB will
|
|
873
952
|
* expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after
|
|
874
953
|
* its creation.</p>
|
|
875
954
|
*/
|
|
876
955
|
BackupExpiryDateTime?: Date;
|
|
877
956
|
/**
|
|
957
|
+
* @public
|
|
878
958
|
* <p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED.</p>
|
|
879
959
|
*/
|
|
880
960
|
BackupStatus?: BackupStatus | string;
|
|
881
961
|
/**
|
|
962
|
+
* @public
|
|
882
963
|
* <p>BackupType:</p>
|
|
883
964
|
* <ul>
|
|
884
965
|
* <li>
|
|
@@ -901,6 +982,7 @@ export interface BackupSummary {
|
|
|
901
982
|
*/
|
|
902
983
|
BackupType?: BackupType | string;
|
|
903
984
|
/**
|
|
985
|
+
* @public
|
|
904
986
|
* <p>Size of the backup in bytes.</p>
|
|
905
987
|
*/
|
|
906
988
|
BackupSizeBytes?: number;
|
|
@@ -951,14 +1033,17 @@ export type ReturnValuesOnConditionCheckFailure = (typeof ReturnValuesOnConditio
|
|
|
951
1033
|
*/
|
|
952
1034
|
export interface Capacity {
|
|
953
1035
|
/**
|
|
1036
|
+
* @public
|
|
954
1037
|
* <p>The total number of read capacity units consumed on a table or an index.</p>
|
|
955
1038
|
*/
|
|
956
1039
|
ReadCapacityUnits?: number;
|
|
957
1040
|
/**
|
|
1041
|
+
* @public
|
|
958
1042
|
* <p>The total number of write capacity units consumed on a table or an index.</p>
|
|
959
1043
|
*/
|
|
960
1044
|
WriteCapacityUnits?: number;
|
|
961
1045
|
/**
|
|
1046
|
+
* @public
|
|
962
1047
|
* <p>The total number of capacity units consumed on a table or an index.</p>
|
|
963
1048
|
*/
|
|
964
1049
|
CapacityUnits?: number;
|
|
@@ -973,31 +1058,38 @@ export interface Capacity {
|
|
|
973
1058
|
*/
|
|
974
1059
|
export interface ConsumedCapacity {
|
|
975
1060
|
/**
|
|
1061
|
+
* @public
|
|
976
1062
|
* <p>The name of the table that was affected by the operation.</p>
|
|
977
1063
|
*/
|
|
978
1064
|
TableName?: string;
|
|
979
1065
|
/**
|
|
1066
|
+
* @public
|
|
980
1067
|
* <p>The total number of capacity units consumed by the operation.</p>
|
|
981
1068
|
*/
|
|
982
1069
|
CapacityUnits?: number;
|
|
983
1070
|
/**
|
|
1071
|
+
* @public
|
|
984
1072
|
* <p>The total number of read capacity units consumed by the operation.</p>
|
|
985
1073
|
*/
|
|
986
1074
|
ReadCapacityUnits?: number;
|
|
987
1075
|
/**
|
|
1076
|
+
* @public
|
|
988
1077
|
* <p>The total number of write capacity units consumed by the operation.</p>
|
|
989
1078
|
*/
|
|
990
1079
|
WriteCapacityUnits?: number;
|
|
991
1080
|
/**
|
|
1081
|
+
* @public
|
|
992
1082
|
* <p>The amount of throughput consumed on the table affected by the operation.</p>
|
|
993
1083
|
*/
|
|
994
1084
|
Table?: Capacity;
|
|
995
1085
|
/**
|
|
1086
|
+
* @public
|
|
996
1087
|
* <p>The amount of throughput consumed on each local index affected by the
|
|
997
1088
|
* operation.</p>
|
|
998
1089
|
*/
|
|
999
1090
|
LocalSecondaryIndexes?: Record<string, Capacity>;
|
|
1000
1091
|
/**
|
|
1092
|
+
* @public
|
|
1001
1093
|
* <p>The amount of throughput consumed on each global index affected by the
|
|
1002
1094
|
* operation.</p>
|
|
1003
1095
|
*/
|
|
@@ -1127,6 +1219,7 @@ export declare class ItemCollectionSizeLimitExceededException extends __BaseExce
|
|
|
1127
1219
|
*/
|
|
1128
1220
|
export interface BillingModeSummary {
|
|
1129
1221
|
/**
|
|
1222
|
+
* @public
|
|
1130
1223
|
* <p>Controls how you are charged for read and write throughput and how you manage
|
|
1131
1224
|
* capacity. This setting can be changed later.</p>
|
|
1132
1225
|
* <ul>
|
|
@@ -1146,6 +1239,7 @@ export interface BillingModeSummary {
|
|
|
1146
1239
|
*/
|
|
1147
1240
|
BillingMode?: BillingMode | string;
|
|
1148
1241
|
/**
|
|
1242
|
+
* @public
|
|
1149
1243
|
* <p>Represents the time when <code>PAY_PER_REQUEST</code> was last set as the read/write
|
|
1150
1244
|
* capacity mode.</p>
|
|
1151
1245
|
*/
|
|
@@ -1216,6 +1310,7 @@ export type PointInTimeRecoveryStatus = (typeof PointInTimeRecoveryStatus)[keyof
|
|
|
1216
1310
|
*/
|
|
1217
1311
|
export interface PointInTimeRecoveryDescription {
|
|
1218
1312
|
/**
|
|
1313
|
+
* @public
|
|
1219
1314
|
* <p>The current state of point in time recovery:</p>
|
|
1220
1315
|
* <ul>
|
|
1221
1316
|
* <li>
|
|
@@ -1230,11 +1325,13 @@ export interface PointInTimeRecoveryDescription {
|
|
|
1230
1325
|
*/
|
|
1231
1326
|
PointInTimeRecoveryStatus?: PointInTimeRecoveryStatus | string;
|
|
1232
1327
|
/**
|
|
1328
|
+
* @public
|
|
1233
1329
|
* <p>Specifies the earliest point in time you can restore your table to. You can restore
|
|
1234
1330
|
* your table to any point in time during the last 35 days. </p>
|
|
1235
1331
|
*/
|
|
1236
1332
|
EarliestRestorableDateTime?: Date;
|
|
1237
1333
|
/**
|
|
1334
|
+
* @public
|
|
1238
1335
|
* <p>
|
|
1239
1336
|
* <code>LatestRestorableDateTime</code> is typically 5 minutes before the current time.
|
|
1240
1337
|
* </p>
|
|
@@ -1248,12 +1345,14 @@ export interface PointInTimeRecoveryDescription {
|
|
|
1248
1345
|
*/
|
|
1249
1346
|
export interface ContinuousBackupsDescription {
|
|
1250
1347
|
/**
|
|
1348
|
+
* @public
|
|
1251
1349
|
* <p>
|
|
1252
1350
|
* <code>ContinuousBackupsStatus</code> can be one of the following states: ENABLED,
|
|
1253
1351
|
* DISABLED</p>
|
|
1254
1352
|
*/
|
|
1255
1353
|
ContinuousBackupsStatus: ContinuousBackupsStatus | string | undefined;
|
|
1256
1354
|
/**
|
|
1355
|
+
* @public
|
|
1257
1356
|
* <p>The description of the point in time recovery settings applied to the table.</p>
|
|
1258
1357
|
*/
|
|
1259
1358
|
PointInTimeRecoveryDescription?: PointInTimeRecoveryDescription;
|
|
@@ -1303,14 +1402,17 @@ export type ContributorInsightsStatus = (typeof ContributorInsightsStatus)[keyof
|
|
|
1303
1402
|
*/
|
|
1304
1403
|
export interface ContributorInsightsSummary {
|
|
1305
1404
|
/**
|
|
1405
|
+
* @public
|
|
1306
1406
|
* <p>Name of the table associated with the summary.</p>
|
|
1307
1407
|
*/
|
|
1308
1408
|
TableName?: string;
|
|
1309
1409
|
/**
|
|
1410
|
+
* @public
|
|
1310
1411
|
* <p>Name of the index associated with the summary, if any.</p>
|
|
1311
1412
|
*/
|
|
1312
1413
|
IndexName?: string;
|
|
1313
1414
|
/**
|
|
1415
|
+
* @public
|
|
1314
1416
|
* <p>Describes the current status for contributor insights for the given table and index,
|
|
1315
1417
|
* if applicable.</p>
|
|
1316
1418
|
*/
|
|
@@ -1321,10 +1423,12 @@ export interface ContributorInsightsSummary {
|
|
|
1321
1423
|
*/
|
|
1322
1424
|
export interface CreateBackupInput {
|
|
1323
1425
|
/**
|
|
1426
|
+
* @public
|
|
1324
1427
|
* <p>The name of the table.</p>
|
|
1325
1428
|
*/
|
|
1326
1429
|
TableName: string | undefined;
|
|
1327
1430
|
/**
|
|
1431
|
+
* @public
|
|
1328
1432
|
* <p>Specified name for the backup.</p>
|
|
1329
1433
|
*/
|
|
1330
1434
|
BackupName: string | undefined;
|
|
@@ -1334,6 +1438,7 @@ export interface CreateBackupInput {
|
|
|
1334
1438
|
*/
|
|
1335
1439
|
export interface CreateBackupOutput {
|
|
1336
1440
|
/**
|
|
1441
|
+
* @public
|
|
1337
1442
|
* <p>Contains the details of the backup created for the table.</p>
|
|
1338
1443
|
*/
|
|
1339
1444
|
BackupDetails?: BackupDetails;
|
|
@@ -1395,20 +1500,24 @@ export declare class TableNotFoundException extends __BaseException {
|
|
|
1395
1500
|
*/
|
|
1396
1501
|
export interface CreateGlobalSecondaryIndexAction {
|
|
1397
1502
|
/**
|
|
1503
|
+
* @public
|
|
1398
1504
|
* <p>The name of the global secondary index to be created.</p>
|
|
1399
1505
|
*/
|
|
1400
1506
|
IndexName: string | undefined;
|
|
1401
1507
|
/**
|
|
1508
|
+
* @public
|
|
1402
1509
|
* <p>The key schema for the global secondary index.</p>
|
|
1403
1510
|
*/
|
|
1404
1511
|
KeySchema: KeySchemaElement[] | undefined;
|
|
1405
1512
|
/**
|
|
1513
|
+
* @public
|
|
1406
1514
|
* <p>Represents attributes that are copied (projected) from the table into an index. These
|
|
1407
1515
|
* are in addition to the primary key attributes and index key attributes, which are
|
|
1408
1516
|
* automatically projected.</p>
|
|
1409
1517
|
*/
|
|
1410
1518
|
Projection: Projection | undefined;
|
|
1411
1519
|
/**
|
|
1520
|
+
* @public
|
|
1412
1521
|
* <p>Represents the provisioned throughput settings for the specified global secondary
|
|
1413
1522
|
* index.</p>
|
|
1414
1523
|
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
@@ -1423,6 +1532,7 @@ export interface CreateGlobalSecondaryIndexAction {
|
|
|
1423
1532
|
*/
|
|
1424
1533
|
export interface Replica {
|
|
1425
1534
|
/**
|
|
1535
|
+
* @public
|
|
1426
1536
|
* <p>The Region where the replica needs to be created.</p>
|
|
1427
1537
|
*/
|
|
1428
1538
|
RegionName?: string;
|
|
@@ -1432,10 +1542,12 @@ export interface Replica {
|
|
|
1432
1542
|
*/
|
|
1433
1543
|
export interface CreateGlobalTableInput {
|
|
1434
1544
|
/**
|
|
1545
|
+
* @public
|
|
1435
1546
|
* <p>The global table name.</p>
|
|
1436
1547
|
*/
|
|
1437
1548
|
GlobalTableName: string | undefined;
|
|
1438
1549
|
/**
|
|
1550
|
+
* @public
|
|
1439
1551
|
* <p>The Regions where the global table needs to be created.</p>
|
|
1440
1552
|
*/
|
|
1441
1553
|
ReplicationGroup: Replica[] | undefined;
|
|
@@ -1461,6 +1573,7 @@ export type GlobalTableStatus = (typeof GlobalTableStatus)[keyof typeof GlobalTa
|
|
|
1461
1573
|
*/
|
|
1462
1574
|
export interface ProvisionedThroughputOverride {
|
|
1463
1575
|
/**
|
|
1576
|
+
* @public
|
|
1464
1577
|
* <p>Replica-specific read capacity units. If not specified, uses the source table's read
|
|
1465
1578
|
* capacity settings.</p>
|
|
1466
1579
|
*/
|
|
@@ -1472,10 +1585,12 @@ export interface ProvisionedThroughputOverride {
|
|
|
1472
1585
|
*/
|
|
1473
1586
|
export interface ReplicaGlobalSecondaryIndexDescription {
|
|
1474
1587
|
/**
|
|
1588
|
+
* @public
|
|
1475
1589
|
* <p>The name of the global secondary index.</p>
|
|
1476
1590
|
*/
|
|
1477
1591
|
IndexName?: string;
|
|
1478
1592
|
/**
|
|
1593
|
+
* @public
|
|
1479
1594
|
* <p>If not described, uses the source table GSI's read capacity settings.</p>
|
|
1480
1595
|
*/
|
|
1481
1596
|
ProvisionedThroughputOverride?: ProvisionedThroughputOverride;
|
|
@@ -1515,11 +1630,13 @@ export type TableClass = (typeof TableClass)[keyof typeof TableClass];
|
|
|
1515
1630
|
*/
|
|
1516
1631
|
export interface TableClassSummary {
|
|
1517
1632
|
/**
|
|
1633
|
+
* @public
|
|
1518
1634
|
* <p>The table class of the specified table. Valid values are <code>STANDARD</code> and
|
|
1519
1635
|
* <code>STANDARD_INFREQUENT_ACCESS</code>.</p>
|
|
1520
1636
|
*/
|
|
1521
1637
|
TableClass?: TableClass | string;
|
|
1522
1638
|
/**
|
|
1639
|
+
* @public
|
|
1523
1640
|
* <p>The date and time at which the table class was last updated.</p>
|
|
1524
1641
|
*/
|
|
1525
1642
|
LastUpdateDateTime?: Date;
|
|
@@ -1530,10 +1647,12 @@ export interface TableClassSummary {
|
|
|
1530
1647
|
*/
|
|
1531
1648
|
export interface ReplicaDescription {
|
|
1532
1649
|
/**
|
|
1650
|
+
* @public
|
|
1533
1651
|
* <p>The name of the Region.</p>
|
|
1534
1652
|
*/
|
|
1535
1653
|
RegionName?: string;
|
|
1536
1654
|
/**
|
|
1655
|
+
* @public
|
|
1537
1656
|
* <p>The current state of the replica:</p>
|
|
1538
1657
|
* <ul>
|
|
1539
1658
|
* <li>
|
|
@@ -1577,34 +1696,41 @@ export interface ReplicaDescription {
|
|
|
1577
1696
|
*/
|
|
1578
1697
|
ReplicaStatus?: ReplicaStatus | string;
|
|
1579
1698
|
/**
|
|
1699
|
+
* @public
|
|
1580
1700
|
* <p>Detailed information about the replica status.</p>
|
|
1581
1701
|
*/
|
|
1582
1702
|
ReplicaStatusDescription?: string;
|
|
1583
1703
|
/**
|
|
1704
|
+
* @public
|
|
1584
1705
|
* <p>Specifies the progress of a Create, Update, or Delete action on the replica as a
|
|
1585
1706
|
* percentage.</p>
|
|
1586
1707
|
*/
|
|
1587
1708
|
ReplicaStatusPercentProgress?: string;
|
|
1588
1709
|
/**
|
|
1710
|
+
* @public
|
|
1589
1711
|
* <p>The KMS key of the replica that will be used for KMS
|
|
1590
1712
|
* encryption.</p>
|
|
1591
1713
|
*/
|
|
1592
1714
|
KMSMasterKeyId?: string;
|
|
1593
1715
|
/**
|
|
1716
|
+
* @public
|
|
1594
1717
|
* <p>Replica-specific provisioned throughput. If not described, uses the source table's
|
|
1595
1718
|
* provisioned throughput settings.</p>
|
|
1596
1719
|
*/
|
|
1597
1720
|
ProvisionedThroughputOverride?: ProvisionedThroughputOverride;
|
|
1598
1721
|
/**
|
|
1722
|
+
* @public
|
|
1599
1723
|
* <p>Replica-specific global secondary index settings.</p>
|
|
1600
1724
|
*/
|
|
1601
1725
|
GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndexDescription[];
|
|
1602
1726
|
/**
|
|
1727
|
+
* @public
|
|
1603
1728
|
* <p>The time at which the replica was first detected as inaccessible. To determine cause
|
|
1604
1729
|
* of inaccessibility check the <code>ReplicaStatus</code> property.</p>
|
|
1605
1730
|
*/
|
|
1606
1731
|
ReplicaInaccessibleDateTime?: Date;
|
|
1607
1732
|
/**
|
|
1733
|
+
* @public
|
|
1608
1734
|
* <p>Contains details of the table class.</p>
|
|
1609
1735
|
*/
|
|
1610
1736
|
ReplicaTableClassSummary?: TableClassSummary;
|
|
@@ -1615,18 +1741,22 @@ export interface ReplicaDescription {
|
|
|
1615
1741
|
*/
|
|
1616
1742
|
export interface GlobalTableDescription {
|
|
1617
1743
|
/**
|
|
1744
|
+
* @public
|
|
1618
1745
|
* <p>The Regions where the global table has replicas.</p>
|
|
1619
1746
|
*/
|
|
1620
1747
|
ReplicationGroup?: ReplicaDescription[];
|
|
1621
1748
|
/**
|
|
1749
|
+
* @public
|
|
1622
1750
|
* <p>The unique identifier of the global table.</p>
|
|
1623
1751
|
*/
|
|
1624
1752
|
GlobalTableArn?: string;
|
|
1625
1753
|
/**
|
|
1754
|
+
* @public
|
|
1626
1755
|
* <p>The creation time of the global table.</p>
|
|
1627
1756
|
*/
|
|
1628
1757
|
CreationDateTime?: Date;
|
|
1629
1758
|
/**
|
|
1759
|
+
* @public
|
|
1630
1760
|
* <p>The current state of the global table:</p>
|
|
1631
1761
|
* <ul>
|
|
1632
1762
|
* <li>
|
|
@@ -1649,6 +1779,7 @@ export interface GlobalTableDescription {
|
|
|
1649
1779
|
*/
|
|
1650
1780
|
GlobalTableStatus?: GlobalTableStatus | string;
|
|
1651
1781
|
/**
|
|
1782
|
+
* @public
|
|
1652
1783
|
* <p>The global table name.</p>
|
|
1653
1784
|
*/
|
|
1654
1785
|
GlobalTableName?: string;
|
|
@@ -1658,6 +1789,7 @@ export interface GlobalTableDescription {
|
|
|
1658
1789
|
*/
|
|
1659
1790
|
export interface CreateGlobalTableOutput {
|
|
1660
1791
|
/**
|
|
1792
|
+
* @public
|
|
1661
1793
|
* <p>Contains the details of the global table.</p>
|
|
1662
1794
|
*/
|
|
1663
1795
|
GlobalTableDescription?: GlobalTableDescription;
|
|
@@ -1680,6 +1812,7 @@ export declare class GlobalTableAlreadyExistsException extends __BaseException {
|
|
|
1680
1812
|
*/
|
|
1681
1813
|
export interface CreateReplicaAction {
|
|
1682
1814
|
/**
|
|
1815
|
+
* @public
|
|
1683
1816
|
* <p>The Region of the replica to be added.</p>
|
|
1684
1817
|
*/
|
|
1685
1818
|
RegionName: string | undefined;
|
|
@@ -1690,10 +1823,12 @@ export interface CreateReplicaAction {
|
|
|
1690
1823
|
*/
|
|
1691
1824
|
export interface ReplicaGlobalSecondaryIndex {
|
|
1692
1825
|
/**
|
|
1826
|
+
* @public
|
|
1693
1827
|
* <p>The name of the global secondary index.</p>
|
|
1694
1828
|
*/
|
|
1695
1829
|
IndexName: string | undefined;
|
|
1696
1830
|
/**
|
|
1831
|
+
* @public
|
|
1697
1832
|
* <p>Replica table GSI-specific provisioned throughput. If not specified, uses the source
|
|
1698
1833
|
* table GSI's read capacity settings.</p>
|
|
1699
1834
|
*/
|
|
@@ -1705,10 +1840,12 @@ export interface ReplicaGlobalSecondaryIndex {
|
|
|
1705
1840
|
*/
|
|
1706
1841
|
export interface CreateReplicationGroupMemberAction {
|
|
1707
1842
|
/**
|
|
1843
|
+
* @public
|
|
1708
1844
|
* <p>The Region where the new replica will be created.</p>
|
|
1709
1845
|
*/
|
|
1710
1846
|
RegionName: string | undefined;
|
|
1711
1847
|
/**
|
|
1848
|
+
* @public
|
|
1712
1849
|
* <p>The KMS key that should be used for KMS encryption in
|
|
1713
1850
|
* the new replica. To specify a key, use its key ID, Amazon Resource Name (ARN), alias
|
|
1714
1851
|
* name, or alias ARN. Note that you should only provide this parameter if the key is
|
|
@@ -1717,15 +1854,18 @@ export interface CreateReplicationGroupMemberAction {
|
|
|
1717
1854
|
*/
|
|
1718
1855
|
KMSMasterKeyId?: string;
|
|
1719
1856
|
/**
|
|
1857
|
+
* @public
|
|
1720
1858
|
* <p>Replica-specific provisioned throughput. If not specified, uses the source table's
|
|
1721
1859
|
* provisioned throughput settings.</p>
|
|
1722
1860
|
*/
|
|
1723
1861
|
ProvisionedThroughputOverride?: ProvisionedThroughputOverride;
|
|
1724
1862
|
/**
|
|
1863
|
+
* @public
|
|
1725
1864
|
* <p>Replica-specific global secondary index settings.</p>
|
|
1726
1865
|
*/
|
|
1727
1866
|
GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndex[];
|
|
1728
1867
|
/**
|
|
1868
|
+
* @public
|
|
1729
1869
|
* <p>Replica-specific table class. If not specified, uses the source table's table
|
|
1730
1870
|
* class.</p>
|
|
1731
1871
|
*/
|
|
@@ -1737,11 +1877,13 @@ export interface CreateReplicationGroupMemberAction {
|
|
|
1737
1877
|
*/
|
|
1738
1878
|
export interface GlobalSecondaryIndex {
|
|
1739
1879
|
/**
|
|
1880
|
+
* @public
|
|
1740
1881
|
* <p>The name of the global secondary index. The name must be unique among all other
|
|
1741
1882
|
* indexes on this table.</p>
|
|
1742
1883
|
*/
|
|
1743
1884
|
IndexName: string | undefined;
|
|
1744
1885
|
/**
|
|
1886
|
+
* @public
|
|
1745
1887
|
* <p>The complete key schema for a global secondary index, which consists of one or more
|
|
1746
1888
|
* pairs of attribute names and key types:</p>
|
|
1747
1889
|
* <ul>
|
|
@@ -1767,12 +1909,14 @@ export interface GlobalSecondaryIndex {
|
|
|
1767
1909
|
*/
|
|
1768
1910
|
KeySchema: KeySchemaElement[] | undefined;
|
|
1769
1911
|
/**
|
|
1912
|
+
* @public
|
|
1770
1913
|
* <p>Represents attributes that are copied (projected) from the table into the global
|
|
1771
1914
|
* secondary index. These are in addition to the primary key attributes and index key
|
|
1772
1915
|
* attributes, which are automatically projected. </p>
|
|
1773
1916
|
*/
|
|
1774
1917
|
Projection: Projection | undefined;
|
|
1775
1918
|
/**
|
|
1919
|
+
* @public
|
|
1776
1920
|
* <p>Represents the provisioned throughput settings for the specified global secondary
|
|
1777
1921
|
* index.</p>
|
|
1778
1922
|
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
@@ -1787,11 +1931,13 @@ export interface GlobalSecondaryIndex {
|
|
|
1787
1931
|
*/
|
|
1788
1932
|
export interface LocalSecondaryIndex {
|
|
1789
1933
|
/**
|
|
1934
|
+
* @public
|
|
1790
1935
|
* <p>The name of the local secondary index. The name must be unique among all other indexes
|
|
1791
1936
|
* on this table.</p>
|
|
1792
1937
|
*/
|
|
1793
1938
|
IndexName: string | undefined;
|
|
1794
1939
|
/**
|
|
1940
|
+
* @public
|
|
1795
1941
|
* <p>The complete key schema for the local secondary index, consisting of one or more pairs
|
|
1796
1942
|
* of attribute names and key types:</p>
|
|
1797
1943
|
* <ul>
|
|
@@ -1817,6 +1963,7 @@ export interface LocalSecondaryIndex {
|
|
|
1817
1963
|
*/
|
|
1818
1964
|
KeySchema: KeySchemaElement[] | undefined;
|
|
1819
1965
|
/**
|
|
1966
|
+
* @public
|
|
1820
1967
|
* <p>Represents attributes that are copied (projected) from the table into the local
|
|
1821
1968
|
* secondary index. These are in addition to the primary key attributes and index key
|
|
1822
1969
|
* attributes, which are automatically projected. </p>
|
|
@@ -1829,6 +1976,7 @@ export interface LocalSecondaryIndex {
|
|
|
1829
1976
|
*/
|
|
1830
1977
|
export interface SSESpecification {
|
|
1831
1978
|
/**
|
|
1979
|
+
* @public
|
|
1832
1980
|
* <p>Indicates whether server-side encryption is done using an Amazon Web Services managed
|
|
1833
1981
|
* key or an Amazon Web Services owned key. If enabled (true), server-side encryption type
|
|
1834
1982
|
* is set to <code>KMS</code> and an Amazon Web Services managed key is used (KMS charges apply). If disabled (false) or not specified, server-side
|
|
@@ -1836,6 +1984,7 @@ export interface SSESpecification {
|
|
|
1836
1984
|
*/
|
|
1837
1985
|
Enabled?: boolean;
|
|
1838
1986
|
/**
|
|
1987
|
+
* @public
|
|
1839
1988
|
* <p>Server-side encryption type. The only supported value is:</p>
|
|
1840
1989
|
* <ul>
|
|
1841
1990
|
* <li>
|
|
@@ -1847,6 +1996,7 @@ export interface SSESpecification {
|
|
|
1847
1996
|
*/
|
|
1848
1997
|
SSEType?: SSEType | string;
|
|
1849
1998
|
/**
|
|
1999
|
+
* @public
|
|
1850
2000
|
* <p>The KMS key that should be used for the KMS encryption.
|
|
1851
2001
|
* To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN.
|
|
1852
2002
|
* Note that you should only provide this parameter if the key is different from the
|
|
@@ -1869,12 +2019,14 @@ export interface SSESpecification {
|
|
|
1869
2019
|
*/
|
|
1870
2020
|
export interface Tag {
|
|
1871
2021
|
/**
|
|
2022
|
+
* @public
|
|
1872
2023
|
* <p>The key of the tag. Tag keys are case sensitive. Each DynamoDB table can
|
|
1873
2024
|
* only have up to one tag with the same key. If you try to add an existing tag (same key),
|
|
1874
2025
|
* the existing tag value will be updated to the new value.</p>
|
|
1875
2026
|
*/
|
|
1876
2027
|
Key: string | undefined;
|
|
1877
2028
|
/**
|
|
2029
|
+
* @public
|
|
1878
2030
|
* <p>The value of the tag. Tag values are case-sensitive and can be null.</p>
|
|
1879
2031
|
*/
|
|
1880
2032
|
Value: string | undefined;
|
|
@@ -1885,14 +2037,17 @@ export interface Tag {
|
|
|
1885
2037
|
*/
|
|
1886
2038
|
export interface CreateTableInput {
|
|
1887
2039
|
/**
|
|
2040
|
+
* @public
|
|
1888
2041
|
* <p>An array of attributes that describe the key schema for the table and indexes.</p>
|
|
1889
2042
|
*/
|
|
1890
2043
|
AttributeDefinitions: AttributeDefinition[] | undefined;
|
|
1891
2044
|
/**
|
|
2045
|
+
* @public
|
|
1892
2046
|
* <p>The name of the table to create.</p>
|
|
1893
2047
|
*/
|
|
1894
2048
|
TableName: string | undefined;
|
|
1895
2049
|
/**
|
|
2050
|
+
* @public
|
|
1896
2051
|
* <p>Specifies the attributes that make up the primary key for a table or an index. The
|
|
1897
2052
|
* attributes in <code>KeySchema</code> must also be defined in the
|
|
1898
2053
|
* <code>AttributeDefinitions</code> array. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DataModel.html">Data
|
|
@@ -1939,6 +2094,7 @@ export interface CreateTableInput {
|
|
|
1939
2094
|
*/
|
|
1940
2095
|
KeySchema: KeySchemaElement[] | undefined;
|
|
1941
2096
|
/**
|
|
2097
|
+
* @public
|
|
1942
2098
|
* <p>One or more local secondary indexes (the maximum is 5) to be created on the table.
|
|
1943
2099
|
* Each index is scoped to a given partition key value. There is a 10 GB size limit per
|
|
1944
2100
|
* partition key value; otherwise, the size of a local secondary index is
|
|
@@ -2000,6 +2156,7 @@ export interface CreateTableInput {
|
|
|
2000
2156
|
*/
|
|
2001
2157
|
LocalSecondaryIndexes?: LocalSecondaryIndex[];
|
|
2002
2158
|
/**
|
|
2159
|
+
* @public
|
|
2003
2160
|
* <p>One or more global secondary indexes (the maximum is 20) to be created on the table.
|
|
2004
2161
|
* Each global secondary index in the array includes the following:</p>
|
|
2005
2162
|
* <ul>
|
|
@@ -2063,6 +2220,7 @@ export interface CreateTableInput {
|
|
|
2063
2220
|
*/
|
|
2064
2221
|
GlobalSecondaryIndexes?: GlobalSecondaryIndex[];
|
|
2065
2222
|
/**
|
|
2223
|
+
* @public
|
|
2066
2224
|
* <p>Controls how you are charged for read and write throughput and how you manage
|
|
2067
2225
|
* capacity. This setting can be changed later.</p>
|
|
2068
2226
|
* <ul>
|
|
@@ -2081,6 +2239,7 @@ export interface CreateTableInput {
|
|
|
2081
2239
|
*/
|
|
2082
2240
|
BillingMode?: BillingMode | string;
|
|
2083
2241
|
/**
|
|
2242
|
+
* @public
|
|
2084
2243
|
* <p>Represents the provisioned throughput settings for a specified table or index. The
|
|
2085
2244
|
* settings can be modified using the <code>UpdateTable</code> operation.</p>
|
|
2086
2245
|
* <p> If you set BillingMode as <code>PROVISIONED</code>, you must specify this property.
|
|
@@ -2092,6 +2251,7 @@ export interface CreateTableInput {
|
|
|
2092
2251
|
*/
|
|
2093
2252
|
ProvisionedThroughput?: ProvisionedThroughput;
|
|
2094
2253
|
/**
|
|
2254
|
+
* @public
|
|
2095
2255
|
* <p>The settings for DynamoDB Streams on the table. These settings consist of:</p>
|
|
2096
2256
|
* <ul>
|
|
2097
2257
|
* <li>
|
|
@@ -2131,20 +2291,24 @@ export interface CreateTableInput {
|
|
|
2131
2291
|
*/
|
|
2132
2292
|
StreamSpecification?: StreamSpecification;
|
|
2133
2293
|
/**
|
|
2294
|
+
* @public
|
|
2134
2295
|
* <p>Represents the settings used to enable server-side encryption.</p>
|
|
2135
2296
|
*/
|
|
2136
2297
|
SSESpecification?: SSESpecification;
|
|
2137
2298
|
/**
|
|
2299
|
+
* @public
|
|
2138
2300
|
* <p>A list of key-value pairs to label the table. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Tagging.html">Tagging
|
|
2139
2301
|
* for DynamoDB</a>.</p>
|
|
2140
2302
|
*/
|
|
2141
2303
|
Tags?: Tag[];
|
|
2142
2304
|
/**
|
|
2305
|
+
* @public
|
|
2143
2306
|
* <p>The table class of the new table. Valid values are <code>STANDARD</code> and
|
|
2144
2307
|
* <code>STANDARD_INFREQUENT_ACCESS</code>.</p>
|
|
2145
2308
|
*/
|
|
2146
2309
|
TableClass?: TableClass | string;
|
|
2147
2310
|
/**
|
|
2311
|
+
* @public
|
|
2148
2312
|
* <p>Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.</p>
|
|
2149
2313
|
*/
|
|
2150
2314
|
DeletionProtectionEnabled?: boolean;
|
|
@@ -2170,14 +2334,17 @@ export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
|
2170
2334
|
*/
|
|
2171
2335
|
export interface ProvisionedThroughputDescription {
|
|
2172
2336
|
/**
|
|
2337
|
+
* @public
|
|
2173
2338
|
* <p>The date and time of the last provisioned throughput increase for this table.</p>
|
|
2174
2339
|
*/
|
|
2175
2340
|
LastIncreaseDateTime?: Date;
|
|
2176
2341
|
/**
|
|
2342
|
+
* @public
|
|
2177
2343
|
* <p>The date and time of the last provisioned throughput decrease for this table.</p>
|
|
2178
2344
|
*/
|
|
2179
2345
|
LastDecreaseDateTime?: Date;
|
|
2180
2346
|
/**
|
|
2347
|
+
* @public
|
|
2181
2348
|
* <p>The number of provisioned throughput decreases for this table during this UTC calendar
|
|
2182
2349
|
* day. For current maximums on provisioned throughput decreases, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
2183
2350
|
* Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer
|
|
@@ -2185,6 +2352,7 @@ export interface ProvisionedThroughputDescription {
|
|
|
2185
2352
|
*/
|
|
2186
2353
|
NumberOfDecreasesToday?: number;
|
|
2187
2354
|
/**
|
|
2355
|
+
* @public
|
|
2188
2356
|
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
|
|
2189
2357
|
* returns a <code>ThrottlingException</code>. Eventually consistent reads require less
|
|
2190
2358
|
* effort than strongly consistent reads, so a setting of 50 <code>ReadCapacityUnits</code>
|
|
@@ -2193,6 +2361,7 @@ export interface ProvisionedThroughputDescription {
|
|
|
2193
2361
|
*/
|
|
2194
2362
|
ReadCapacityUnits?: number;
|
|
2195
2363
|
/**
|
|
2364
|
+
* @public
|
|
2196
2365
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
2197
2366
|
* <code>ThrottlingException</code>.</p>
|
|
2198
2367
|
*/
|
|
@@ -2204,10 +2373,12 @@ export interface ProvisionedThroughputDescription {
|
|
|
2204
2373
|
*/
|
|
2205
2374
|
export interface GlobalSecondaryIndexDescription {
|
|
2206
2375
|
/**
|
|
2376
|
+
* @public
|
|
2207
2377
|
* <p>The name of the global secondary index.</p>
|
|
2208
2378
|
*/
|
|
2209
2379
|
IndexName?: string;
|
|
2210
2380
|
/**
|
|
2381
|
+
* @public
|
|
2211
2382
|
* <p>The complete key schema for a global secondary index, which consists of one or more
|
|
2212
2383
|
* pairs of attribute names and key types:</p>
|
|
2213
2384
|
* <ul>
|
|
@@ -2232,12 +2403,14 @@ export interface GlobalSecondaryIndexDescription {
|
|
|
2232
2403
|
*/
|
|
2233
2404
|
KeySchema?: KeySchemaElement[];
|
|
2234
2405
|
/**
|
|
2406
|
+
* @public
|
|
2235
2407
|
* <p>Represents attributes that are copied (projected) from the table into the global
|
|
2236
2408
|
* secondary index. These are in addition to the primary key attributes and index key
|
|
2237
2409
|
* attributes, which are automatically projected. </p>
|
|
2238
2410
|
*/
|
|
2239
2411
|
Projection?: Projection;
|
|
2240
2412
|
/**
|
|
2413
|
+
* @public
|
|
2241
2414
|
* <p>The current state of the global secondary index:</p>
|
|
2242
2415
|
* <ul>
|
|
2243
2416
|
* <li>
|
|
@@ -2260,6 +2433,7 @@ export interface GlobalSecondaryIndexDescription {
|
|
|
2260
2433
|
*/
|
|
2261
2434
|
IndexStatus?: IndexStatus | string;
|
|
2262
2435
|
/**
|
|
2436
|
+
* @public
|
|
2263
2437
|
* <p>Indicates whether the index is currently backfilling. <i>Backfilling</i>
|
|
2264
2438
|
* is the process of reading items from the table and determining whether they can be added
|
|
2265
2439
|
* to the index. (Not all items will qualify: For example, a partition key cannot have any
|
|
@@ -2278,6 +2452,7 @@ export interface GlobalSecondaryIndexDescription {
|
|
|
2278
2452
|
*/
|
|
2279
2453
|
Backfilling?: boolean;
|
|
2280
2454
|
/**
|
|
2455
|
+
* @public
|
|
2281
2456
|
* <p>Represents the provisioned throughput settings for the specified global secondary
|
|
2282
2457
|
* index.</p>
|
|
2283
2458
|
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
@@ -2286,17 +2461,20 @@ export interface GlobalSecondaryIndexDescription {
|
|
|
2286
2461
|
*/
|
|
2287
2462
|
ProvisionedThroughput?: ProvisionedThroughputDescription;
|
|
2288
2463
|
/**
|
|
2464
|
+
* @public
|
|
2289
2465
|
* <p>The total size of the specified index, in bytes. DynamoDB updates this value
|
|
2290
2466
|
* approximately every six hours. Recent changes might not be reflected in this
|
|
2291
2467
|
* value.</p>
|
|
2292
2468
|
*/
|
|
2293
2469
|
IndexSizeBytes?: number;
|
|
2294
2470
|
/**
|
|
2471
|
+
* @public
|
|
2295
2472
|
* <p>The number of items in the specified index. DynamoDB updates this value approximately
|
|
2296
2473
|
* every six hours. Recent changes might not be reflected in this value.</p>
|
|
2297
2474
|
*/
|
|
2298
2475
|
ItemCount?: number;
|
|
2299
2476
|
/**
|
|
2477
|
+
* @public
|
|
2300
2478
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|
2301
2479
|
*/
|
|
2302
2480
|
IndexArn?: string;
|
|
@@ -2307,10 +2485,12 @@ export interface GlobalSecondaryIndexDescription {
|
|
|
2307
2485
|
*/
|
|
2308
2486
|
export interface LocalSecondaryIndexDescription {
|
|
2309
2487
|
/**
|
|
2488
|
+
* @public
|
|
2310
2489
|
* <p>Represents the name of the local secondary index.</p>
|
|
2311
2490
|
*/
|
|
2312
2491
|
IndexName?: string;
|
|
2313
2492
|
/**
|
|
2493
|
+
* @public
|
|
2314
2494
|
* <p>The complete key schema for the local secondary index, consisting of one or more pairs
|
|
2315
2495
|
* of attribute names and key types:</p>
|
|
2316
2496
|
* <ul>
|
|
@@ -2336,24 +2516,28 @@ export interface LocalSecondaryIndexDescription {
|
|
|
2336
2516
|
*/
|
|
2337
2517
|
KeySchema?: KeySchemaElement[];
|
|
2338
2518
|
/**
|
|
2519
|
+
* @public
|
|
2339
2520
|
* <p>Represents attributes that are copied (projected) from the table into the global
|
|
2340
2521
|
* secondary index. These are in addition to the primary key attributes and index key
|
|
2341
2522
|
* attributes, which are automatically projected. </p>
|
|
2342
2523
|
*/
|
|
2343
2524
|
Projection?: Projection;
|
|
2344
2525
|
/**
|
|
2526
|
+
* @public
|
|
2345
2527
|
* <p>The total size of the specified index, in bytes. DynamoDB updates this value
|
|
2346
2528
|
* approximately every six hours. Recent changes might not be reflected in this
|
|
2347
2529
|
* value.</p>
|
|
2348
2530
|
*/
|
|
2349
2531
|
IndexSizeBytes?: number;
|
|
2350
2532
|
/**
|
|
2533
|
+
* @public
|
|
2351
2534
|
* <p>The number of items in the specified index. DynamoDB updates this value
|
|
2352
2535
|
* approximately every six hours. Recent changes might not be reflected in this
|
|
2353
2536
|
* value.</p>
|
|
2354
2537
|
*/
|
|
2355
2538
|
ItemCount?: number;
|
|
2356
2539
|
/**
|
|
2540
|
+
* @public
|
|
2357
2541
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the index.</p>
|
|
2358
2542
|
*/
|
|
2359
2543
|
IndexArn?: string;
|
|
@@ -2364,18 +2548,22 @@ export interface LocalSecondaryIndexDescription {
|
|
|
2364
2548
|
*/
|
|
2365
2549
|
export interface RestoreSummary {
|
|
2366
2550
|
/**
|
|
2551
|
+
* @public
|
|
2367
2552
|
* <p>The Amazon Resource Name (ARN) of the backup from which the table was restored.</p>
|
|
2368
2553
|
*/
|
|
2369
2554
|
SourceBackupArn?: string;
|
|
2370
2555
|
/**
|
|
2556
|
+
* @public
|
|
2371
2557
|
* <p>The ARN of the source table of the backup that is being restored.</p>
|
|
2372
2558
|
*/
|
|
2373
2559
|
SourceTableArn?: string;
|
|
2374
2560
|
/**
|
|
2561
|
+
* @public
|
|
2375
2562
|
* <p>Point in time or source backup time.</p>
|
|
2376
2563
|
*/
|
|
2377
2564
|
RestoreDateTime: Date | undefined;
|
|
2378
2565
|
/**
|
|
2566
|
+
* @public
|
|
2379
2567
|
* <p>Indicates if a restore is in progress or not.</p>
|
|
2380
2568
|
*/
|
|
2381
2569
|
RestoreInProgress: boolean | undefined;
|
|
@@ -2403,6 +2591,7 @@ export type TableStatus = (typeof TableStatus)[keyof typeof TableStatus];
|
|
|
2403
2591
|
*/
|
|
2404
2592
|
export interface TableDescription {
|
|
2405
2593
|
/**
|
|
2594
|
+
* @public
|
|
2406
2595
|
* <p>An array of <code>AttributeDefinition</code> objects. Each of these objects describes
|
|
2407
2596
|
* one attribute in the table and index key schema.</p>
|
|
2408
2597
|
* <p>Each <code>AttributeDefinition</code> object in this array is composed of:</p>
|
|
@@ -2419,10 +2608,12 @@ export interface TableDescription {
|
|
|
2419
2608
|
*/
|
|
2420
2609
|
AttributeDefinitions?: AttributeDefinition[];
|
|
2421
2610
|
/**
|
|
2611
|
+
* @public
|
|
2422
2612
|
* <p>The name of the table.</p>
|
|
2423
2613
|
*/
|
|
2424
2614
|
TableName?: string;
|
|
2425
2615
|
/**
|
|
2616
|
+
* @public
|
|
2426
2617
|
* <p>The primary key structure for the table. Each <code>KeySchemaElement</code> consists
|
|
2427
2618
|
* of:</p>
|
|
2428
2619
|
* <ul>
|
|
@@ -2460,6 +2651,7 @@ export interface TableDescription {
|
|
|
2460
2651
|
*/
|
|
2461
2652
|
KeySchema?: KeySchemaElement[];
|
|
2462
2653
|
/**
|
|
2654
|
+
* @public
|
|
2463
2655
|
* <p>The current state of the table:</p>
|
|
2464
2656
|
* <ul>
|
|
2465
2657
|
* <li>
|
|
@@ -2502,38 +2694,46 @@ export interface TableDescription {
|
|
|
2502
2694
|
*/
|
|
2503
2695
|
TableStatus?: TableStatus | string;
|
|
2504
2696
|
/**
|
|
2697
|
+
* @public
|
|
2505
2698
|
* <p>The date and time when the table was created, in <a href="http://www.epochconverter.com/">UNIX epoch time</a> format.</p>
|
|
2506
2699
|
*/
|
|
2507
2700
|
CreationDateTime?: Date;
|
|
2508
2701
|
/**
|
|
2702
|
+
* @public
|
|
2509
2703
|
* <p>The provisioned throughput settings for the table, consisting of read and write
|
|
2510
2704
|
* capacity units, along with data about increases and decreases.</p>
|
|
2511
2705
|
*/
|
|
2512
2706
|
ProvisionedThroughput?: ProvisionedThroughputDescription;
|
|
2513
2707
|
/**
|
|
2708
|
+
* @public
|
|
2514
2709
|
* <p>The total size of the specified table, in bytes. DynamoDB updates this value
|
|
2515
2710
|
* approximately every six hours. Recent changes might not be reflected in this
|
|
2516
2711
|
* value.</p>
|
|
2517
2712
|
*/
|
|
2518
2713
|
TableSizeBytes?: number;
|
|
2519
2714
|
/**
|
|
2715
|
+
* @public
|
|
2520
2716
|
* <p>The number of items in the specified table. DynamoDB updates this value approximately
|
|
2521
2717
|
* every six hours. Recent changes might not be reflected in this value.</p>
|
|
2522
2718
|
*/
|
|
2523
2719
|
ItemCount?: number;
|
|
2524
2720
|
/**
|
|
2721
|
+
* @public
|
|
2525
2722
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the table.</p>
|
|
2526
2723
|
*/
|
|
2527
2724
|
TableArn?: string;
|
|
2528
2725
|
/**
|
|
2726
|
+
* @public
|
|
2529
2727
|
* <p>Unique identifier for the table for which the backup was created. </p>
|
|
2530
2728
|
*/
|
|
2531
2729
|
TableId?: string;
|
|
2532
2730
|
/**
|
|
2731
|
+
* @public
|
|
2533
2732
|
* <p>Contains the details for the read/write capacity mode.</p>
|
|
2534
2733
|
*/
|
|
2535
2734
|
BillingModeSummary?: BillingModeSummary;
|
|
2536
2735
|
/**
|
|
2736
|
+
* @public
|
|
2537
2737
|
* <p>Represents one or more local secondary indexes on the table. Each index is scoped to a
|
|
2538
2738
|
* given partition key value. Tables with one or more local secondary indexes are subject
|
|
2539
2739
|
* to an item collection size limit, where the amount of data within a given item
|
|
@@ -2607,6 +2807,7 @@ export interface TableDescription {
|
|
|
2607
2807
|
*/
|
|
2608
2808
|
LocalSecondaryIndexes?: LocalSecondaryIndexDescription[];
|
|
2609
2809
|
/**
|
|
2810
|
+
* @public
|
|
2610
2811
|
* <p>The global secondary indexes, if any, on the table. Each index is scoped to a given
|
|
2611
2812
|
* partition key value. Each element is composed of:</p>
|
|
2612
2813
|
* <ul>
|
|
@@ -2721,10 +2922,12 @@ export interface TableDescription {
|
|
|
2721
2922
|
*/
|
|
2722
2923
|
GlobalSecondaryIndexes?: GlobalSecondaryIndexDescription[];
|
|
2723
2924
|
/**
|
|
2925
|
+
* @public
|
|
2724
2926
|
* <p>The current DynamoDB Streams configuration for the table.</p>
|
|
2725
2927
|
*/
|
|
2726
2928
|
StreamSpecification?: StreamSpecification;
|
|
2727
2929
|
/**
|
|
2930
|
+
* @public
|
|
2728
2931
|
* <p>A timestamp, in ISO 8601 format, for this stream.</p>
|
|
2729
2932
|
* <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream,
|
|
2730
2933
|
* because it is possible that a stream from another table might have the same timestamp.
|
|
@@ -2746,36 +2949,44 @@ export interface TableDescription {
|
|
|
2746
2949
|
*/
|
|
2747
2950
|
LatestStreamLabel?: string;
|
|
2748
2951
|
/**
|
|
2952
|
+
* @public
|
|
2749
2953
|
* <p>The Amazon Resource Name (ARN) that uniquely identifies the latest stream for this
|
|
2750
2954
|
* table.</p>
|
|
2751
2955
|
*/
|
|
2752
2956
|
LatestStreamArn?: string;
|
|
2753
2957
|
/**
|
|
2958
|
+
* @public
|
|
2754
2959
|
* <p>Represents the version of <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GlobalTables.html">global tables</a>
|
|
2755
2960
|
* in use, if the table is replicated across Amazon Web Services Regions.</p>
|
|
2756
2961
|
*/
|
|
2757
2962
|
GlobalTableVersion?: string;
|
|
2758
2963
|
/**
|
|
2964
|
+
* @public
|
|
2759
2965
|
* <p>Represents replicas of the table.</p>
|
|
2760
2966
|
*/
|
|
2761
2967
|
Replicas?: ReplicaDescription[];
|
|
2762
2968
|
/**
|
|
2969
|
+
* @public
|
|
2763
2970
|
* <p>Contains details for the restore.</p>
|
|
2764
2971
|
*/
|
|
2765
2972
|
RestoreSummary?: RestoreSummary;
|
|
2766
2973
|
/**
|
|
2974
|
+
* @public
|
|
2767
2975
|
* <p>The description of the server-side encryption status on the specified table.</p>
|
|
2768
2976
|
*/
|
|
2769
2977
|
SSEDescription?: SSEDescription;
|
|
2770
2978
|
/**
|
|
2979
|
+
* @public
|
|
2771
2980
|
* <p>Contains information about the table archive.</p>
|
|
2772
2981
|
*/
|
|
2773
2982
|
ArchivalSummary?: ArchivalSummary;
|
|
2774
2983
|
/**
|
|
2984
|
+
* @public
|
|
2775
2985
|
* <p>Contains details of the table class.</p>
|
|
2776
2986
|
*/
|
|
2777
2987
|
TableClassSummary?: TableClassSummary;
|
|
2778
2988
|
/**
|
|
2989
|
+
* @public
|
|
2779
2990
|
* <p>Indicates whether deletion protection is enabled (true) or disabled (false) on the table.</p>
|
|
2780
2991
|
*/
|
|
2781
2992
|
DeletionProtectionEnabled?: boolean;
|
|
@@ -2786,6 +2997,7 @@ export interface TableDescription {
|
|
|
2786
2997
|
*/
|
|
2787
2998
|
export interface CreateTableOutput {
|
|
2788
2999
|
/**
|
|
3000
|
+
* @public
|
|
2789
3001
|
* <p>Represents the properties of the table.</p>
|
|
2790
3002
|
*/
|
|
2791
3003
|
TableDescription?: TableDescription;
|
|
@@ -2810,10 +3022,12 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
2810
3022
|
*/
|
|
2811
3023
|
export interface CsvOptions {
|
|
2812
3024
|
/**
|
|
3025
|
+
* @public
|
|
2813
3026
|
* <p> The delimiter used for separating items in the CSV file being imported. </p>
|
|
2814
3027
|
*/
|
|
2815
3028
|
Delimiter?: string;
|
|
2816
3029
|
/**
|
|
3030
|
+
* @public
|
|
2817
3031
|
* <p> List of the headers used to specify a common header for all source CSV files being
|
|
2818
3032
|
* imported. If this field is specified then the first line of each CSV file is treated as
|
|
2819
3033
|
* data instead of the header. If this field is not specified the the first line of each
|
|
@@ -2826,6 +3040,7 @@ export interface CsvOptions {
|
|
|
2826
3040
|
*/
|
|
2827
3041
|
export interface DeleteBackupInput {
|
|
2828
3042
|
/**
|
|
3043
|
+
* @public
|
|
2829
3044
|
* <p>The ARN associated with the backup.</p>
|
|
2830
3045
|
*/
|
|
2831
3046
|
BackupArn: string | undefined;
|
|
@@ -2835,6 +3050,7 @@ export interface DeleteBackupInput {
|
|
|
2835
3050
|
*/
|
|
2836
3051
|
export interface DeleteBackupOutput {
|
|
2837
3052
|
/**
|
|
3053
|
+
* @public
|
|
2838
3054
|
* <p>Contains the description of the backup created for the table.</p>
|
|
2839
3055
|
*/
|
|
2840
3056
|
BackupDescription?: BackupDescription;
|
|
@@ -2845,6 +3061,7 @@ export interface DeleteBackupOutput {
|
|
|
2845
3061
|
*/
|
|
2846
3062
|
export interface DeleteGlobalSecondaryIndexAction {
|
|
2847
3063
|
/**
|
|
3064
|
+
* @public
|
|
2848
3065
|
* <p>The name of the global secondary index to be deleted.</p>
|
|
2849
3066
|
*/
|
|
2850
3067
|
IndexName: string | undefined;
|
|
@@ -2883,6 +3100,7 @@ export declare class TransactionConflictException extends __BaseException {
|
|
|
2883
3100
|
*/
|
|
2884
3101
|
export interface DeleteReplicaAction {
|
|
2885
3102
|
/**
|
|
3103
|
+
* @public
|
|
2886
3104
|
* <p>The Region of the replica to be removed.</p>
|
|
2887
3105
|
*/
|
|
2888
3106
|
RegionName: string | undefined;
|
|
@@ -2893,6 +3111,7 @@ export interface DeleteReplicaAction {
|
|
|
2893
3111
|
*/
|
|
2894
3112
|
export interface DeleteReplicationGroupMemberAction {
|
|
2895
3113
|
/**
|
|
3114
|
+
* @public
|
|
2896
3115
|
* <p>The Region where the replica exists.</p>
|
|
2897
3116
|
*/
|
|
2898
3117
|
RegionName: string | undefined;
|
|
@@ -2903,6 +3122,7 @@ export interface DeleteReplicationGroupMemberAction {
|
|
|
2903
3122
|
*/
|
|
2904
3123
|
export interface DeleteTableInput {
|
|
2905
3124
|
/**
|
|
3125
|
+
* @public
|
|
2906
3126
|
* <p>The name of the table to delete.</p>
|
|
2907
3127
|
*/
|
|
2908
3128
|
TableName: string | undefined;
|
|
@@ -2913,6 +3133,7 @@ export interface DeleteTableInput {
|
|
|
2913
3133
|
*/
|
|
2914
3134
|
export interface DeleteTableOutput {
|
|
2915
3135
|
/**
|
|
3136
|
+
* @public
|
|
2916
3137
|
* <p>Represents the properties of a table.</p>
|
|
2917
3138
|
*/
|
|
2918
3139
|
TableDescription?: TableDescription;
|
|
@@ -2922,6 +3143,7 @@ export interface DeleteTableOutput {
|
|
|
2922
3143
|
*/
|
|
2923
3144
|
export interface DescribeBackupInput {
|
|
2924
3145
|
/**
|
|
3146
|
+
* @public
|
|
2925
3147
|
* <p>The Amazon Resource Name (ARN) associated with the backup.</p>
|
|
2926
3148
|
*/
|
|
2927
3149
|
BackupArn: string | undefined;
|
|
@@ -2931,6 +3153,7 @@ export interface DescribeBackupInput {
|
|
|
2931
3153
|
*/
|
|
2932
3154
|
export interface DescribeBackupOutput {
|
|
2933
3155
|
/**
|
|
3156
|
+
* @public
|
|
2934
3157
|
* <p>Contains the description of the backup created for the table.</p>
|
|
2935
3158
|
*/
|
|
2936
3159
|
BackupDescription?: BackupDescription;
|
|
@@ -2940,6 +3163,7 @@ export interface DescribeBackupOutput {
|
|
|
2940
3163
|
*/
|
|
2941
3164
|
export interface DescribeContinuousBackupsInput {
|
|
2942
3165
|
/**
|
|
3166
|
+
* @public
|
|
2943
3167
|
* <p>Name of the table for which the customer wants to check the continuous backups and
|
|
2944
3168
|
* point in time recovery settings.</p>
|
|
2945
3169
|
*/
|
|
@@ -2950,6 +3174,7 @@ export interface DescribeContinuousBackupsInput {
|
|
|
2950
3174
|
*/
|
|
2951
3175
|
export interface DescribeContinuousBackupsOutput {
|
|
2952
3176
|
/**
|
|
3177
|
+
* @public
|
|
2953
3178
|
* <p>Represents the continuous backups and point in time recovery settings on the
|
|
2954
3179
|
* table.</p>
|
|
2955
3180
|
*/
|
|
@@ -2960,10 +3185,12 @@ export interface DescribeContinuousBackupsOutput {
|
|
|
2960
3185
|
*/
|
|
2961
3186
|
export interface DescribeContributorInsightsInput {
|
|
2962
3187
|
/**
|
|
3188
|
+
* @public
|
|
2963
3189
|
* <p>The name of the table to describe.</p>
|
|
2964
3190
|
*/
|
|
2965
3191
|
TableName: string | undefined;
|
|
2966
3192
|
/**
|
|
3193
|
+
* @public
|
|
2967
3194
|
* <p>The name of the global secondary index to describe, if applicable.</p>
|
|
2968
3195
|
*/
|
|
2969
3196
|
IndexName?: string;
|
|
@@ -2974,10 +3201,12 @@ export interface DescribeContributorInsightsInput {
|
|
|
2974
3201
|
*/
|
|
2975
3202
|
export interface FailureException {
|
|
2976
3203
|
/**
|
|
3204
|
+
* @public
|
|
2977
3205
|
* <p>Exception name.</p>
|
|
2978
3206
|
*/
|
|
2979
3207
|
ExceptionName?: string;
|
|
2980
3208
|
/**
|
|
3209
|
+
* @public
|
|
2981
3210
|
* <p>Description of the failure.</p>
|
|
2982
3211
|
*/
|
|
2983
3212
|
ExceptionDescription?: string;
|
|
@@ -2987,26 +3216,32 @@ export interface FailureException {
|
|
|
2987
3216
|
*/
|
|
2988
3217
|
export interface DescribeContributorInsightsOutput {
|
|
2989
3218
|
/**
|
|
3219
|
+
* @public
|
|
2990
3220
|
* <p>The name of the table being described.</p>
|
|
2991
3221
|
*/
|
|
2992
3222
|
TableName?: string;
|
|
2993
3223
|
/**
|
|
3224
|
+
* @public
|
|
2994
3225
|
* <p>The name of the global secondary index being described.</p>
|
|
2995
3226
|
*/
|
|
2996
3227
|
IndexName?: string;
|
|
2997
3228
|
/**
|
|
3229
|
+
* @public
|
|
2998
3230
|
* <p>List of names of the associated contributor insights rules.</p>
|
|
2999
3231
|
*/
|
|
3000
3232
|
ContributorInsightsRuleList?: string[];
|
|
3001
3233
|
/**
|
|
3234
|
+
* @public
|
|
3002
3235
|
* <p>Current status of contributor insights.</p>
|
|
3003
3236
|
*/
|
|
3004
3237
|
ContributorInsightsStatus?: ContributorInsightsStatus | string;
|
|
3005
3238
|
/**
|
|
3239
|
+
* @public
|
|
3006
3240
|
* <p>Timestamp of the last time the status was changed.</p>
|
|
3007
3241
|
*/
|
|
3008
3242
|
LastUpdateDateTime?: Date;
|
|
3009
3243
|
/**
|
|
3244
|
+
* @public
|
|
3010
3245
|
* <p>Returns information about the last failure that was encountered.</p>
|
|
3011
3246
|
* <p>The most common exceptions for a FAILED status are:</p>
|
|
3012
3247
|
* <ul>
|
|
@@ -3042,10 +3277,12 @@ export interface DescribeEndpointsRequest {
|
|
|
3042
3277
|
*/
|
|
3043
3278
|
export interface Endpoint {
|
|
3044
3279
|
/**
|
|
3280
|
+
* @public
|
|
3045
3281
|
* <p>IP address of the endpoint.</p>
|
|
3046
3282
|
*/
|
|
3047
3283
|
Address: string | undefined;
|
|
3048
3284
|
/**
|
|
3285
|
+
* @public
|
|
3049
3286
|
* <p>Endpoint cache time to live (TTL) value.</p>
|
|
3050
3287
|
*/
|
|
3051
3288
|
CachePeriodInMinutes: number | undefined;
|
|
@@ -3055,6 +3292,7 @@ export interface Endpoint {
|
|
|
3055
3292
|
*/
|
|
3056
3293
|
export interface DescribeEndpointsResponse {
|
|
3057
3294
|
/**
|
|
3295
|
+
* @public
|
|
3058
3296
|
* <p>List of endpoints.</p>
|
|
3059
3297
|
*/
|
|
3060
3298
|
Endpoints: Endpoint[] | undefined;
|
|
@@ -3064,6 +3302,7 @@ export interface DescribeEndpointsResponse {
|
|
|
3064
3302
|
*/
|
|
3065
3303
|
export interface DescribeExportInput {
|
|
3066
3304
|
/**
|
|
3305
|
+
* @public
|
|
3067
3306
|
* <p>The Amazon Resource Name (ARN) associated with the export.</p>
|
|
3068
3307
|
*/
|
|
3069
3308
|
ExportArn: string | undefined;
|
|
@@ -3111,59 +3350,72 @@ export type S3SseAlgorithm = (typeof S3SseAlgorithm)[keyof typeof S3SseAlgorithm
|
|
|
3111
3350
|
*/
|
|
3112
3351
|
export interface ExportDescription {
|
|
3113
3352
|
/**
|
|
3353
|
+
* @public
|
|
3114
3354
|
* <p>The Amazon Resource Name (ARN) of the table export.</p>
|
|
3115
3355
|
*/
|
|
3116
3356
|
ExportArn?: string;
|
|
3117
3357
|
/**
|
|
3358
|
+
* @public
|
|
3118
3359
|
* <p>Export can be in one of the following states: IN_PROGRESS, COMPLETED, or
|
|
3119
3360
|
* FAILED.</p>
|
|
3120
3361
|
*/
|
|
3121
3362
|
ExportStatus?: ExportStatus | string;
|
|
3122
3363
|
/**
|
|
3364
|
+
* @public
|
|
3123
3365
|
* <p>The time at which the export task began.</p>
|
|
3124
3366
|
*/
|
|
3125
3367
|
StartTime?: Date;
|
|
3126
3368
|
/**
|
|
3369
|
+
* @public
|
|
3127
3370
|
* <p>The time at which the export task completed.</p>
|
|
3128
3371
|
*/
|
|
3129
3372
|
EndTime?: Date;
|
|
3130
3373
|
/**
|
|
3374
|
+
* @public
|
|
3131
3375
|
* <p>The name of the manifest file for the export task.</p>
|
|
3132
3376
|
*/
|
|
3133
3377
|
ExportManifest?: string;
|
|
3134
3378
|
/**
|
|
3379
|
+
* @public
|
|
3135
3380
|
* <p>The Amazon Resource Name (ARN) of the table that was exported.</p>
|
|
3136
3381
|
*/
|
|
3137
3382
|
TableArn?: string;
|
|
3138
3383
|
/**
|
|
3384
|
+
* @public
|
|
3139
3385
|
* <p>Unique ID of the table that was exported.</p>
|
|
3140
3386
|
*/
|
|
3141
3387
|
TableId?: string;
|
|
3142
3388
|
/**
|
|
3389
|
+
* @public
|
|
3143
3390
|
* <p>Point in time from which table data was exported.</p>
|
|
3144
3391
|
*/
|
|
3145
3392
|
ExportTime?: Date;
|
|
3146
3393
|
/**
|
|
3394
|
+
* @public
|
|
3147
3395
|
* <p>The client token that was provided for the export task. A client token makes calls to
|
|
3148
3396
|
* <code>ExportTableToPointInTimeInput</code> idempotent, meaning that multiple
|
|
3149
3397
|
* identical calls have the same effect as one single call.</p>
|
|
3150
3398
|
*/
|
|
3151
3399
|
ClientToken?: string;
|
|
3152
3400
|
/**
|
|
3401
|
+
* @public
|
|
3153
3402
|
* <p>The name of the Amazon S3 bucket containing the export.</p>
|
|
3154
3403
|
*/
|
|
3155
3404
|
S3Bucket?: string;
|
|
3156
3405
|
/**
|
|
3406
|
+
* @public
|
|
3157
3407
|
* <p>The ID of the Amazon Web Services account that owns the bucket containing the
|
|
3158
3408
|
* export.</p>
|
|
3159
3409
|
*/
|
|
3160
3410
|
S3BucketOwner?: string;
|
|
3161
3411
|
/**
|
|
3412
|
+
* @public
|
|
3162
3413
|
* <p>The Amazon S3 bucket prefix used as the file name and path of the exported
|
|
3163
3414
|
* snapshot.</p>
|
|
3164
3415
|
*/
|
|
3165
3416
|
S3Prefix?: string;
|
|
3166
3417
|
/**
|
|
3418
|
+
* @public
|
|
3167
3419
|
* <p>Type of encryption used on the bucket where export data is stored. Valid values for
|
|
3168
3420
|
* <code>S3SseAlgorithm</code> are:</p>
|
|
3169
3421
|
* <ul>
|
|
@@ -3181,28 +3433,34 @@ export interface ExportDescription {
|
|
|
3181
3433
|
*/
|
|
3182
3434
|
S3SseAlgorithm?: S3SseAlgorithm | string;
|
|
3183
3435
|
/**
|
|
3436
|
+
* @public
|
|
3184
3437
|
* <p>The ID of the KMS managed key used to encrypt the S3 bucket where
|
|
3185
3438
|
* export data is stored (if applicable).</p>
|
|
3186
3439
|
*/
|
|
3187
3440
|
S3SseKmsKeyId?: string;
|
|
3188
3441
|
/**
|
|
3442
|
+
* @public
|
|
3189
3443
|
* <p>Status code for the result of the failed export.</p>
|
|
3190
3444
|
*/
|
|
3191
3445
|
FailureCode?: string;
|
|
3192
3446
|
/**
|
|
3447
|
+
* @public
|
|
3193
3448
|
* <p>Export failure reason description.</p>
|
|
3194
3449
|
*/
|
|
3195
3450
|
FailureMessage?: string;
|
|
3196
3451
|
/**
|
|
3452
|
+
* @public
|
|
3197
3453
|
* <p>The format of the exported data. Valid values for <code>ExportFormat</code> are
|
|
3198
3454
|
* <code>DYNAMODB_JSON</code> or <code>ION</code>.</p>
|
|
3199
3455
|
*/
|
|
3200
3456
|
ExportFormat?: ExportFormat | string;
|
|
3201
3457
|
/**
|
|
3458
|
+
* @public
|
|
3202
3459
|
* <p>The billable size of the table export.</p>
|
|
3203
3460
|
*/
|
|
3204
3461
|
BilledSizeBytes?: number;
|
|
3205
3462
|
/**
|
|
3463
|
+
* @public
|
|
3206
3464
|
* <p>The number of items exported.</p>
|
|
3207
3465
|
*/
|
|
3208
3466
|
ItemCount?: number;
|
|
@@ -3212,6 +3470,7 @@ export interface ExportDescription {
|
|
|
3212
3470
|
*/
|
|
3213
3471
|
export interface DescribeExportOutput {
|
|
3214
3472
|
/**
|
|
3473
|
+
* @public
|
|
3215
3474
|
* <p>Represents the properties of the export.</p>
|
|
3216
3475
|
*/
|
|
3217
3476
|
ExportDescription?: ExportDescription;
|
|
@@ -3233,6 +3492,7 @@ export declare class ExportNotFoundException extends __BaseException {
|
|
|
3233
3492
|
*/
|
|
3234
3493
|
export interface DescribeGlobalTableInput {
|
|
3235
3494
|
/**
|
|
3495
|
+
* @public
|
|
3236
3496
|
* <p>The name of the global table.</p>
|
|
3237
3497
|
*/
|
|
3238
3498
|
GlobalTableName: string | undefined;
|
|
@@ -3242,6 +3502,7 @@ export interface DescribeGlobalTableInput {
|
|
|
3242
3502
|
*/
|
|
3243
3503
|
export interface DescribeGlobalTableOutput {
|
|
3244
3504
|
/**
|
|
3505
|
+
* @public
|
|
3245
3506
|
* <p>Contains the details of the global table.</p>
|
|
3246
3507
|
*/
|
|
3247
3508
|
GlobalTableDescription?: GlobalTableDescription;
|
|
@@ -3263,6 +3524,7 @@ export declare class GlobalTableNotFoundException extends __BaseException {
|
|
|
3263
3524
|
*/
|
|
3264
3525
|
export interface DescribeGlobalTableSettingsInput {
|
|
3265
3526
|
/**
|
|
3527
|
+
* @public
|
|
3266
3528
|
* <p>The name of the global table to describe.</p>
|
|
3267
3529
|
*/
|
|
3268
3530
|
GlobalTableName: string | undefined;
|
|
@@ -3273,11 +3535,13 @@ export interface DescribeGlobalTableSettingsInput {
|
|
|
3273
3535
|
*/
|
|
3274
3536
|
export interface ReplicaGlobalSecondaryIndexSettingsDescription {
|
|
3275
3537
|
/**
|
|
3538
|
+
* @public
|
|
3276
3539
|
* <p>The name of the global secondary index. The name must be unique among all other
|
|
3277
3540
|
* indexes on this table.</p>
|
|
3278
3541
|
*/
|
|
3279
3542
|
IndexName: string | undefined;
|
|
3280
3543
|
/**
|
|
3544
|
+
* @public
|
|
3281
3545
|
* <p> The current status of the global secondary index:</p>
|
|
3282
3546
|
* <ul>
|
|
3283
3547
|
* <li>
|
|
@@ -3300,21 +3564,25 @@ export interface ReplicaGlobalSecondaryIndexSettingsDescription {
|
|
|
3300
3564
|
*/
|
|
3301
3565
|
IndexStatus?: IndexStatus | string;
|
|
3302
3566
|
/**
|
|
3567
|
+
* @public
|
|
3303
3568
|
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
|
|
3304
3569
|
* returns a <code>ThrottlingException</code>.</p>
|
|
3305
3570
|
*/
|
|
3306
3571
|
ProvisionedReadCapacityUnits?: number;
|
|
3307
3572
|
/**
|
|
3573
|
+
* @public
|
|
3308
3574
|
* <p>Auto scaling settings for a global secondary index replica's read capacity
|
|
3309
3575
|
* units.</p>
|
|
3310
3576
|
*/
|
|
3311
3577
|
ProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
|
|
3312
3578
|
/**
|
|
3579
|
+
* @public
|
|
3313
3580
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
3314
3581
|
* <code>ThrottlingException</code>.</p>
|
|
3315
3582
|
*/
|
|
3316
3583
|
ProvisionedWriteCapacityUnits?: number;
|
|
3317
3584
|
/**
|
|
3585
|
+
* @public
|
|
3318
3586
|
* <p>Auto scaling settings for a global secondary index replica's write capacity
|
|
3319
3587
|
* units.</p>
|
|
3320
3588
|
*/
|
|
@@ -3326,10 +3594,12 @@ export interface ReplicaGlobalSecondaryIndexSettingsDescription {
|
|
|
3326
3594
|
*/
|
|
3327
3595
|
export interface ReplicaSettingsDescription {
|
|
3328
3596
|
/**
|
|
3597
|
+
* @public
|
|
3329
3598
|
* <p>The Region name of the replica.</p>
|
|
3330
3599
|
*/
|
|
3331
3600
|
RegionName: string | undefined;
|
|
3332
3601
|
/**
|
|
3602
|
+
* @public
|
|
3333
3603
|
* <p>The current state of the Region:</p>
|
|
3334
3604
|
* <ul>
|
|
3335
3605
|
* <li>
|
|
@@ -3352,34 +3622,41 @@ export interface ReplicaSettingsDescription {
|
|
|
3352
3622
|
*/
|
|
3353
3623
|
ReplicaStatus?: ReplicaStatus | string;
|
|
3354
3624
|
/**
|
|
3625
|
+
* @public
|
|
3355
3626
|
* <p>The read/write capacity mode of the replica.</p>
|
|
3356
3627
|
*/
|
|
3357
3628
|
ReplicaBillingModeSummary?: BillingModeSummary;
|
|
3358
3629
|
/**
|
|
3630
|
+
* @public
|
|
3359
3631
|
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
|
|
3360
3632
|
* returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
|
|
3361
3633
|
* Developer Guide</i>. </p>
|
|
3362
3634
|
*/
|
|
3363
3635
|
ReplicaProvisionedReadCapacityUnits?: number;
|
|
3364
3636
|
/**
|
|
3637
|
+
* @public
|
|
3365
3638
|
* <p>Auto scaling settings for a global table replica's read capacity units.</p>
|
|
3366
3639
|
*/
|
|
3367
3640
|
ReplicaProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
|
|
3368
3641
|
/**
|
|
3642
|
+
* @public
|
|
3369
3643
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
3370
3644
|
* <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
|
|
3371
3645
|
* Developer Guide</i>.</p>
|
|
3372
3646
|
*/
|
|
3373
3647
|
ReplicaProvisionedWriteCapacityUnits?: number;
|
|
3374
3648
|
/**
|
|
3649
|
+
* @public
|
|
3375
3650
|
* <p>Auto scaling settings for a global table replica's write capacity units.</p>
|
|
3376
3651
|
*/
|
|
3377
3652
|
ReplicaProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
|
|
3378
3653
|
/**
|
|
3654
|
+
* @public
|
|
3379
3655
|
* <p>Replica global secondary index settings for the global table.</p>
|
|
3380
3656
|
*/
|
|
3381
3657
|
ReplicaGlobalSecondaryIndexSettings?: ReplicaGlobalSecondaryIndexSettingsDescription[];
|
|
3382
3658
|
/**
|
|
3659
|
+
* @public
|
|
3383
3660
|
* <p>Contains details of the table class.</p>
|
|
3384
3661
|
*/
|
|
3385
3662
|
ReplicaTableClassSummary?: TableClassSummary;
|
|
@@ -3389,10 +3666,12 @@ export interface ReplicaSettingsDescription {
|
|
|
3389
3666
|
*/
|
|
3390
3667
|
export interface DescribeGlobalTableSettingsOutput {
|
|
3391
3668
|
/**
|
|
3669
|
+
* @public
|
|
3392
3670
|
* <p>The name of the global table.</p>
|
|
3393
3671
|
*/
|
|
3394
3672
|
GlobalTableName?: string;
|
|
3395
3673
|
/**
|
|
3674
|
+
* @public
|
|
3396
3675
|
* <p>The Region-specific settings for the global table.</p>
|
|
3397
3676
|
*/
|
|
3398
3677
|
ReplicaSettings?: ReplicaSettingsDescription[];
|
|
@@ -3402,6 +3681,7 @@ export interface DescribeGlobalTableSettingsOutput {
|
|
|
3402
3681
|
*/
|
|
3403
3682
|
export interface DescribeImportInput {
|
|
3404
3683
|
/**
|
|
3684
|
+
* @public
|
|
3405
3685
|
* <p> The Amazon Resource Name (ARN) associated with the table you're importing to. </p>
|
|
3406
3686
|
*/
|
|
3407
3687
|
ImportArn: string | undefined;
|
|
@@ -3454,6 +3734,7 @@ export type InputFormat = (typeof InputFormat)[keyof typeof InputFormat];
|
|
|
3454
3734
|
*/
|
|
3455
3735
|
export interface InputFormatOptions {
|
|
3456
3736
|
/**
|
|
3737
|
+
* @public
|
|
3457
3738
|
* <p> The options for imported source files in CSV format. The values are Delimiter and
|
|
3458
3739
|
* HeaderList. </p>
|
|
3459
3740
|
*/
|
|
@@ -3465,15 +3746,18 @@ export interface InputFormatOptions {
|
|
|
3465
3746
|
*/
|
|
3466
3747
|
export interface S3BucketSource {
|
|
3467
3748
|
/**
|
|
3749
|
+
* @public
|
|
3468
3750
|
* <p> The account number of the S3 bucket that is being imported from. If the bucket is
|
|
3469
3751
|
* owned by the requester this is optional. </p>
|
|
3470
3752
|
*/
|
|
3471
3753
|
S3BucketOwner?: string;
|
|
3472
3754
|
/**
|
|
3755
|
+
* @public
|
|
3473
3756
|
* <p> The S3 bucket that is being imported from. </p>
|
|
3474
3757
|
*/
|
|
3475
3758
|
S3Bucket: string | undefined;
|
|
3476
3759
|
/**
|
|
3760
|
+
* @public
|
|
3477
3761
|
* <p> The key prefix shared by all S3 Objects that are being imported. </p>
|
|
3478
3762
|
*/
|
|
3479
3763
|
S3KeyPrefix?: string;
|
|
@@ -3484,24 +3768,29 @@ export interface S3BucketSource {
|
|
|
3484
3768
|
*/
|
|
3485
3769
|
export interface TableCreationParameters {
|
|
3486
3770
|
/**
|
|
3771
|
+
* @public
|
|
3487
3772
|
* <p> The name of the table created as part of the import operation. </p>
|
|
3488
3773
|
*/
|
|
3489
3774
|
TableName: string | undefined;
|
|
3490
3775
|
/**
|
|
3776
|
+
* @public
|
|
3491
3777
|
* <p> The attributes of the table created as part of the import operation. </p>
|
|
3492
3778
|
*/
|
|
3493
3779
|
AttributeDefinitions: AttributeDefinition[] | undefined;
|
|
3494
3780
|
/**
|
|
3781
|
+
* @public
|
|
3495
3782
|
* <p> The primary key and option sort key of the table created as part of the import
|
|
3496
3783
|
* operation. </p>
|
|
3497
3784
|
*/
|
|
3498
3785
|
KeySchema: KeySchemaElement[] | undefined;
|
|
3499
3786
|
/**
|
|
3787
|
+
* @public
|
|
3500
3788
|
* <p> The billing mode for provisioning the table created as part of the import operation.
|
|
3501
3789
|
* </p>
|
|
3502
3790
|
*/
|
|
3503
3791
|
BillingMode?: BillingMode | string;
|
|
3504
3792
|
/**
|
|
3793
|
+
* @public
|
|
3505
3794
|
* <p>Represents the provisioned throughput settings for a specified table or index. The
|
|
3506
3795
|
* settings can be modified using the <code>UpdateTable</code> operation.</p>
|
|
3507
3796
|
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
@@ -3510,10 +3799,12 @@ export interface TableCreationParameters {
|
|
|
3510
3799
|
*/
|
|
3511
3800
|
ProvisionedThroughput?: ProvisionedThroughput;
|
|
3512
3801
|
/**
|
|
3802
|
+
* @public
|
|
3513
3803
|
* <p>Represents the settings used to enable server-side encryption.</p>
|
|
3514
3804
|
*/
|
|
3515
3805
|
SSESpecification?: SSESpecification;
|
|
3516
3806
|
/**
|
|
3807
|
+
* @public
|
|
3517
3808
|
* <p> The Global Secondary Indexes (GSI) of the table to be created as part of the import
|
|
3518
3809
|
* operation. </p>
|
|
3519
3810
|
*/
|
|
@@ -3526,90 +3817,109 @@ export interface TableCreationParameters {
|
|
|
3526
3817
|
*/
|
|
3527
3818
|
export interface ImportTableDescription {
|
|
3528
3819
|
/**
|
|
3820
|
+
* @public
|
|
3529
3821
|
* <p> The Amazon Resource Number (ARN) corresponding to the import request.
|
|
3530
3822
|
* </p>
|
|
3531
3823
|
*/
|
|
3532
3824
|
ImportArn?: string;
|
|
3533
3825
|
/**
|
|
3826
|
+
* @public
|
|
3534
3827
|
* <p> The status of the import. </p>
|
|
3535
3828
|
*/
|
|
3536
3829
|
ImportStatus?: ImportStatus | string;
|
|
3537
3830
|
/**
|
|
3831
|
+
* @public
|
|
3538
3832
|
* <p> The Amazon Resource Number (ARN) of the table being imported into.
|
|
3539
3833
|
* </p>
|
|
3540
3834
|
*/
|
|
3541
3835
|
TableArn?: string;
|
|
3542
3836
|
/**
|
|
3837
|
+
* @public
|
|
3543
3838
|
* <p> The table id corresponding to the table created by import table process.
|
|
3544
3839
|
* </p>
|
|
3545
3840
|
*/
|
|
3546
3841
|
TableId?: string;
|
|
3547
3842
|
/**
|
|
3843
|
+
* @public
|
|
3548
3844
|
* <p> The client token that was provided for the import task. Reusing the client token on
|
|
3549
3845
|
* retry makes a call to <code>ImportTable</code> idempotent. </p>
|
|
3550
3846
|
*/
|
|
3551
3847
|
ClientToken?: string;
|
|
3552
3848
|
/**
|
|
3849
|
+
* @public
|
|
3553
3850
|
* <p> Values for the S3 bucket the source file is imported from. Includes bucket name
|
|
3554
3851
|
* (required), key prefix (optional) and bucket account owner ID (optional). </p>
|
|
3555
3852
|
*/
|
|
3556
3853
|
S3BucketSource?: S3BucketSource;
|
|
3557
3854
|
/**
|
|
3855
|
+
* @public
|
|
3558
3856
|
* <p> The number of errors occurred on importing the source file into the target table.
|
|
3559
3857
|
* </p>
|
|
3560
3858
|
*/
|
|
3561
3859
|
ErrorCount?: number;
|
|
3562
3860
|
/**
|
|
3861
|
+
* @public
|
|
3563
3862
|
* <p> The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with the
|
|
3564
3863
|
* target table. </p>
|
|
3565
3864
|
*/
|
|
3566
3865
|
CloudWatchLogGroupArn?: string;
|
|
3567
3866
|
/**
|
|
3867
|
+
* @public
|
|
3568
3868
|
* <p> The format of the source data going into the target table.
|
|
3569
3869
|
* </p>
|
|
3570
3870
|
*/
|
|
3571
3871
|
InputFormat?: InputFormat | string;
|
|
3572
3872
|
/**
|
|
3873
|
+
* @public
|
|
3573
3874
|
* <p> The format options for the data that was imported into the target table. There is one
|
|
3574
3875
|
* value, CsvOption. </p>
|
|
3575
3876
|
*/
|
|
3576
3877
|
InputFormatOptions?: InputFormatOptions;
|
|
3577
3878
|
/**
|
|
3879
|
+
* @public
|
|
3578
3880
|
* <p> The compression options for the data that has been imported into the target table.
|
|
3579
3881
|
* The values are NONE, GZIP, or ZSTD. </p>
|
|
3580
3882
|
*/
|
|
3581
3883
|
InputCompressionType?: InputCompressionType | string;
|
|
3582
3884
|
/**
|
|
3885
|
+
* @public
|
|
3583
3886
|
* <p> The parameters for the new table that is being imported into. </p>
|
|
3584
3887
|
*/
|
|
3585
3888
|
TableCreationParameters?: TableCreationParameters;
|
|
3586
3889
|
/**
|
|
3890
|
+
* @public
|
|
3587
3891
|
* <p> The time when this import task started. </p>
|
|
3588
3892
|
*/
|
|
3589
3893
|
StartTime?: Date;
|
|
3590
3894
|
/**
|
|
3895
|
+
* @public
|
|
3591
3896
|
* <p> The time at which the creation of the table associated with this import task
|
|
3592
3897
|
* completed. </p>
|
|
3593
3898
|
*/
|
|
3594
3899
|
EndTime?: Date;
|
|
3595
3900
|
/**
|
|
3901
|
+
* @public
|
|
3596
3902
|
* <p> The total size of data processed from the source file, in Bytes. </p>
|
|
3597
3903
|
*/
|
|
3598
3904
|
ProcessedSizeBytes?: number;
|
|
3599
3905
|
/**
|
|
3906
|
+
* @public
|
|
3600
3907
|
* <p> The total number of items processed from the source file. </p>
|
|
3601
3908
|
*/
|
|
3602
3909
|
ProcessedItemCount?: number;
|
|
3603
3910
|
/**
|
|
3911
|
+
* @public
|
|
3604
3912
|
* <p> The number of items successfully imported into the new table. </p>
|
|
3605
3913
|
*/
|
|
3606
3914
|
ImportedItemCount?: number;
|
|
3607
3915
|
/**
|
|
3916
|
+
* @public
|
|
3608
3917
|
* <p> The error code corresponding to the failure that the import job ran into during
|
|
3609
3918
|
* execution. </p>
|
|
3610
3919
|
*/
|
|
3611
3920
|
FailureCode?: string;
|
|
3612
3921
|
/**
|
|
3922
|
+
* @public
|
|
3613
3923
|
* <p> The error message corresponding to the failure that the import job ran into during
|
|
3614
3924
|
* execution. </p>
|
|
3615
3925
|
*/
|
|
@@ -3620,6 +3930,7 @@ export interface ImportTableDescription {
|
|
|
3620
3930
|
*/
|
|
3621
3931
|
export interface DescribeImportOutput {
|
|
3622
3932
|
/**
|
|
3933
|
+
* @public
|
|
3623
3934
|
* <p> Represents the properties of the table created for the import, and parameters of the
|
|
3624
3935
|
* import. The import parameters include import status, how many items were processed, and
|
|
3625
3936
|
* how many errors were encountered. </p>
|
|
@@ -3645,6 +3956,7 @@ export declare class ImportNotFoundException extends __BaseException {
|
|
|
3645
3956
|
*/
|
|
3646
3957
|
export interface DescribeKinesisStreamingDestinationInput {
|
|
3647
3958
|
/**
|
|
3959
|
+
* @public
|
|
3648
3960
|
* <p>The name of the table being described.</p>
|
|
3649
3961
|
*/
|
|
3650
3962
|
TableName: string | undefined;
|
|
@@ -3670,14 +3982,17 @@ export type DestinationStatus = (typeof DestinationStatus)[keyof typeof Destinat
|
|
|
3670
3982
|
*/
|
|
3671
3983
|
export interface KinesisDataStreamDestination {
|
|
3672
3984
|
/**
|
|
3985
|
+
* @public
|
|
3673
3986
|
* <p>The ARN for a specific Kinesis data stream.</p>
|
|
3674
3987
|
*/
|
|
3675
3988
|
StreamArn?: string;
|
|
3676
3989
|
/**
|
|
3990
|
+
* @public
|
|
3677
3991
|
* <p>The current status of replication.</p>
|
|
3678
3992
|
*/
|
|
3679
3993
|
DestinationStatus?: DestinationStatus | string;
|
|
3680
3994
|
/**
|
|
3995
|
+
* @public
|
|
3681
3996
|
* <p>The human-readable string that corresponds to the replica status.</p>
|
|
3682
3997
|
*/
|
|
3683
3998
|
DestinationStatusDescription?: string;
|
|
@@ -3687,10 +4002,12 @@ export interface KinesisDataStreamDestination {
|
|
|
3687
4002
|
*/
|
|
3688
4003
|
export interface DescribeKinesisStreamingDestinationOutput {
|
|
3689
4004
|
/**
|
|
4005
|
+
* @public
|
|
3690
4006
|
* <p>The name of the table being described.</p>
|
|
3691
4007
|
*/
|
|
3692
4008
|
TableName?: string;
|
|
3693
4009
|
/**
|
|
4010
|
+
* @public
|
|
3694
4011
|
* <p>The list of replica structures for the table being described.</p>
|
|
3695
4012
|
*/
|
|
3696
4013
|
KinesisDataStreamDestinations?: KinesisDataStreamDestination[];
|
|
@@ -3708,22 +4025,26 @@ export interface DescribeLimitsInput {
|
|
|
3708
4025
|
*/
|
|
3709
4026
|
export interface DescribeLimitsOutput {
|
|
3710
4027
|
/**
|
|
4028
|
+
* @public
|
|
3711
4029
|
* <p>The maximum total read capacity units that your account allows you to provision across
|
|
3712
4030
|
* all of your tables in this Region.</p>
|
|
3713
4031
|
*/
|
|
3714
4032
|
AccountMaxReadCapacityUnits?: number;
|
|
3715
4033
|
/**
|
|
4034
|
+
* @public
|
|
3716
4035
|
* <p>The maximum total write capacity units that your account allows you to provision
|
|
3717
4036
|
* across all of your tables in this Region.</p>
|
|
3718
4037
|
*/
|
|
3719
4038
|
AccountMaxWriteCapacityUnits?: number;
|
|
3720
4039
|
/**
|
|
4040
|
+
* @public
|
|
3721
4041
|
* <p>The maximum read capacity units that your account allows you to provision for a new
|
|
3722
4042
|
* table that you are creating in this Region, including the read capacity units
|
|
3723
4043
|
* provisioned for its global secondary indexes (GSIs).</p>
|
|
3724
4044
|
*/
|
|
3725
4045
|
TableMaxReadCapacityUnits?: number;
|
|
3726
4046
|
/**
|
|
4047
|
+
* @public
|
|
3727
4048
|
* <p>The maximum write capacity units that your account allows you to provision for a new
|
|
3728
4049
|
* table that you are creating in this Region, including the write capacity units
|
|
3729
4050
|
* provisioned for its global secondary indexes (GSIs).</p>
|
|
@@ -3736,6 +4057,7 @@ export interface DescribeLimitsOutput {
|
|
|
3736
4057
|
*/
|
|
3737
4058
|
export interface DescribeTableInput {
|
|
3738
4059
|
/**
|
|
4060
|
+
* @public
|
|
3739
4061
|
* <p>The name of the table to describe.</p>
|
|
3740
4062
|
*/
|
|
3741
4063
|
TableName: string | undefined;
|
|
@@ -3746,6 +4068,7 @@ export interface DescribeTableInput {
|
|
|
3746
4068
|
*/
|
|
3747
4069
|
export interface DescribeTableOutput {
|
|
3748
4070
|
/**
|
|
4071
|
+
* @public
|
|
3749
4072
|
* <p>The properties of the table.</p>
|
|
3750
4073
|
*/
|
|
3751
4074
|
Table?: TableDescription;
|
|
@@ -3755,6 +4078,7 @@ export interface DescribeTableOutput {
|
|
|
3755
4078
|
*/
|
|
3756
4079
|
export interface DescribeTableReplicaAutoScalingInput {
|
|
3757
4080
|
/**
|
|
4081
|
+
* @public
|
|
3758
4082
|
* <p>The name of the table.</p>
|
|
3759
4083
|
*/
|
|
3760
4084
|
TableName: string | undefined;
|
|
@@ -3765,10 +4089,12 @@ export interface DescribeTableReplicaAutoScalingInput {
|
|
|
3765
4089
|
*/
|
|
3766
4090
|
export interface ReplicaGlobalSecondaryIndexAutoScalingDescription {
|
|
3767
4091
|
/**
|
|
4092
|
+
* @public
|
|
3768
4093
|
* <p>The name of the global secondary index.</p>
|
|
3769
4094
|
*/
|
|
3770
4095
|
IndexName?: string;
|
|
3771
4096
|
/**
|
|
4097
|
+
* @public
|
|
3772
4098
|
* <p>The current state of the replica global secondary index:</p>
|
|
3773
4099
|
* <ul>
|
|
3774
4100
|
* <li>
|
|
@@ -3794,11 +4120,13 @@ export interface ReplicaGlobalSecondaryIndexAutoScalingDescription {
|
|
|
3794
4120
|
*/
|
|
3795
4121
|
IndexStatus?: IndexStatus | string;
|
|
3796
4122
|
/**
|
|
4123
|
+
* @public
|
|
3797
4124
|
* <p>Represents the auto scaling settings for a global table or global secondary
|
|
3798
4125
|
* index.</p>
|
|
3799
4126
|
*/
|
|
3800
4127
|
ProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
|
|
3801
4128
|
/**
|
|
4129
|
+
* @public
|
|
3802
4130
|
* <p>Represents the auto scaling settings for a global table or global secondary
|
|
3803
4131
|
* index.</p>
|
|
3804
4132
|
*/
|
|
@@ -3810,24 +4138,29 @@ export interface ReplicaGlobalSecondaryIndexAutoScalingDescription {
|
|
|
3810
4138
|
*/
|
|
3811
4139
|
export interface ReplicaAutoScalingDescription {
|
|
3812
4140
|
/**
|
|
4141
|
+
* @public
|
|
3813
4142
|
* <p>The Region where the replica exists.</p>
|
|
3814
4143
|
*/
|
|
3815
4144
|
RegionName?: string;
|
|
3816
4145
|
/**
|
|
4146
|
+
* @public
|
|
3817
4147
|
* <p>Replica-specific global secondary index auto scaling settings.</p>
|
|
3818
4148
|
*/
|
|
3819
4149
|
GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndexAutoScalingDescription[];
|
|
3820
4150
|
/**
|
|
4151
|
+
* @public
|
|
3821
4152
|
* <p>Represents the auto scaling settings for a global table or global secondary
|
|
3822
4153
|
* index.</p>
|
|
3823
4154
|
*/
|
|
3824
4155
|
ReplicaProvisionedReadCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
|
|
3825
4156
|
/**
|
|
4157
|
+
* @public
|
|
3826
4158
|
* <p>Represents the auto scaling settings for a global table or global secondary
|
|
3827
4159
|
* index.</p>
|
|
3828
4160
|
*/
|
|
3829
4161
|
ReplicaProvisionedWriteCapacityAutoScalingSettings?: AutoScalingSettingsDescription;
|
|
3830
4162
|
/**
|
|
4163
|
+
* @public
|
|
3831
4164
|
* <p>The current state of the replica:</p>
|
|
3832
4165
|
* <ul>
|
|
3833
4166
|
* <li>
|
|
@@ -3856,10 +4189,12 @@ export interface ReplicaAutoScalingDescription {
|
|
|
3856
4189
|
*/
|
|
3857
4190
|
export interface TableAutoScalingDescription {
|
|
3858
4191
|
/**
|
|
4192
|
+
* @public
|
|
3859
4193
|
* <p>The name of the table.</p>
|
|
3860
4194
|
*/
|
|
3861
4195
|
TableName?: string;
|
|
3862
4196
|
/**
|
|
4197
|
+
* @public
|
|
3863
4198
|
* <p>The current state of the table:</p>
|
|
3864
4199
|
* <ul>
|
|
3865
4200
|
* <li>
|
|
@@ -3882,6 +4217,7 @@ export interface TableAutoScalingDescription {
|
|
|
3882
4217
|
*/
|
|
3883
4218
|
TableStatus?: TableStatus | string;
|
|
3884
4219
|
/**
|
|
4220
|
+
* @public
|
|
3885
4221
|
* <p>Represents replicas of the global table.</p>
|
|
3886
4222
|
*/
|
|
3887
4223
|
Replicas?: ReplicaAutoScalingDescription[];
|
|
@@ -3891,6 +4227,7 @@ export interface TableAutoScalingDescription {
|
|
|
3891
4227
|
*/
|
|
3892
4228
|
export interface DescribeTableReplicaAutoScalingOutput {
|
|
3893
4229
|
/**
|
|
4230
|
+
* @public
|
|
3894
4231
|
* <p>Represents the auto scaling properties of the table.</p>
|
|
3895
4232
|
*/
|
|
3896
4233
|
TableAutoScalingDescription?: TableAutoScalingDescription;
|
|
@@ -3900,6 +4237,7 @@ export interface DescribeTableReplicaAutoScalingOutput {
|
|
|
3900
4237
|
*/
|
|
3901
4238
|
export interface DescribeTimeToLiveInput {
|
|
3902
4239
|
/**
|
|
4240
|
+
* @public
|
|
3903
4241
|
* <p>The name of the table to be described.</p>
|
|
3904
4242
|
*/
|
|
3905
4243
|
TableName: string | undefined;
|
|
@@ -3909,6 +4247,7 @@ export interface DescribeTimeToLiveInput {
|
|
|
3909
4247
|
*/
|
|
3910
4248
|
export interface DescribeTimeToLiveOutput {
|
|
3911
4249
|
/**
|
|
4250
|
+
* @public
|
|
3912
4251
|
* <p></p>
|
|
3913
4252
|
*/
|
|
3914
4253
|
TimeToLiveDescription?: TimeToLiveDescription;
|
|
@@ -3918,10 +4257,12 @@ export interface DescribeTimeToLiveOutput {
|
|
|
3918
4257
|
*/
|
|
3919
4258
|
export interface KinesisStreamingDestinationInput {
|
|
3920
4259
|
/**
|
|
4260
|
+
* @public
|
|
3921
4261
|
* <p>The name of the DynamoDB table.</p>
|
|
3922
4262
|
*/
|
|
3923
4263
|
TableName: string | undefined;
|
|
3924
4264
|
/**
|
|
4265
|
+
* @public
|
|
3925
4266
|
* <p>The ARN for a Kinesis data stream.</p>
|
|
3926
4267
|
*/
|
|
3927
4268
|
StreamArn: string | undefined;
|
|
@@ -3931,14 +4272,17 @@ export interface KinesisStreamingDestinationInput {
|
|
|
3931
4272
|
*/
|
|
3932
4273
|
export interface KinesisStreamingDestinationOutput {
|
|
3933
4274
|
/**
|
|
4275
|
+
* @public
|
|
3934
4276
|
* <p>The name of the table being modified.</p>
|
|
3935
4277
|
*/
|
|
3936
4278
|
TableName?: string;
|
|
3937
4279
|
/**
|
|
4280
|
+
* @public
|
|
3938
4281
|
* <p>The ARN for the specific Kinesis data stream.</p>
|
|
3939
4282
|
*/
|
|
3940
4283
|
StreamArn?: string;
|
|
3941
4284
|
/**
|
|
4285
|
+
* @public
|
|
3942
4286
|
* <p>The current status of the replication.</p>
|
|
3943
4287
|
*/
|
|
3944
4288
|
DestinationStatus?: DestinationStatus | string;
|
|
@@ -4062,16 +4406,19 @@ export declare class ExportConflictException extends __BaseException {
|
|
|
4062
4406
|
*/
|
|
4063
4407
|
export interface ExportTableToPointInTimeInput {
|
|
4064
4408
|
/**
|
|
4409
|
+
* @public
|
|
4065
4410
|
* <p>The Amazon Resource Name (ARN) associated with the table to export.</p>
|
|
4066
4411
|
*/
|
|
4067
4412
|
TableArn: string | undefined;
|
|
4068
4413
|
/**
|
|
4414
|
+
* @public
|
|
4069
4415
|
* <p>Time in the past from which to export table data, counted in seconds from the start of
|
|
4070
4416
|
* the Unix epoch. The table export will be a snapshot of the table's state at this point
|
|
4071
4417
|
* in time.</p>
|
|
4072
4418
|
*/
|
|
4073
4419
|
ExportTime?: Date;
|
|
4074
4420
|
/**
|
|
4421
|
+
* @public
|
|
4075
4422
|
* <p>Providing a <code>ClientToken</code> makes the call to
|
|
4076
4423
|
* <code>ExportTableToPointInTimeInput</code> idempotent, meaning that multiple
|
|
4077
4424
|
* identical calls have the same effect as one single call.</p>
|
|
@@ -4085,20 +4432,24 @@ export interface ExportTableToPointInTimeInput {
|
|
|
4085
4432
|
*/
|
|
4086
4433
|
ClientToken?: string;
|
|
4087
4434
|
/**
|
|
4435
|
+
* @public
|
|
4088
4436
|
* <p>The name of the Amazon S3 bucket to export the snapshot to.</p>
|
|
4089
4437
|
*/
|
|
4090
4438
|
S3Bucket: string | undefined;
|
|
4091
4439
|
/**
|
|
4440
|
+
* @public
|
|
4092
4441
|
* <p>The ID of the Amazon Web Services account that owns the bucket the export will be
|
|
4093
4442
|
* stored in.</p>
|
|
4094
4443
|
*/
|
|
4095
4444
|
S3BucketOwner?: string;
|
|
4096
4445
|
/**
|
|
4446
|
+
* @public
|
|
4097
4447
|
* <p>The Amazon S3 bucket prefix to use as the file name and path of the exported
|
|
4098
4448
|
* snapshot.</p>
|
|
4099
4449
|
*/
|
|
4100
4450
|
S3Prefix?: string;
|
|
4101
4451
|
/**
|
|
4452
|
+
* @public
|
|
4102
4453
|
* <p>Type of encryption used on the bucket where export data will be stored. Valid values
|
|
4103
4454
|
* for <code>S3SseAlgorithm</code> are:</p>
|
|
4104
4455
|
* <ul>
|
|
@@ -4116,11 +4467,13 @@ export interface ExportTableToPointInTimeInput {
|
|
|
4116
4467
|
*/
|
|
4117
4468
|
S3SseAlgorithm?: S3SseAlgorithm | string;
|
|
4118
4469
|
/**
|
|
4470
|
+
* @public
|
|
4119
4471
|
* <p>The ID of the KMS managed key used to encrypt the S3 bucket where
|
|
4120
4472
|
* export data will be stored (if applicable).</p>
|
|
4121
4473
|
*/
|
|
4122
4474
|
S3SseKmsKeyId?: string;
|
|
4123
4475
|
/**
|
|
4476
|
+
* @public
|
|
4124
4477
|
* <p>The format for the exported data. Valid values for <code>ExportFormat</code> are
|
|
4125
4478
|
* <code>DYNAMODB_JSON</code> or <code>ION</code>.</p>
|
|
4126
4479
|
*/
|
|
@@ -4131,6 +4484,7 @@ export interface ExportTableToPointInTimeInput {
|
|
|
4131
4484
|
*/
|
|
4132
4485
|
export interface ExportTableToPointInTimeOutput {
|
|
4133
4486
|
/**
|
|
4487
|
+
* @public
|
|
4134
4488
|
* <p>Contains a description of the table export.</p>
|
|
4135
4489
|
*/
|
|
4136
4490
|
ExportDescription?: ExportDescription;
|
|
@@ -4181,6 +4535,7 @@ export declare class ImportConflictException extends __BaseException {
|
|
|
4181
4535
|
*/
|
|
4182
4536
|
export interface ImportTableInput {
|
|
4183
4537
|
/**
|
|
4538
|
+
* @public
|
|
4184
4539
|
* <p>Providing a <code>ClientToken</code> makes the call to <code>ImportTableInput</code>
|
|
4185
4540
|
* idempotent, meaning that multiple identical calls have the same effect as one single
|
|
4186
4541
|
* call.</p>
|
|
@@ -4194,23 +4549,28 @@ export interface ImportTableInput {
|
|
|
4194
4549
|
*/
|
|
4195
4550
|
ClientToken?: string;
|
|
4196
4551
|
/**
|
|
4552
|
+
* @public
|
|
4197
4553
|
* <p> The S3 bucket that provides the source for the import. </p>
|
|
4198
4554
|
*/
|
|
4199
4555
|
S3BucketSource: S3BucketSource | undefined;
|
|
4200
4556
|
/**
|
|
4557
|
+
* @public
|
|
4201
4558
|
* <p> The format of the source data. Valid values for <code>ImportFormat</code> are
|
|
4202
4559
|
* <code>CSV</code>, <code>DYNAMODB_JSON</code> or <code>ION</code>. </p>
|
|
4203
4560
|
*/
|
|
4204
4561
|
InputFormat: InputFormat | string | undefined;
|
|
4205
4562
|
/**
|
|
4563
|
+
* @public
|
|
4206
4564
|
* <p> Additional properties that specify how the input is formatted, </p>
|
|
4207
4565
|
*/
|
|
4208
4566
|
InputFormatOptions?: InputFormatOptions;
|
|
4209
4567
|
/**
|
|
4568
|
+
* @public
|
|
4210
4569
|
* <p> Type of compression to be used on the input coming from the imported table. </p>
|
|
4211
4570
|
*/
|
|
4212
4571
|
InputCompressionType?: InputCompressionType | string;
|
|
4213
4572
|
/**
|
|
4573
|
+
* @public
|
|
4214
4574
|
* <p>Parameters for the table to import the data into. </p>
|
|
4215
4575
|
*/
|
|
4216
4576
|
TableCreationParameters: TableCreationParameters | undefined;
|
|
@@ -4220,6 +4580,7 @@ export interface ImportTableInput {
|
|
|
4220
4580
|
*/
|
|
4221
4581
|
export interface ImportTableOutput {
|
|
4222
4582
|
/**
|
|
4583
|
+
* @public
|
|
4223
4584
|
* <p> Represents the properties of the table created for the import, and parameters of the
|
|
4224
4585
|
* import. The import parameters include import status, how many items were processed, and
|
|
4225
4586
|
* how many errors were encountered. </p>
|
|
@@ -4231,24 +4592,29 @@ export interface ImportTableOutput {
|
|
|
4231
4592
|
*/
|
|
4232
4593
|
export interface ListBackupsInput {
|
|
4233
4594
|
/**
|
|
4595
|
+
* @public
|
|
4234
4596
|
* <p>The backups from the table specified by <code>TableName</code> are listed. </p>
|
|
4235
4597
|
*/
|
|
4236
4598
|
TableName?: string;
|
|
4237
4599
|
/**
|
|
4600
|
+
* @public
|
|
4238
4601
|
* <p>Maximum number of backups to return at once.</p>
|
|
4239
4602
|
*/
|
|
4240
4603
|
Limit?: number;
|
|
4241
4604
|
/**
|
|
4605
|
+
* @public
|
|
4242
4606
|
* <p>Only backups created after this time are listed. <code>TimeRangeLowerBound</code> is
|
|
4243
4607
|
* inclusive.</p>
|
|
4244
4608
|
*/
|
|
4245
4609
|
TimeRangeLowerBound?: Date;
|
|
4246
4610
|
/**
|
|
4611
|
+
* @public
|
|
4247
4612
|
* <p>Only backups created before this time are listed. <code>TimeRangeUpperBound</code> is
|
|
4248
4613
|
* exclusive. </p>
|
|
4249
4614
|
*/
|
|
4250
4615
|
TimeRangeUpperBound?: Date;
|
|
4251
4616
|
/**
|
|
4617
|
+
* @public
|
|
4252
4618
|
* <p>
|
|
4253
4619
|
* <code>LastEvaluatedBackupArn</code> is the Amazon Resource Name (ARN) of the backup last
|
|
4254
4620
|
* evaluated when the current page of results was returned, inclusive of the current page
|
|
@@ -4258,6 +4624,7 @@ export interface ListBackupsInput {
|
|
|
4258
4624
|
*/
|
|
4259
4625
|
ExclusiveStartBackupArn?: string;
|
|
4260
4626
|
/**
|
|
4627
|
+
* @public
|
|
4261
4628
|
* <p>The backups from the table specified by <code>BackupType</code> are listed.</p>
|
|
4262
4629
|
* <p>Where <code>BackupType</code> can be:</p>
|
|
4263
4630
|
* <ul>
|
|
@@ -4283,10 +4650,12 @@ export interface ListBackupsInput {
|
|
|
4283
4650
|
*/
|
|
4284
4651
|
export interface ListBackupsOutput {
|
|
4285
4652
|
/**
|
|
4653
|
+
* @public
|
|
4286
4654
|
* <p>List of <code>BackupSummary</code> objects.</p>
|
|
4287
4655
|
*/
|
|
4288
4656
|
BackupSummaries?: BackupSummary[];
|
|
4289
4657
|
/**
|
|
4658
|
+
* @public
|
|
4290
4659
|
* <p> The ARN of the backup last evaluated when the current page of results was returned,
|
|
4291
4660
|
* inclusive of the current page of results. This value may be specified as the
|
|
4292
4661
|
* <code>ExclusiveStartBackupArn</code> of a new <code>ListBackups</code> operation in
|
|
@@ -4304,14 +4673,17 @@ export interface ListBackupsOutput {
|
|
|
4304
4673
|
*/
|
|
4305
4674
|
export interface ListContributorInsightsInput {
|
|
4306
4675
|
/**
|
|
4676
|
+
* @public
|
|
4307
4677
|
* <p>The name of the table.</p>
|
|
4308
4678
|
*/
|
|
4309
4679
|
TableName?: string;
|
|
4310
4680
|
/**
|
|
4681
|
+
* @public
|
|
4311
4682
|
* <p>A token to for the desired page, if there is one.</p>
|
|
4312
4683
|
*/
|
|
4313
4684
|
NextToken?: string;
|
|
4314
4685
|
/**
|
|
4686
|
+
* @public
|
|
4315
4687
|
* <p>Maximum number of results to return per page.</p>
|
|
4316
4688
|
*/
|
|
4317
4689
|
MaxResults?: number;
|
|
@@ -4321,10 +4693,12 @@ export interface ListContributorInsightsInput {
|
|
|
4321
4693
|
*/
|
|
4322
4694
|
export interface ListContributorInsightsOutput {
|
|
4323
4695
|
/**
|
|
4696
|
+
* @public
|
|
4324
4697
|
* <p>A list of ContributorInsightsSummary.</p>
|
|
4325
4698
|
*/
|
|
4326
4699
|
ContributorInsightsSummaries?: ContributorInsightsSummary[];
|
|
4327
4700
|
/**
|
|
4701
|
+
* @public
|
|
4328
4702
|
* <p>A token to go to the next page if there is one.</p>
|
|
4329
4703
|
*/
|
|
4330
4704
|
NextToken?: string;
|
|
@@ -4334,14 +4708,17 @@ export interface ListContributorInsightsOutput {
|
|
|
4334
4708
|
*/
|
|
4335
4709
|
export interface ListExportsInput {
|
|
4336
4710
|
/**
|
|
4711
|
+
* @public
|
|
4337
4712
|
* <p>The Amazon Resource Name (ARN) associated with the exported table.</p>
|
|
4338
4713
|
*/
|
|
4339
4714
|
TableArn?: string;
|
|
4340
4715
|
/**
|
|
4716
|
+
* @public
|
|
4341
4717
|
* <p>Maximum number of results to return per page.</p>
|
|
4342
4718
|
*/
|
|
4343
4719
|
MaxResults?: number;
|
|
4344
4720
|
/**
|
|
4721
|
+
* @public
|
|
4345
4722
|
* <p>An optional string that, if supplied, must be copied from the output of a previous
|
|
4346
4723
|
* call to <code>ListExports</code>. When provided in this manner, the API fetches the next
|
|
4347
4724
|
* page of results.</p>
|
|
@@ -4354,10 +4731,12 @@ export interface ListExportsInput {
|
|
|
4354
4731
|
*/
|
|
4355
4732
|
export interface ExportSummary {
|
|
4356
4733
|
/**
|
|
4734
|
+
* @public
|
|
4357
4735
|
* <p>The Amazon Resource Name (ARN) of the export.</p>
|
|
4358
4736
|
*/
|
|
4359
4737
|
ExportArn?: string;
|
|
4360
4738
|
/**
|
|
4739
|
+
* @public
|
|
4361
4740
|
* <p>Export can be in one of the following states: IN_PROGRESS, COMPLETED, or
|
|
4362
4741
|
* FAILED.</p>
|
|
4363
4742
|
*/
|
|
@@ -4368,10 +4747,12 @@ export interface ExportSummary {
|
|
|
4368
4747
|
*/
|
|
4369
4748
|
export interface ListExportsOutput {
|
|
4370
4749
|
/**
|
|
4750
|
+
* @public
|
|
4371
4751
|
* <p>A list of <code>ExportSummary</code> objects.</p>
|
|
4372
4752
|
*/
|
|
4373
4753
|
ExportSummaries?: ExportSummary[];
|
|
4374
4754
|
/**
|
|
4755
|
+
* @public
|
|
4375
4756
|
* <p>If this value is returned, there are additional results to be displayed. To retrieve
|
|
4376
4757
|
* them, call <code>ListExports</code> again, with <code>NextToken</code> set to this
|
|
4377
4758
|
* value.</p>
|
|
@@ -4383,10 +4764,12 @@ export interface ListExportsOutput {
|
|
|
4383
4764
|
*/
|
|
4384
4765
|
export interface ListGlobalTablesInput {
|
|
4385
4766
|
/**
|
|
4767
|
+
* @public
|
|
4386
4768
|
* <p>The first global table name that this operation will evaluate.</p>
|
|
4387
4769
|
*/
|
|
4388
4770
|
ExclusiveStartGlobalTableName?: string;
|
|
4389
4771
|
/**
|
|
4772
|
+
* @public
|
|
4390
4773
|
* <p>The maximum number of table names to return, if the parameter is not specified
|
|
4391
4774
|
* DynamoDB defaults to 100.</p>
|
|
4392
4775
|
* <p>If the number of global tables DynamoDB finds reaches this limit, it stops the
|
|
@@ -4396,6 +4779,7 @@ export interface ListGlobalTablesInput {
|
|
|
4396
4779
|
*/
|
|
4397
4780
|
Limit?: number;
|
|
4398
4781
|
/**
|
|
4782
|
+
* @public
|
|
4399
4783
|
* <p>Lists the global tables in a specific Region.</p>
|
|
4400
4784
|
*/
|
|
4401
4785
|
RegionName?: string;
|
|
@@ -4406,10 +4790,12 @@ export interface ListGlobalTablesInput {
|
|
|
4406
4790
|
*/
|
|
4407
4791
|
export interface GlobalTable {
|
|
4408
4792
|
/**
|
|
4793
|
+
* @public
|
|
4409
4794
|
* <p>The global table name.</p>
|
|
4410
4795
|
*/
|
|
4411
4796
|
GlobalTableName?: string;
|
|
4412
4797
|
/**
|
|
4798
|
+
* @public
|
|
4413
4799
|
* <p>The Regions where the global table has replicas.</p>
|
|
4414
4800
|
*/
|
|
4415
4801
|
ReplicationGroup?: Replica[];
|
|
@@ -4419,10 +4805,12 @@ export interface GlobalTable {
|
|
|
4419
4805
|
*/
|
|
4420
4806
|
export interface ListGlobalTablesOutput {
|
|
4421
4807
|
/**
|
|
4808
|
+
* @public
|
|
4422
4809
|
* <p>List of global table names.</p>
|
|
4423
4810
|
*/
|
|
4424
4811
|
GlobalTables?: GlobalTable[];
|
|
4425
4812
|
/**
|
|
4813
|
+
* @public
|
|
4426
4814
|
* <p>Last evaluated global table name.</p>
|
|
4427
4815
|
*/
|
|
4428
4816
|
LastEvaluatedGlobalTableName?: string;
|
|
@@ -4432,15 +4820,18 @@ export interface ListGlobalTablesOutput {
|
|
|
4432
4820
|
*/
|
|
4433
4821
|
export interface ListImportsInput {
|
|
4434
4822
|
/**
|
|
4823
|
+
* @public
|
|
4435
4824
|
* <p> The Amazon Resource Name (ARN) associated with the table that was imported to.
|
|
4436
4825
|
* </p>
|
|
4437
4826
|
*/
|
|
4438
4827
|
TableArn?: string;
|
|
4439
4828
|
/**
|
|
4829
|
+
* @public
|
|
4440
4830
|
* <p> The number of <code>ImportSummary </code>objects returned in a single page. </p>
|
|
4441
4831
|
*/
|
|
4442
4832
|
PageSize?: number;
|
|
4443
4833
|
/**
|
|
4834
|
+
* @public
|
|
4444
4835
|
* <p> An optional string that, if supplied, must be copied from the output of a previous
|
|
4445
4836
|
* call to <code>ListImports</code>. When provided in this manner, the API fetches the next
|
|
4446
4837
|
* page of results. </p>
|
|
@@ -4454,38 +4845,46 @@ export interface ListImportsInput {
|
|
|
4454
4845
|
*/
|
|
4455
4846
|
export interface ImportSummary {
|
|
4456
4847
|
/**
|
|
4848
|
+
* @public
|
|
4457
4849
|
* <p> The Amazon Resource Number (ARN) corresponding to the import request. </p>
|
|
4458
4850
|
*/
|
|
4459
4851
|
ImportArn?: string;
|
|
4460
4852
|
/**
|
|
4853
|
+
* @public
|
|
4461
4854
|
* <p> The status of the import operation. </p>
|
|
4462
4855
|
*/
|
|
4463
4856
|
ImportStatus?: ImportStatus | string;
|
|
4464
4857
|
/**
|
|
4858
|
+
* @public
|
|
4465
4859
|
* <p> The Amazon Resource Number (ARN) of the table being imported into. </p>
|
|
4466
4860
|
*/
|
|
4467
4861
|
TableArn?: string;
|
|
4468
4862
|
/**
|
|
4863
|
+
* @public
|
|
4469
4864
|
* <p> The path and S3 bucket of the source file that is being imported. This includes the
|
|
4470
4865
|
* S3Bucket (required), S3KeyPrefix (optional) and S3BucketOwner (optional if the bucket is
|
|
4471
4866
|
* owned by the requester). </p>
|
|
4472
4867
|
*/
|
|
4473
4868
|
S3BucketSource?: S3BucketSource;
|
|
4474
4869
|
/**
|
|
4870
|
+
* @public
|
|
4475
4871
|
* <p> The Amazon Resource Number (ARN) of the Cloudwatch Log Group associated with this
|
|
4476
4872
|
* import task. </p>
|
|
4477
4873
|
*/
|
|
4478
4874
|
CloudWatchLogGroupArn?: string;
|
|
4479
4875
|
/**
|
|
4876
|
+
* @public
|
|
4480
4877
|
* <p> The format of the source data. Valid values are <code>CSV</code>,
|
|
4481
4878
|
* <code>DYNAMODB_JSON</code> or <code>ION</code>.</p>
|
|
4482
4879
|
*/
|
|
4483
4880
|
InputFormat?: InputFormat | string;
|
|
4484
4881
|
/**
|
|
4882
|
+
* @public
|
|
4485
4883
|
* <p> The time at which this import task began. </p>
|
|
4486
4884
|
*/
|
|
4487
4885
|
StartTime?: Date;
|
|
4488
4886
|
/**
|
|
4887
|
+
* @public
|
|
4489
4888
|
* <p> The time at which this import task ended. (Does this include the successful complete
|
|
4490
4889
|
* creation of the table it was imported to?) </p>
|
|
4491
4890
|
*/
|
|
@@ -4496,10 +4895,12 @@ export interface ImportSummary {
|
|
|
4496
4895
|
*/
|
|
4497
4896
|
export interface ListImportsOutput {
|
|
4498
4897
|
/**
|
|
4898
|
+
* @public
|
|
4499
4899
|
* <p> A list of <code>ImportSummary</code> objects. </p>
|
|
4500
4900
|
*/
|
|
4501
4901
|
ImportSummaryList?: ImportSummary[];
|
|
4502
4902
|
/**
|
|
4903
|
+
* @public
|
|
4503
4904
|
* <p> If this value is returned, there are additional results to be displayed. To retrieve
|
|
4504
4905
|
* them, call <code>ListImports</code> again, with <code>NextToken</code> set to this
|
|
4505
4906
|
* value. </p>
|
|
@@ -4512,12 +4913,14 @@ export interface ListImportsOutput {
|
|
|
4512
4913
|
*/
|
|
4513
4914
|
export interface ListTablesInput {
|
|
4514
4915
|
/**
|
|
4916
|
+
* @public
|
|
4515
4917
|
* <p>The first table name that this operation will evaluate. Use the value that was
|
|
4516
4918
|
* returned for <code>LastEvaluatedTableName</code> in a previous operation, so that you
|
|
4517
4919
|
* can obtain the next page of results.</p>
|
|
4518
4920
|
*/
|
|
4519
4921
|
ExclusiveStartTableName?: string;
|
|
4520
4922
|
/**
|
|
4923
|
+
* @public
|
|
4521
4924
|
* <p>A maximum number of table names to return. If this parameter is not specified, the
|
|
4522
4925
|
* limit is 100.</p>
|
|
4523
4926
|
*/
|
|
@@ -4529,6 +4932,7 @@ export interface ListTablesInput {
|
|
|
4529
4932
|
*/
|
|
4530
4933
|
export interface ListTablesOutput {
|
|
4531
4934
|
/**
|
|
4935
|
+
* @public
|
|
4532
4936
|
* <p>The names of the tables associated with the current account at the current endpoint.
|
|
4533
4937
|
* The maximum size of this array is 100.</p>
|
|
4534
4938
|
* <p>If <code>LastEvaluatedTableName</code> also appears in the output, you can use this
|
|
@@ -4537,6 +4941,7 @@ export interface ListTablesOutput {
|
|
|
4537
4941
|
*/
|
|
4538
4942
|
TableNames?: string[];
|
|
4539
4943
|
/**
|
|
4944
|
+
* @public
|
|
4540
4945
|
* <p>The name of the last table in the current page of results. Use this value as the
|
|
4541
4946
|
* <code>ExclusiveStartTableName</code> in a new request to obtain the next page of
|
|
4542
4947
|
* results, until all the table names are returned.</p>
|
|
@@ -4550,11 +4955,13 @@ export interface ListTablesOutput {
|
|
|
4550
4955
|
*/
|
|
4551
4956
|
export interface ListTagsOfResourceInput {
|
|
4552
4957
|
/**
|
|
4958
|
+
* @public
|
|
4553
4959
|
* <p>The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource
|
|
4554
4960
|
* Name (ARN).</p>
|
|
4555
4961
|
*/
|
|
4556
4962
|
ResourceArn: string | undefined;
|
|
4557
4963
|
/**
|
|
4964
|
+
* @public
|
|
4558
4965
|
* <p>An optional string that, if supplied, must be copied from the output of a previous
|
|
4559
4966
|
* call to ListTagOfResource. When provided in this manner, this API fetches the next page
|
|
4560
4967
|
* of results.</p>
|
|
@@ -4566,10 +4973,12 @@ export interface ListTagsOfResourceInput {
|
|
|
4566
4973
|
*/
|
|
4567
4974
|
export interface ListTagsOfResourceOutput {
|
|
4568
4975
|
/**
|
|
4976
|
+
* @public
|
|
4569
4977
|
* <p>The tags currently associated with the Amazon DynamoDB resource.</p>
|
|
4570
4978
|
*/
|
|
4571
4979
|
Tags?: Tag[];
|
|
4572
4980
|
/**
|
|
4981
|
+
* @public
|
|
4573
4982
|
* <p>If this value is returned, there are additional results to be displayed. To retrieve
|
|
4574
4983
|
* them, call ListTagsOfResource again, with NextToken set to this value.</p>
|
|
4575
4984
|
*/
|
|
@@ -4594,34 +5003,41 @@ export type Select = (typeof Select)[keyof typeof Select];
|
|
|
4594
5003
|
*/
|
|
4595
5004
|
export interface RestoreTableFromBackupInput {
|
|
4596
5005
|
/**
|
|
5006
|
+
* @public
|
|
4597
5007
|
* <p>The name of the new table to which the backup must be restored.</p>
|
|
4598
5008
|
*/
|
|
4599
5009
|
TargetTableName: string | undefined;
|
|
4600
5010
|
/**
|
|
5011
|
+
* @public
|
|
4601
5012
|
* <p>The Amazon Resource Name (ARN) associated with the backup.</p>
|
|
4602
5013
|
*/
|
|
4603
5014
|
BackupArn: string | undefined;
|
|
4604
5015
|
/**
|
|
5016
|
+
* @public
|
|
4605
5017
|
* <p>The billing mode of the restored table.</p>
|
|
4606
5018
|
*/
|
|
4607
5019
|
BillingModeOverride?: BillingMode | string;
|
|
4608
5020
|
/**
|
|
5021
|
+
* @public
|
|
4609
5022
|
* <p>List of global secondary indexes for the restored table. The indexes provided should
|
|
4610
5023
|
* match existing secondary indexes. You can choose to exclude some or all of the indexes
|
|
4611
5024
|
* at the time of restore.</p>
|
|
4612
5025
|
*/
|
|
4613
5026
|
GlobalSecondaryIndexOverride?: GlobalSecondaryIndex[];
|
|
4614
5027
|
/**
|
|
5028
|
+
* @public
|
|
4615
5029
|
* <p>List of local secondary indexes for the restored table. The indexes provided should
|
|
4616
5030
|
* match existing secondary indexes. You can choose to exclude some or all of the indexes
|
|
4617
5031
|
* at the time of restore.</p>
|
|
4618
5032
|
*/
|
|
4619
5033
|
LocalSecondaryIndexOverride?: LocalSecondaryIndex[];
|
|
4620
5034
|
/**
|
|
5035
|
+
* @public
|
|
4621
5036
|
* <p>Provisioned throughput settings for the restored table.</p>
|
|
4622
5037
|
*/
|
|
4623
5038
|
ProvisionedThroughputOverride?: ProvisionedThroughput;
|
|
4624
5039
|
/**
|
|
5040
|
+
* @public
|
|
4625
5041
|
* <p>The new server-side encryption settings for the restored table.</p>
|
|
4626
5042
|
*/
|
|
4627
5043
|
SSESpecificationOverride?: SSESpecification;
|
|
@@ -4631,6 +5047,7 @@ export interface RestoreTableFromBackupInput {
|
|
|
4631
5047
|
*/
|
|
4632
5048
|
export interface RestoreTableFromBackupOutput {
|
|
4633
5049
|
/**
|
|
5050
|
+
* @public
|
|
4634
5051
|
* <p>The description of the table created from an existing backup.</p>
|
|
4635
5052
|
*/
|
|
4636
5053
|
TableDescription?: TableDescription;
|
|
@@ -4665,48 +5082,58 @@ export declare class InvalidRestoreTimeException extends __BaseException {
|
|
|
4665
5082
|
*/
|
|
4666
5083
|
export interface RestoreTableToPointInTimeInput {
|
|
4667
5084
|
/**
|
|
5085
|
+
* @public
|
|
4668
5086
|
* <p>The DynamoDB table that will be restored. This value is an Amazon Resource Name
|
|
4669
5087
|
* (ARN).</p>
|
|
4670
5088
|
*/
|
|
4671
5089
|
SourceTableArn?: string;
|
|
4672
5090
|
/**
|
|
5091
|
+
* @public
|
|
4673
5092
|
* <p>Name of the source table that is being restored.</p>
|
|
4674
5093
|
*/
|
|
4675
5094
|
SourceTableName?: string;
|
|
4676
5095
|
/**
|
|
5096
|
+
* @public
|
|
4677
5097
|
* <p>The name of the new table to which it must be restored to.</p>
|
|
4678
5098
|
*/
|
|
4679
5099
|
TargetTableName: string | undefined;
|
|
4680
5100
|
/**
|
|
5101
|
+
* @public
|
|
4681
5102
|
* <p>Restore the table to the latest possible time. <code>LatestRestorableDateTime</code>
|
|
4682
5103
|
* is typically 5 minutes before the current time. </p>
|
|
4683
5104
|
*/
|
|
4684
5105
|
UseLatestRestorableTime?: boolean;
|
|
4685
5106
|
/**
|
|
5107
|
+
* @public
|
|
4686
5108
|
* <p>Time in the past to restore the table to.</p>
|
|
4687
5109
|
*/
|
|
4688
5110
|
RestoreDateTime?: Date;
|
|
4689
5111
|
/**
|
|
5112
|
+
* @public
|
|
4690
5113
|
* <p>The billing mode of the restored table.</p>
|
|
4691
5114
|
*/
|
|
4692
5115
|
BillingModeOverride?: BillingMode | string;
|
|
4693
5116
|
/**
|
|
5117
|
+
* @public
|
|
4694
5118
|
* <p>List of global secondary indexes for the restored table. The indexes provided should
|
|
4695
5119
|
* match existing secondary indexes. You can choose to exclude some or all of the indexes
|
|
4696
5120
|
* at the time of restore.</p>
|
|
4697
5121
|
*/
|
|
4698
5122
|
GlobalSecondaryIndexOverride?: GlobalSecondaryIndex[];
|
|
4699
5123
|
/**
|
|
5124
|
+
* @public
|
|
4700
5125
|
* <p>List of local secondary indexes for the restored table. The indexes provided should
|
|
4701
5126
|
* match existing secondary indexes. You can choose to exclude some or all of the indexes
|
|
4702
5127
|
* at the time of restore.</p>
|
|
4703
5128
|
*/
|
|
4704
5129
|
LocalSecondaryIndexOverride?: LocalSecondaryIndex[];
|
|
4705
5130
|
/**
|
|
5131
|
+
* @public
|
|
4706
5132
|
* <p>Provisioned throughput settings for the restored table.</p>
|
|
4707
5133
|
*/
|
|
4708
5134
|
ProvisionedThroughputOverride?: ProvisionedThroughput;
|
|
4709
5135
|
/**
|
|
5136
|
+
* @public
|
|
4710
5137
|
* <p>The new server-side encryption settings for the restored table.</p>
|
|
4711
5138
|
*/
|
|
4712
5139
|
SSESpecificationOverride?: SSESpecification;
|
|
@@ -4716,6 +5143,7 @@ export interface RestoreTableToPointInTimeInput {
|
|
|
4716
5143
|
*/
|
|
4717
5144
|
export interface RestoreTableToPointInTimeOutput {
|
|
4718
5145
|
/**
|
|
5146
|
+
* @public
|
|
4719
5147
|
* <p>Represents the properties of a table.</p>
|
|
4720
5148
|
*/
|
|
4721
5149
|
TableDescription?: TableDescription;
|
|
@@ -4725,11 +5153,13 @@ export interface RestoreTableToPointInTimeOutput {
|
|
|
4725
5153
|
*/
|
|
4726
5154
|
export interface TagResourceInput {
|
|
4727
5155
|
/**
|
|
5156
|
+
* @public
|
|
4728
5157
|
* <p>Identifies the Amazon DynamoDB resource to which tags should be added. This value is
|
|
4729
5158
|
* an Amazon Resource Name (ARN).</p>
|
|
4730
5159
|
*/
|
|
4731
5160
|
ResourceArn: string | undefined;
|
|
4732
5161
|
/**
|
|
5162
|
+
* @public
|
|
4733
5163
|
* <p>The tags to be assigned to the Amazon DynamoDB resource.</p>
|
|
4734
5164
|
*/
|
|
4735
5165
|
Tags: Tag[] | undefined;
|
|
@@ -4739,11 +5169,13 @@ export interface TagResourceInput {
|
|
|
4739
5169
|
*/
|
|
4740
5170
|
export interface UntagResourceInput {
|
|
4741
5171
|
/**
|
|
5172
|
+
* @public
|
|
4742
5173
|
* <p>The DynamoDB resource that the tags will be removed from. This value is an Amazon
|
|
4743
5174
|
* Resource Name (ARN).</p>
|
|
4744
5175
|
*/
|
|
4745
5176
|
ResourceArn: string | undefined;
|
|
4746
5177
|
/**
|
|
5178
|
+
* @public
|
|
4747
5179
|
* <p>A list of tag keys. Existing tags of the resource whose keys are members of this list
|
|
4748
5180
|
* will be removed from the DynamoDB resource.</p>
|
|
4749
5181
|
*/
|
|
@@ -4755,6 +5187,7 @@ export interface UntagResourceInput {
|
|
|
4755
5187
|
*/
|
|
4756
5188
|
export interface PointInTimeRecoverySpecification {
|
|
4757
5189
|
/**
|
|
5190
|
+
* @public
|
|
4758
5191
|
* <p>Indicates whether point in time recovery is enabled (true) or disabled (false) on the
|
|
4759
5192
|
* table.</p>
|
|
4760
5193
|
*/
|
|
@@ -4765,10 +5198,12 @@ export interface PointInTimeRecoverySpecification {
|
|
|
4765
5198
|
*/
|
|
4766
5199
|
export interface UpdateContinuousBackupsInput {
|
|
4767
5200
|
/**
|
|
5201
|
+
* @public
|
|
4768
5202
|
* <p>The name of the table.</p>
|
|
4769
5203
|
*/
|
|
4770
5204
|
TableName: string | undefined;
|
|
4771
5205
|
/**
|
|
5206
|
+
* @public
|
|
4772
5207
|
* <p>Represents the settings used to enable point in time recovery.</p>
|
|
4773
5208
|
*/
|
|
4774
5209
|
PointInTimeRecoverySpecification: PointInTimeRecoverySpecification | undefined;
|
|
@@ -4778,6 +5213,7 @@ export interface UpdateContinuousBackupsInput {
|
|
|
4778
5213
|
*/
|
|
4779
5214
|
export interface UpdateContinuousBackupsOutput {
|
|
4780
5215
|
/**
|
|
5216
|
+
* @public
|
|
4781
5217
|
* <p>Represents the continuous backups and point in time recovery settings on the
|
|
4782
5218
|
* table.</p>
|
|
4783
5219
|
*/
|
|
@@ -4788,14 +5224,17 @@ export interface UpdateContinuousBackupsOutput {
|
|
|
4788
5224
|
*/
|
|
4789
5225
|
export interface UpdateContributorInsightsInput {
|
|
4790
5226
|
/**
|
|
5227
|
+
* @public
|
|
4791
5228
|
* <p>The name of the table.</p>
|
|
4792
5229
|
*/
|
|
4793
5230
|
TableName: string | undefined;
|
|
4794
5231
|
/**
|
|
5232
|
+
* @public
|
|
4795
5233
|
* <p>The global secondary index name, if applicable.</p>
|
|
4796
5234
|
*/
|
|
4797
5235
|
IndexName?: string;
|
|
4798
5236
|
/**
|
|
5237
|
+
* @public
|
|
4799
5238
|
* <p>Represents the contributor insights action.</p>
|
|
4800
5239
|
*/
|
|
4801
5240
|
ContributorInsightsAction: ContributorInsightsAction | string | undefined;
|
|
@@ -4805,14 +5244,17 @@ export interface UpdateContributorInsightsInput {
|
|
|
4805
5244
|
*/
|
|
4806
5245
|
export interface UpdateContributorInsightsOutput {
|
|
4807
5246
|
/**
|
|
5247
|
+
* @public
|
|
4808
5248
|
* <p>The name of the table.</p>
|
|
4809
5249
|
*/
|
|
4810
5250
|
TableName?: string;
|
|
4811
5251
|
/**
|
|
5252
|
+
* @public
|
|
4812
5253
|
* <p>The name of the global secondary index, if applicable.</p>
|
|
4813
5254
|
*/
|
|
4814
5255
|
IndexName?: string;
|
|
4815
5256
|
/**
|
|
5257
|
+
* @public
|
|
4816
5258
|
* <p>The status of contributor insights</p>
|
|
4817
5259
|
*/
|
|
4818
5260
|
ContributorInsightsStatus?: ContributorInsightsStatus | string;
|
|
@@ -4858,10 +5300,12 @@ export declare class ReplicaNotFoundException extends __BaseException {
|
|
|
4858
5300
|
*/
|
|
4859
5301
|
export interface ReplicaUpdate {
|
|
4860
5302
|
/**
|
|
5303
|
+
* @public
|
|
4861
5304
|
* <p>The parameters required for creating a replica on an existing global table.</p>
|
|
4862
5305
|
*/
|
|
4863
5306
|
Create?: CreateReplicaAction;
|
|
4864
5307
|
/**
|
|
5308
|
+
* @public
|
|
4865
5309
|
* <p>The name of the existing replica to be removed.</p>
|
|
4866
5310
|
*/
|
|
4867
5311
|
Delete?: DeleteReplicaAction;
|
|
@@ -4871,10 +5315,12 @@ export interface ReplicaUpdate {
|
|
|
4871
5315
|
*/
|
|
4872
5316
|
export interface UpdateGlobalTableInput {
|
|
4873
5317
|
/**
|
|
5318
|
+
* @public
|
|
4874
5319
|
* <p>The global table name.</p>
|
|
4875
5320
|
*/
|
|
4876
5321
|
GlobalTableName: string | undefined;
|
|
4877
5322
|
/**
|
|
5323
|
+
* @public
|
|
4878
5324
|
* <p>A list of Regions that should be added or removed from the global table.</p>
|
|
4879
5325
|
*/
|
|
4880
5326
|
ReplicaUpdates: ReplicaUpdate[] | undefined;
|
|
@@ -4884,6 +5330,7 @@ export interface UpdateGlobalTableInput {
|
|
|
4884
5330
|
*/
|
|
4885
5331
|
export interface UpdateGlobalTableOutput {
|
|
4886
5332
|
/**
|
|
5333
|
+
* @public
|
|
4887
5334
|
* <p>Contains the details of the global table.</p>
|
|
4888
5335
|
*/
|
|
4889
5336
|
GlobalTableDescription?: GlobalTableDescription;
|
|
@@ -4907,17 +5354,20 @@ export declare class IndexNotFoundException extends __BaseException {
|
|
|
4907
5354
|
*/
|
|
4908
5355
|
export interface GlobalTableGlobalSecondaryIndexSettingsUpdate {
|
|
4909
5356
|
/**
|
|
5357
|
+
* @public
|
|
4910
5358
|
* <p>The name of the global secondary index. The name must be unique among all other
|
|
4911
5359
|
* indexes on this table.</p>
|
|
4912
5360
|
*/
|
|
4913
5361
|
IndexName: string | undefined;
|
|
4914
5362
|
/**
|
|
5363
|
+
* @public
|
|
4915
5364
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
4916
5365
|
* <code>ThrottlingException.</code>
|
|
4917
5366
|
* </p>
|
|
4918
5367
|
*/
|
|
4919
5368
|
ProvisionedWriteCapacityUnits?: number;
|
|
4920
5369
|
/**
|
|
5370
|
+
* @public
|
|
4921
5371
|
* <p>Auto scaling settings for managing a global secondary index's write capacity
|
|
4922
5372
|
* units.</p>
|
|
4923
5373
|
*/
|
|
@@ -4930,16 +5380,19 @@ export interface GlobalTableGlobalSecondaryIndexSettingsUpdate {
|
|
|
4930
5380
|
*/
|
|
4931
5381
|
export interface ReplicaGlobalSecondaryIndexSettingsUpdate {
|
|
4932
5382
|
/**
|
|
5383
|
+
* @public
|
|
4933
5384
|
* <p>The name of the global secondary index. The name must be unique among all other
|
|
4934
5385
|
* indexes on this table.</p>
|
|
4935
5386
|
*/
|
|
4936
5387
|
IndexName: string | undefined;
|
|
4937
5388
|
/**
|
|
5389
|
+
* @public
|
|
4938
5390
|
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
|
|
4939
5391
|
* returns a <code>ThrottlingException</code>.</p>
|
|
4940
5392
|
*/
|
|
4941
5393
|
ProvisionedReadCapacityUnits?: number;
|
|
4942
5394
|
/**
|
|
5395
|
+
* @public
|
|
4943
5396
|
* <p>Auto scaling settings for managing a global secondary index replica's read capacity
|
|
4944
5397
|
* units.</p>
|
|
4945
5398
|
*/
|
|
@@ -4951,26 +5404,31 @@ export interface ReplicaGlobalSecondaryIndexSettingsUpdate {
|
|
|
4951
5404
|
*/
|
|
4952
5405
|
export interface ReplicaSettingsUpdate {
|
|
4953
5406
|
/**
|
|
5407
|
+
* @public
|
|
4954
5408
|
* <p>The Region of the replica to be added.</p>
|
|
4955
5409
|
*/
|
|
4956
5410
|
RegionName: string | undefined;
|
|
4957
5411
|
/**
|
|
5412
|
+
* @public
|
|
4958
5413
|
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
|
|
4959
5414
|
* returns a <code>ThrottlingException</code>. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#ProvisionedThroughput">Specifying Read and Write Requirements</a> in the <i>Amazon DynamoDB
|
|
4960
5415
|
* Developer Guide</i>. </p>
|
|
4961
5416
|
*/
|
|
4962
5417
|
ReplicaProvisionedReadCapacityUnits?: number;
|
|
4963
5418
|
/**
|
|
5419
|
+
* @public
|
|
4964
5420
|
* <p>Auto scaling settings for managing a global table replica's read capacity
|
|
4965
5421
|
* units.</p>
|
|
4966
5422
|
*/
|
|
4967
5423
|
ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate;
|
|
4968
5424
|
/**
|
|
5425
|
+
* @public
|
|
4969
5426
|
* <p>Represents the settings of a global secondary index for a global table that will be
|
|
4970
5427
|
* modified.</p>
|
|
4971
5428
|
*/
|
|
4972
5429
|
ReplicaGlobalSecondaryIndexSettingsUpdate?: ReplicaGlobalSecondaryIndexSettingsUpdate[];
|
|
4973
5430
|
/**
|
|
5431
|
+
* @public
|
|
4974
5432
|
* <p>Replica-specific table class. If not specified, uses the source table's table
|
|
4975
5433
|
* class.</p>
|
|
4976
5434
|
*/
|
|
@@ -4981,10 +5439,12 @@ export interface ReplicaSettingsUpdate {
|
|
|
4981
5439
|
*/
|
|
4982
5440
|
export interface UpdateGlobalTableSettingsInput {
|
|
4983
5441
|
/**
|
|
5442
|
+
* @public
|
|
4984
5443
|
* <p>The name of the global table</p>
|
|
4985
5444
|
*/
|
|
4986
5445
|
GlobalTableName: string | undefined;
|
|
4987
5446
|
/**
|
|
5447
|
+
* @public
|
|
4988
5448
|
* <p>The billing mode of the global table. If <code>GlobalTableBillingMode</code> is not
|
|
4989
5449
|
* specified, the global table defaults to <code>PROVISIONED</code> capacity billing
|
|
4990
5450
|
* mode.</p>
|
|
@@ -5004,22 +5464,26 @@ export interface UpdateGlobalTableSettingsInput {
|
|
|
5004
5464
|
*/
|
|
5005
5465
|
GlobalTableBillingMode?: BillingMode | string;
|
|
5006
5466
|
/**
|
|
5467
|
+
* @public
|
|
5007
5468
|
* <p>The maximum number of writes consumed per second before DynamoDB returns a
|
|
5008
5469
|
* <code>ThrottlingException.</code>
|
|
5009
5470
|
* </p>
|
|
5010
5471
|
*/
|
|
5011
5472
|
GlobalTableProvisionedWriteCapacityUnits?: number;
|
|
5012
5473
|
/**
|
|
5474
|
+
* @public
|
|
5013
5475
|
* <p>Auto scaling settings for managing provisioned write capacity for the global
|
|
5014
5476
|
* table.</p>
|
|
5015
5477
|
*/
|
|
5016
5478
|
GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate?: AutoScalingSettingsUpdate;
|
|
5017
5479
|
/**
|
|
5480
|
+
* @public
|
|
5018
5481
|
* <p>Represents the settings of a global secondary index for a global table that will be
|
|
5019
5482
|
* modified.</p>
|
|
5020
5483
|
*/
|
|
5021
5484
|
GlobalTableGlobalSecondaryIndexSettingsUpdate?: GlobalTableGlobalSecondaryIndexSettingsUpdate[];
|
|
5022
5485
|
/**
|
|
5486
|
+
* @public
|
|
5023
5487
|
* <p>Represents the settings for a global table in a Region that will be modified.</p>
|
|
5024
5488
|
*/
|
|
5025
5489
|
ReplicaSettingsUpdate?: ReplicaSettingsUpdate[];
|
|
@@ -5029,10 +5493,12 @@ export interface UpdateGlobalTableSettingsInput {
|
|
|
5029
5493
|
*/
|
|
5030
5494
|
export interface UpdateGlobalTableSettingsOutput {
|
|
5031
5495
|
/**
|
|
5496
|
+
* @public
|
|
5032
5497
|
* <p>The name of the global table.</p>
|
|
5033
5498
|
*/
|
|
5034
5499
|
GlobalTableName?: string;
|
|
5035
5500
|
/**
|
|
5501
|
+
* @public
|
|
5036
5502
|
* <p>The Region-specific settings for the global table.</p>
|
|
5037
5503
|
*/
|
|
5038
5504
|
ReplicaSettings?: ReplicaSettingsDescription[];
|
|
@@ -5044,10 +5510,12 @@ export interface UpdateGlobalTableSettingsOutput {
|
|
|
5044
5510
|
*/
|
|
5045
5511
|
export interface UpdateGlobalSecondaryIndexAction {
|
|
5046
5512
|
/**
|
|
5513
|
+
* @public
|
|
5047
5514
|
* <p>The name of the global secondary index to be updated.</p>
|
|
5048
5515
|
*/
|
|
5049
5516
|
IndexName: string | undefined;
|
|
5050
5517
|
/**
|
|
5518
|
+
* @public
|
|
5051
5519
|
* <p>Represents the provisioned throughput settings for the specified global secondary
|
|
5052
5520
|
* index.</p>
|
|
5053
5521
|
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
|
|
@@ -5075,11 +5543,13 @@ export interface UpdateGlobalSecondaryIndexAction {
|
|
|
5075
5543
|
*/
|
|
5076
5544
|
export interface GlobalSecondaryIndexUpdate {
|
|
5077
5545
|
/**
|
|
5546
|
+
* @public
|
|
5078
5547
|
* <p>The name of an existing global secondary index, along with new provisioned throughput
|
|
5079
5548
|
* settings to be applied to that index.</p>
|
|
5080
5549
|
*/
|
|
5081
5550
|
Update?: UpdateGlobalSecondaryIndexAction;
|
|
5082
5551
|
/**
|
|
5552
|
+
* @public
|
|
5083
5553
|
* <p>The parameters required for creating a global secondary index on an existing
|
|
5084
5554
|
* table:</p>
|
|
5085
5555
|
* <ul>
|
|
@@ -5112,6 +5582,7 @@ export interface GlobalSecondaryIndexUpdate {
|
|
|
5112
5582
|
*/
|
|
5113
5583
|
Create?: CreateGlobalSecondaryIndexAction;
|
|
5114
5584
|
/**
|
|
5585
|
+
* @public
|
|
5115
5586
|
* <p>The name of an existing global secondary index to be removed.</p>
|
|
5116
5587
|
*/
|
|
5117
5588
|
Delete?: DeleteGlobalSecondaryIndexAction;
|
|
@@ -5122,10 +5593,12 @@ export interface GlobalSecondaryIndexUpdate {
|
|
|
5122
5593
|
*/
|
|
5123
5594
|
export interface UpdateReplicationGroupMemberAction {
|
|
5124
5595
|
/**
|
|
5596
|
+
* @public
|
|
5125
5597
|
* <p>The Region where the replica exists.</p>
|
|
5126
5598
|
*/
|
|
5127
5599
|
RegionName: string | undefined;
|
|
5128
5600
|
/**
|
|
5601
|
+
* @public
|
|
5129
5602
|
* <p>The KMS key of the replica that should be used for KMS
|
|
5130
5603
|
* encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or
|
|
5131
5604
|
* alias ARN. Note that you should only provide this parameter if the key is different from
|
|
@@ -5133,15 +5606,18 @@ export interface UpdateReplicationGroupMemberAction {
|
|
|
5133
5606
|
*/
|
|
5134
5607
|
KMSMasterKeyId?: string;
|
|
5135
5608
|
/**
|
|
5609
|
+
* @public
|
|
5136
5610
|
* <p>Replica-specific provisioned throughput. If not specified, uses the source table's
|
|
5137
5611
|
* provisioned throughput settings.</p>
|
|
5138
5612
|
*/
|
|
5139
5613
|
ProvisionedThroughputOverride?: ProvisionedThroughputOverride;
|
|
5140
5614
|
/**
|
|
5615
|
+
* @public
|
|
5141
5616
|
* <p>Replica-specific global secondary index settings.</p>
|
|
5142
5617
|
*/
|
|
5143
5618
|
GlobalSecondaryIndexes?: ReplicaGlobalSecondaryIndex[];
|
|
5144
5619
|
/**
|
|
5620
|
+
* @public
|
|
5145
5621
|
* <p>Replica-specific table class. If not specified, uses the source table's table
|
|
5146
5622
|
* class.</p>
|
|
5147
5623
|
*/
|
|
@@ -5174,14 +5650,17 @@ export interface UpdateReplicationGroupMemberAction {
|
|
|
5174
5650
|
*/
|
|
5175
5651
|
export interface ReplicationGroupUpdate {
|
|
5176
5652
|
/**
|
|
5653
|
+
* @public
|
|
5177
5654
|
* <p>The parameters required for creating a replica for the table.</p>
|
|
5178
5655
|
*/
|
|
5179
5656
|
Create?: CreateReplicationGroupMemberAction;
|
|
5180
5657
|
/**
|
|
5658
|
+
* @public
|
|
5181
5659
|
* <p>The parameters required for updating a replica for the table.</p>
|
|
5182
5660
|
*/
|
|
5183
5661
|
Update?: UpdateReplicationGroupMemberAction;
|
|
5184
5662
|
/**
|
|
5663
|
+
* @public
|
|
5185
5664
|
* <p>The parameters required for deleting a replica for the table.</p>
|
|
5186
5665
|
*/
|
|
5187
5666
|
Delete?: DeleteReplicationGroupMemberAction;
|
|
@@ -5192,16 +5671,19 @@ export interface ReplicationGroupUpdate {
|
|
|
5192
5671
|
*/
|
|
5193
5672
|
export interface UpdateTableInput {
|
|
5194
5673
|
/**
|
|
5674
|
+
* @public
|
|
5195
5675
|
* <p>An array of attributes that describe the key schema for the table and indexes. If you
|
|
5196
5676
|
* are adding a new global secondary index to the table, <code>AttributeDefinitions</code>
|
|
5197
5677
|
* must include the key element(s) of the new index.</p>
|
|
5198
5678
|
*/
|
|
5199
5679
|
AttributeDefinitions?: AttributeDefinition[];
|
|
5200
5680
|
/**
|
|
5681
|
+
* @public
|
|
5201
5682
|
* <p>The name of the table to be updated.</p>
|
|
5202
5683
|
*/
|
|
5203
5684
|
TableName: string | undefined;
|
|
5204
5685
|
/**
|
|
5686
|
+
* @public
|
|
5205
5687
|
* <p>Controls how you are charged for read and write throughput and how you manage
|
|
5206
5688
|
* capacity. When switching from pay-per-request to provisioned capacity, initial
|
|
5207
5689
|
* provisioned capacity values must be set. The initial provisioned capacity values are
|
|
@@ -5223,10 +5705,12 @@ export interface UpdateTableInput {
|
|
|
5223
5705
|
*/
|
|
5224
5706
|
BillingMode?: BillingMode | string;
|
|
5225
5707
|
/**
|
|
5708
|
+
* @public
|
|
5226
5709
|
* <p>The new provisioned throughput settings for the specified table or index.</p>
|
|
5227
5710
|
*/
|
|
5228
5711
|
ProvisionedThroughput?: ProvisionedThroughput;
|
|
5229
5712
|
/**
|
|
5713
|
+
* @public
|
|
5230
5714
|
* <p>An array of one or more global secondary indexes for the table. For each index in the
|
|
5231
5715
|
* array, you can request one action:</p>
|
|
5232
5716
|
* <ul>
|
|
@@ -5252,6 +5736,7 @@ export interface UpdateTableInput {
|
|
|
5252
5736
|
*/
|
|
5253
5737
|
GlobalSecondaryIndexUpdates?: GlobalSecondaryIndexUpdate[];
|
|
5254
5738
|
/**
|
|
5739
|
+
* @public
|
|
5255
5740
|
* <p>Represents the DynamoDB Streams configuration for the table.</p>
|
|
5256
5741
|
* <note>
|
|
5257
5742
|
* <p>You receive a <code>ResourceInUseException</code> if you try to enable a stream on
|
|
@@ -5261,10 +5746,12 @@ export interface UpdateTableInput {
|
|
|
5261
5746
|
*/
|
|
5262
5747
|
StreamSpecification?: StreamSpecification;
|
|
5263
5748
|
/**
|
|
5749
|
+
* @public
|
|
5264
5750
|
* <p>The new server-side encryption settings for the specified table.</p>
|
|
5265
5751
|
*/
|
|
5266
5752
|
SSESpecification?: SSESpecification;
|
|
5267
5753
|
/**
|
|
5754
|
+
* @public
|
|
5268
5755
|
* <p>A list of replica update actions (create, delete, or update) for the table.</p>
|
|
5269
5756
|
* <note>
|
|
5270
5757
|
* <p>This property only applies to <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html">Version 2019.11.21 (Current)</a>
|
|
@@ -5274,11 +5761,13 @@ export interface UpdateTableInput {
|
|
|
5274
5761
|
*/
|
|
5275
5762
|
ReplicaUpdates?: ReplicationGroupUpdate[];
|
|
5276
5763
|
/**
|
|
5764
|
+
* @public
|
|
5277
5765
|
* <p>The table class of the table to be updated. Valid values are <code>STANDARD</code> and
|
|
5278
5766
|
* <code>STANDARD_INFREQUENT_ACCESS</code>.</p>
|
|
5279
5767
|
*/
|
|
5280
5768
|
TableClass?: TableClass | string;
|
|
5281
5769
|
/**
|
|
5770
|
+
* @public
|
|
5282
5771
|
* <p>Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.</p>
|
|
5283
5772
|
*/
|
|
5284
5773
|
DeletionProtectionEnabled?: boolean;
|
|
@@ -5289,6 +5778,7 @@ export interface UpdateTableInput {
|
|
|
5289
5778
|
*/
|
|
5290
5779
|
export interface UpdateTableOutput {
|
|
5291
5780
|
/**
|
|
5781
|
+
* @public
|
|
5292
5782
|
* <p>Represents the properties of the table.</p>
|
|
5293
5783
|
*/
|
|
5294
5784
|
TableDescription?: TableDescription;
|
|
@@ -5300,10 +5790,12 @@ export interface UpdateTableOutput {
|
|
|
5300
5790
|
*/
|
|
5301
5791
|
export interface GlobalSecondaryIndexAutoScalingUpdate {
|
|
5302
5792
|
/**
|
|
5793
|
+
* @public
|
|
5303
5794
|
* <p>The name of the global secondary index.</p>
|
|
5304
5795
|
*/
|
|
5305
5796
|
IndexName?: string;
|
|
5306
5797
|
/**
|
|
5798
|
+
* @public
|
|
5307
5799
|
* <p>Represents the auto scaling settings to be modified for a global table or global
|
|
5308
5800
|
* secondary index.</p>
|
|
5309
5801
|
*/
|
|
@@ -5316,10 +5808,12 @@ export interface GlobalSecondaryIndexAutoScalingUpdate {
|
|
|
5316
5808
|
*/
|
|
5317
5809
|
export interface ReplicaGlobalSecondaryIndexAutoScalingUpdate {
|
|
5318
5810
|
/**
|
|
5811
|
+
* @public
|
|
5319
5812
|
* <p>The name of the global secondary index.</p>
|
|
5320
5813
|
*/
|
|
5321
5814
|
IndexName?: string;
|
|
5322
5815
|
/**
|
|
5816
|
+
* @public
|
|
5323
5817
|
* <p>Represents the auto scaling settings to be modified for a global table or global
|
|
5324
5818
|
* secondary index.</p>
|
|
5325
5819
|
*/
|
|
@@ -5331,15 +5825,18 @@ export interface ReplicaGlobalSecondaryIndexAutoScalingUpdate {
|
|
|
5331
5825
|
*/
|
|
5332
5826
|
export interface ReplicaAutoScalingUpdate {
|
|
5333
5827
|
/**
|
|
5828
|
+
* @public
|
|
5334
5829
|
* <p>The Region where the replica exists.</p>
|
|
5335
5830
|
*/
|
|
5336
5831
|
RegionName: string | undefined;
|
|
5337
5832
|
/**
|
|
5833
|
+
* @public
|
|
5338
5834
|
* <p>Represents the auto scaling settings of global secondary indexes that will be
|
|
5339
5835
|
* modified.</p>
|
|
5340
5836
|
*/
|
|
5341
5837
|
ReplicaGlobalSecondaryIndexUpdates?: ReplicaGlobalSecondaryIndexAutoScalingUpdate[];
|
|
5342
5838
|
/**
|
|
5839
|
+
* @public
|
|
5343
5840
|
* <p>Represents the auto scaling settings to be modified for a global table or global
|
|
5344
5841
|
* secondary index.</p>
|
|
5345
5842
|
*/
|
|
@@ -5350,20 +5847,24 @@ export interface ReplicaAutoScalingUpdate {
|
|
|
5350
5847
|
*/
|
|
5351
5848
|
export interface UpdateTableReplicaAutoScalingInput {
|
|
5352
5849
|
/**
|
|
5850
|
+
* @public
|
|
5353
5851
|
* <p>Represents the auto scaling settings of the global secondary indexes of the replica to
|
|
5354
5852
|
* be updated.</p>
|
|
5355
5853
|
*/
|
|
5356
5854
|
GlobalSecondaryIndexUpdates?: GlobalSecondaryIndexAutoScalingUpdate[];
|
|
5357
5855
|
/**
|
|
5856
|
+
* @public
|
|
5358
5857
|
* <p>The name of the global table to be updated.</p>
|
|
5359
5858
|
*/
|
|
5360
5859
|
TableName: string | undefined;
|
|
5361
5860
|
/**
|
|
5861
|
+
* @public
|
|
5362
5862
|
* <p>Represents the auto scaling settings to be modified for a global table or global
|
|
5363
5863
|
* secondary index.</p>
|
|
5364
5864
|
*/
|
|
5365
5865
|
ProvisionedWriteCapacityAutoScalingUpdate?: AutoScalingSettingsUpdate;
|
|
5366
5866
|
/**
|
|
5867
|
+
* @public
|
|
5367
5868
|
* <p>Represents the auto scaling settings of replicas of the table that will be
|
|
5368
5869
|
* modified.</p>
|
|
5369
5870
|
*/
|
|
@@ -5374,6 +5875,7 @@ export interface UpdateTableReplicaAutoScalingInput {
|
|
|
5374
5875
|
*/
|
|
5375
5876
|
export interface UpdateTableReplicaAutoScalingOutput {
|
|
5376
5877
|
/**
|
|
5878
|
+
* @public
|
|
5377
5879
|
* <p>Returns information about the auto scaling settings of a table with replicas.</p>
|
|
5378
5880
|
*/
|
|
5379
5881
|
TableAutoScalingDescription?: TableAutoScalingDescription;
|
|
@@ -5385,10 +5887,12 @@ export interface UpdateTableReplicaAutoScalingOutput {
|
|
|
5385
5887
|
*/
|
|
5386
5888
|
export interface TimeToLiveSpecification {
|
|
5387
5889
|
/**
|
|
5890
|
+
* @public
|
|
5388
5891
|
* <p>Indicates whether TTL is to be enabled (true) or disabled (false) on the table.</p>
|
|
5389
5892
|
*/
|
|
5390
5893
|
Enabled: boolean | undefined;
|
|
5391
5894
|
/**
|
|
5895
|
+
* @public
|
|
5392
5896
|
* <p>The name of the TTL attribute used to store the expiration time for items in the
|
|
5393
5897
|
* table.</p>
|
|
5394
5898
|
*/
|
|
@@ -5400,10 +5904,12 @@ export interface TimeToLiveSpecification {
|
|
|
5400
5904
|
*/
|
|
5401
5905
|
export interface UpdateTimeToLiveInput {
|
|
5402
5906
|
/**
|
|
5907
|
+
* @public
|
|
5403
5908
|
* <p>The name of the table to be configured.</p>
|
|
5404
5909
|
*/
|
|
5405
5910
|
TableName: string | undefined;
|
|
5406
5911
|
/**
|
|
5912
|
+
* @public
|
|
5407
5913
|
* <p>Represents the settings used to enable or disable Time to Live for the specified
|
|
5408
5914
|
* table.</p>
|
|
5409
5915
|
*/
|
|
@@ -5414,6 +5920,7 @@ export interface UpdateTimeToLiveInput {
|
|
|
5414
5920
|
*/
|
|
5415
5921
|
export interface UpdateTimeToLiveOutput {
|
|
5416
5922
|
/**
|
|
5923
|
+
* @public
|
|
5417
5924
|
* <p>Represents the output of an <code>UpdateTimeToLive</code> operation.</p>
|
|
5418
5925
|
*/
|
|
5419
5926
|
TimeToLiveSpecification?: TimeToLiveSpecification;
|
|
@@ -5432,6 +5939,7 @@ export type AttributeValue = AttributeValue.BMember | AttributeValue.BOOLMember
|
|
|
5432
5939
|
*/
|
|
5433
5940
|
export declare namespace AttributeValue {
|
|
5434
5941
|
/**
|
|
5942
|
+
* @public
|
|
5435
5943
|
* <p>An attribute of type String. For example:</p>
|
|
5436
5944
|
* <p>
|
|
5437
5945
|
* <code>"S": "Hello"</code>
|
|
@@ -5451,6 +5959,7 @@ export declare namespace AttributeValue {
|
|
|
5451
5959
|
$unknown?: never;
|
|
5452
5960
|
}
|
|
5453
5961
|
/**
|
|
5962
|
+
* @public
|
|
5454
5963
|
* <p>An attribute of type Number. For example:</p>
|
|
5455
5964
|
* <p>
|
|
5456
5965
|
* <code>"N": "123.45"</code>
|
|
@@ -5473,6 +5982,7 @@ export declare namespace AttributeValue {
|
|
|
5473
5982
|
$unknown?: never;
|
|
5474
5983
|
}
|
|
5475
5984
|
/**
|
|
5985
|
+
* @public
|
|
5476
5986
|
* <p>An attribute of type Binary. For example:</p>
|
|
5477
5987
|
* <p>
|
|
5478
5988
|
* <code>"B": "dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk"</code>
|
|
@@ -5492,6 +6002,7 @@ export declare namespace AttributeValue {
|
|
|
5492
6002
|
$unknown?: never;
|
|
5493
6003
|
}
|
|
5494
6004
|
/**
|
|
6005
|
+
* @public
|
|
5495
6006
|
* <p>An attribute of type String Set. For example:</p>
|
|
5496
6007
|
* <p>
|
|
5497
6008
|
* <code>"SS": ["Giraffe", "Hippo" ,"Zebra"]</code>
|
|
@@ -5511,6 +6022,7 @@ export declare namespace AttributeValue {
|
|
|
5511
6022
|
$unknown?: never;
|
|
5512
6023
|
}
|
|
5513
6024
|
/**
|
|
6025
|
+
* @public
|
|
5514
6026
|
* <p>An attribute of type Number Set. For example:</p>
|
|
5515
6027
|
* <p>
|
|
5516
6028
|
* <code>"NS": ["42.2", "-19", "7.5", "3.14"]</code>
|
|
@@ -5533,6 +6045,7 @@ export declare namespace AttributeValue {
|
|
|
5533
6045
|
$unknown?: never;
|
|
5534
6046
|
}
|
|
5535
6047
|
/**
|
|
6048
|
+
* @public
|
|
5536
6049
|
* <p>An attribute of type Binary Set. For example:</p>
|
|
5537
6050
|
* <p>
|
|
5538
6051
|
* <code>"BS": ["U3Vubnk=", "UmFpbnk=", "U25vd3k="]</code>
|
|
@@ -5552,6 +6065,7 @@ export declare namespace AttributeValue {
|
|
|
5552
6065
|
$unknown?: never;
|
|
5553
6066
|
}
|
|
5554
6067
|
/**
|
|
6068
|
+
* @public
|
|
5555
6069
|
* <p>An attribute of type Map. For example:</p>
|
|
5556
6070
|
* <p>
|
|
5557
6071
|
* <code>"M": \{"Name": \{"S": "Joe"\}, "Age": \{"N": "35"\}\}</code>
|
|
@@ -5571,6 +6085,7 @@ export declare namespace AttributeValue {
|
|
|
5571
6085
|
$unknown?: never;
|
|
5572
6086
|
}
|
|
5573
6087
|
/**
|
|
6088
|
+
* @public
|
|
5574
6089
|
* <p>An attribute of type List. For example:</p>
|
|
5575
6090
|
* <p>
|
|
5576
6091
|
* <code>"L": [ \{"S": "Cookies"\} , \{"S": "Coffee"\}, \{"N": "3.14159"\}]</code>
|
|
@@ -5590,6 +6105,7 @@ export declare namespace AttributeValue {
|
|
|
5590
6105
|
$unknown?: never;
|
|
5591
6106
|
}
|
|
5592
6107
|
/**
|
|
6108
|
+
* @public
|
|
5593
6109
|
* <p>An attribute of type Null. For example:</p>
|
|
5594
6110
|
* <p>
|
|
5595
6111
|
* <code>"NULL": true</code>
|
|
@@ -5609,6 +6125,7 @@ export declare namespace AttributeValue {
|
|
|
5609
6125
|
$unknown?: never;
|
|
5610
6126
|
}
|
|
5611
6127
|
/**
|
|
6128
|
+
* @public
|
|
5612
6129
|
* <p>An attribute of type Boolean. For example:</p>
|
|
5613
6130
|
* <p>
|
|
5614
6131
|
* <code>"BOOL": true</code>
|
|
@@ -5627,6 +6144,9 @@ export declare namespace AttributeValue {
|
|
|
5627
6144
|
BOOL: boolean;
|
|
5628
6145
|
$unknown?: never;
|
|
5629
6146
|
}
|
|
6147
|
+
/**
|
|
6148
|
+
* @public
|
|
6149
|
+
*/
|
|
5630
6150
|
interface $UnknownMember {
|
|
5631
6151
|
S?: never;
|
|
5632
6152
|
N?: never;
|
|
@@ -5670,6 +6190,7 @@ export declare namespace AttributeValue {
|
|
|
5670
6190
|
*/
|
|
5671
6191
|
export interface AttributeValueUpdate {
|
|
5672
6192
|
/**
|
|
6193
|
+
* @public
|
|
5673
6194
|
* <p>Represents the data for an attribute.</p>
|
|
5674
6195
|
* <p>Each attribute value is described as a name-value pair. The name is the data type, and
|
|
5675
6196
|
* the value is the data itself.</p>
|
|
@@ -5678,6 +6199,7 @@ export interface AttributeValueUpdate {
|
|
|
5678
6199
|
*/
|
|
5679
6200
|
Value?: AttributeValue;
|
|
5680
6201
|
/**
|
|
6202
|
+
* @public
|
|
5681
6203
|
* <p>Specifies how to perform the update. Valid values are <code>PUT</code> (default),
|
|
5682
6204
|
* <code>DELETE</code>, and <code>ADD</code>. The behavior depends on whether the
|
|
5683
6205
|
* specified primary key already exists in the table.</p>
|
|
@@ -5780,14 +6302,17 @@ export interface AttributeValueUpdate {
|
|
|
5780
6302
|
*/
|
|
5781
6303
|
export interface BatchStatementError {
|
|
5782
6304
|
/**
|
|
6305
|
+
* @public
|
|
5783
6306
|
* <p> The error code associated with the failed PartiQL batch statement. </p>
|
|
5784
6307
|
*/
|
|
5785
6308
|
Code?: BatchStatementErrorCodeEnum | string;
|
|
5786
6309
|
/**
|
|
6310
|
+
* @public
|
|
5787
6311
|
* <p> The error message associated with the PartiQL batch response. </p>
|
|
5788
6312
|
*/
|
|
5789
6313
|
Message?: string;
|
|
5790
6314
|
/**
|
|
6315
|
+
* @public
|
|
5791
6316
|
* <p>The item which caused the condition check to fail. This will be set if ReturnValuesOnConditionCheckFailure is specified as <code>ALL_OLD</code>.</p>
|
|
5792
6317
|
*/
|
|
5793
6318
|
Item?: Record<string, AttributeValue>;
|
|
@@ -5798,18 +6323,22 @@ export interface BatchStatementError {
|
|
|
5798
6323
|
*/
|
|
5799
6324
|
export interface BatchStatementRequest {
|
|
5800
6325
|
/**
|
|
6326
|
+
* @public
|
|
5801
6327
|
* <p> A valid PartiQL statement. </p>
|
|
5802
6328
|
*/
|
|
5803
6329
|
Statement: string | undefined;
|
|
5804
6330
|
/**
|
|
6331
|
+
* @public
|
|
5805
6332
|
* <p> The parameters associated with a PartiQL statement in the batch request. </p>
|
|
5806
6333
|
*/
|
|
5807
6334
|
Parameters?: AttributeValue[];
|
|
5808
6335
|
/**
|
|
6336
|
+
* @public
|
|
5809
6337
|
* <p> The read consistency of the PartiQL batch request. </p>
|
|
5810
6338
|
*/
|
|
5811
6339
|
ConsistentRead?: boolean;
|
|
5812
6340
|
/**
|
|
6341
|
+
* @public
|
|
5813
6342
|
* <p>An optional parameter that returns the item attributes for a PartiQL batch request
|
|
5814
6343
|
* operation that failed a condition check.</p>
|
|
5815
6344
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
@@ -5827,14 +6356,17 @@ export interface BatchStatementRequest {
|
|
|
5827
6356
|
*/
|
|
5828
6357
|
export interface CancellationReason {
|
|
5829
6358
|
/**
|
|
6359
|
+
* @public
|
|
5830
6360
|
* <p>Item in the request which caused the transaction to get cancelled.</p>
|
|
5831
6361
|
*/
|
|
5832
6362
|
Item?: Record<string, AttributeValue>;
|
|
5833
6363
|
/**
|
|
6364
|
+
* @public
|
|
5834
6365
|
* <p>Status code for the result of the cancelled transaction.</p>
|
|
5835
6366
|
*/
|
|
5836
6367
|
Code?: string;
|
|
5837
6368
|
/**
|
|
6369
|
+
* @public
|
|
5838
6370
|
* <p>Cancellation reason message description.</p>
|
|
5839
6371
|
*/
|
|
5840
6372
|
Message?: string;
|
|
@@ -5865,6 +6397,7 @@ export interface CancellationReason {
|
|
|
5865
6397
|
*/
|
|
5866
6398
|
export interface Condition {
|
|
5867
6399
|
/**
|
|
6400
|
+
* @public
|
|
5868
6401
|
* <p>One or more values to evaluate against the supplied attribute. The number of values in
|
|
5869
6402
|
* the list depends on the <code>ComparisonOperator</code> being used.</p>
|
|
5870
6403
|
* <p>For type Number, value comparisons are numeric.</p>
|
|
@@ -5876,6 +6409,7 @@ export interface Condition {
|
|
|
5876
6409
|
*/
|
|
5877
6410
|
AttributeValueList?: AttributeValue[];
|
|
5878
6411
|
/**
|
|
6412
|
+
* @public
|
|
5879
6413
|
* <p>A comparator for evaluating attributes. For example, equals, greater than, less than,
|
|
5880
6414
|
* etc.</p>
|
|
5881
6415
|
* <p>The following comparison operators are available:</p>
|
|
@@ -6073,6 +6607,7 @@ export declare class ConditionalCheckFailedException extends __BaseException {
|
|
|
6073
6607
|
readonly name: "ConditionalCheckFailedException";
|
|
6074
6608
|
readonly $fault: "client";
|
|
6075
6609
|
/**
|
|
6610
|
+
* @public
|
|
6076
6611
|
* <p>Item which caused the <code>ConditionalCheckFailedException</code>.</p>
|
|
6077
6612
|
*/
|
|
6078
6613
|
Item?: Record<string, AttributeValue>;
|
|
@@ -6087,6 +6622,7 @@ export declare class ConditionalCheckFailedException extends __BaseException {
|
|
|
6087
6622
|
*/
|
|
6088
6623
|
export interface DeleteRequest {
|
|
6089
6624
|
/**
|
|
6625
|
+
* @public
|
|
6090
6626
|
* <p>A map of attribute name to attribute values, representing the primary key of the item
|
|
6091
6627
|
* to delete. All of the table's primary key attributes must be specified, and their data
|
|
6092
6628
|
* types must match those of the table's key schema.</p>
|
|
@@ -6098,24 +6634,29 @@ export interface DeleteRequest {
|
|
|
6098
6634
|
*/
|
|
6099
6635
|
export interface ExecuteStatementInput {
|
|
6100
6636
|
/**
|
|
6637
|
+
* @public
|
|
6101
6638
|
* <p>The PartiQL statement representing the operation to run.</p>
|
|
6102
6639
|
*/
|
|
6103
6640
|
Statement: string | undefined;
|
|
6104
6641
|
/**
|
|
6642
|
+
* @public
|
|
6105
6643
|
* <p>The parameters for the PartiQL statement, if any.</p>
|
|
6106
6644
|
*/
|
|
6107
6645
|
Parameters?: AttributeValue[];
|
|
6108
6646
|
/**
|
|
6647
|
+
* @public
|
|
6109
6648
|
* <p>The consistency of a read operation. If set to <code>true</code>, then a strongly
|
|
6110
6649
|
* consistent read is used; otherwise, an eventually consistent read is used.</p>
|
|
6111
6650
|
*/
|
|
6112
6651
|
ConsistentRead?: boolean;
|
|
6113
6652
|
/**
|
|
6653
|
+
* @public
|
|
6114
6654
|
* <p>Set this value to get remaining results, if <code>NextToken</code> was returned in the
|
|
6115
6655
|
* statement response.</p>
|
|
6116
6656
|
*/
|
|
6117
6657
|
NextToken?: string;
|
|
6118
6658
|
/**
|
|
6659
|
+
* @public
|
|
6119
6660
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
6120
6661
|
* consumption that is returned in the response:</p>
|
|
6121
6662
|
* <ul>
|
|
@@ -6144,6 +6685,7 @@ export interface ExecuteStatementInput {
|
|
|
6144
6685
|
*/
|
|
6145
6686
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
6146
6687
|
/**
|
|
6688
|
+
* @public
|
|
6147
6689
|
* <p>The maximum number of items to evaluate (not necessarily the number of matching
|
|
6148
6690
|
* items). If DynamoDB processes the number of items up to the limit while processing the
|
|
6149
6691
|
* results, it stops the operation and returns the matching values up to that point, along
|
|
@@ -6155,6 +6697,7 @@ export interface ExecuteStatementInput {
|
|
|
6155
6697
|
*/
|
|
6156
6698
|
Limit?: number;
|
|
6157
6699
|
/**
|
|
6700
|
+
* @public
|
|
6158
6701
|
* <p>An optional parameter that returns the item attributes for an
|
|
6159
6702
|
* <code>ExecuteStatement</code> operation that failed a condition check.</p>
|
|
6160
6703
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
@@ -6170,15 +6713,18 @@ export interface ExecuteStatementInput {
|
|
|
6170
6713
|
*/
|
|
6171
6714
|
export interface Get {
|
|
6172
6715
|
/**
|
|
6716
|
+
* @public
|
|
6173
6717
|
* <p>A map of attribute names to <code>AttributeValue</code> objects that specifies the
|
|
6174
6718
|
* primary key of the item to retrieve.</p>
|
|
6175
6719
|
*/
|
|
6176
6720
|
Key: Record<string, AttributeValue> | undefined;
|
|
6177
6721
|
/**
|
|
6722
|
+
* @public
|
|
6178
6723
|
* <p>The name of the table from which to retrieve the specified item.</p>
|
|
6179
6724
|
*/
|
|
6180
6725
|
TableName: string | undefined;
|
|
6181
6726
|
/**
|
|
6727
|
+
* @public
|
|
6182
6728
|
* <p>A string that identifies one or more attributes of the specified item to retrieve from
|
|
6183
6729
|
* the table. The attributes in the expression must be separated by commas. If no attribute
|
|
6184
6730
|
* names are specified, then all attributes of the specified item are returned. If any of
|
|
@@ -6186,6 +6732,7 @@ export interface Get {
|
|
|
6186
6732
|
*/
|
|
6187
6733
|
ProjectionExpression?: string;
|
|
6188
6734
|
/**
|
|
6735
|
+
* @public
|
|
6189
6736
|
* <p>One or more substitution tokens for attribute names in the ProjectionExpression
|
|
6190
6737
|
* parameter.</p>
|
|
6191
6738
|
*/
|
|
@@ -6197,10 +6744,12 @@ export interface Get {
|
|
|
6197
6744
|
*/
|
|
6198
6745
|
export interface GetItemInput {
|
|
6199
6746
|
/**
|
|
6747
|
+
* @public
|
|
6200
6748
|
* <p>The name of the table containing the requested item.</p>
|
|
6201
6749
|
*/
|
|
6202
6750
|
TableName: string | undefined;
|
|
6203
6751
|
/**
|
|
6752
|
+
* @public
|
|
6204
6753
|
* <p>A map of attribute names to <code>AttributeValue</code> objects, representing the
|
|
6205
6754
|
* primary key of the item to retrieve.</p>
|
|
6206
6755
|
* <p>For the primary key, you must provide all of the attributes. For example, with a
|
|
@@ -6210,18 +6759,21 @@ export interface GetItemInput {
|
|
|
6210
6759
|
*/
|
|
6211
6760
|
Key: Record<string, AttributeValue> | undefined;
|
|
6212
6761
|
/**
|
|
6762
|
+
* @public
|
|
6213
6763
|
* <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more
|
|
6214
6764
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer
|
|
6215
6765
|
* Guide</i>.</p>
|
|
6216
6766
|
*/
|
|
6217
6767
|
AttributesToGet?: string[];
|
|
6218
6768
|
/**
|
|
6769
|
+
* @public
|
|
6219
6770
|
* <p>Determines the read consistency model: If set to <code>true</code>, then the operation
|
|
6220
6771
|
* uses strongly consistent reads; otherwise, the operation uses eventually consistent
|
|
6221
6772
|
* reads.</p>
|
|
6222
6773
|
*/
|
|
6223
6774
|
ConsistentRead?: boolean;
|
|
6224
6775
|
/**
|
|
6776
|
+
* @public
|
|
6225
6777
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
6226
6778
|
* consumption that is returned in the response:</p>
|
|
6227
6779
|
* <ul>
|
|
@@ -6250,6 +6802,7 @@ export interface GetItemInput {
|
|
|
6250
6802
|
*/
|
|
6251
6803
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
6252
6804
|
/**
|
|
6805
|
+
* @public
|
|
6253
6806
|
* <p>A string that identifies one or more attributes to retrieve from the table. These
|
|
6254
6807
|
* attributes can include scalars, sets, or elements of a JSON document. The attributes in
|
|
6255
6808
|
* the expression must be separated by commas.</p>
|
|
@@ -6260,6 +6813,7 @@ export interface GetItemInput {
|
|
|
6260
6813
|
*/
|
|
6261
6814
|
ProjectionExpression?: string;
|
|
6262
6815
|
/**
|
|
6816
|
+
* @public
|
|
6263
6817
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
6264
6818
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
6265
6819
|
* <ul>
|
|
@@ -6320,11 +6874,13 @@ export interface GetItemInput {
|
|
|
6320
6874
|
*/
|
|
6321
6875
|
export interface GetItemOutput {
|
|
6322
6876
|
/**
|
|
6877
|
+
* @public
|
|
6323
6878
|
* <p>A map of attribute names to <code>AttributeValue</code> objects, as specified by
|
|
6324
6879
|
* <code>ProjectionExpression</code>.</p>
|
|
6325
6880
|
*/
|
|
6326
6881
|
Item?: Record<string, AttributeValue>;
|
|
6327
6882
|
/**
|
|
6883
|
+
* @public
|
|
6328
6884
|
* <p>The capacity units consumed by the <code>GetItem</code> operation. The data returned
|
|
6329
6885
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
6330
6886
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
@@ -6343,11 +6899,13 @@ export interface GetItemOutput {
|
|
|
6343
6899
|
*/
|
|
6344
6900
|
export interface ItemCollectionMetrics {
|
|
6345
6901
|
/**
|
|
6902
|
+
* @public
|
|
6346
6903
|
* <p>The partition key value of the item collection. This value is the same as the
|
|
6347
6904
|
* partition key value of the item.</p>
|
|
6348
6905
|
*/
|
|
6349
6906
|
ItemCollectionKey?: Record<string, AttributeValue>;
|
|
6350
6907
|
/**
|
|
6908
|
+
* @public
|
|
6351
6909
|
* <p>An estimate of item collection size, in gigabytes. This value is a two-element array
|
|
6352
6910
|
* containing a lower bound and an upper bound for the estimate. The estimate includes the
|
|
6353
6911
|
* size of all the items in the table, plus the size of all attributes projected into all
|
|
@@ -6364,6 +6922,7 @@ export interface ItemCollectionMetrics {
|
|
|
6364
6922
|
*/
|
|
6365
6923
|
export interface ItemResponse {
|
|
6366
6924
|
/**
|
|
6925
|
+
* @public
|
|
6367
6926
|
* <p>Map of attribute data consisting of the data type and attribute value.</p>
|
|
6368
6927
|
*/
|
|
6369
6928
|
Item?: Record<string, AttributeValue>;
|
|
@@ -6374,14 +6933,17 @@ export interface ItemResponse {
|
|
|
6374
6933
|
*/
|
|
6375
6934
|
export interface ParameterizedStatement {
|
|
6376
6935
|
/**
|
|
6936
|
+
* @public
|
|
6377
6937
|
* <p> A PartiQL statment that uses parameters. </p>
|
|
6378
6938
|
*/
|
|
6379
6939
|
Statement: string | undefined;
|
|
6380
6940
|
/**
|
|
6941
|
+
* @public
|
|
6381
6942
|
* <p> The parameter values. </p>
|
|
6382
6943
|
*/
|
|
6383
6944
|
Parameters?: AttributeValue[];
|
|
6384
6945
|
/**
|
|
6946
|
+
* @public
|
|
6385
6947
|
* <p>An optional parameter that returns the item attributes for a PartiQL
|
|
6386
6948
|
* <code>ParameterizedStatement</code> operation that failed a condition check.</p>
|
|
6387
6949
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
@@ -6396,6 +6958,7 @@ export interface ParameterizedStatement {
|
|
|
6396
6958
|
*/
|
|
6397
6959
|
export interface PutRequest {
|
|
6398
6960
|
/**
|
|
6961
|
+
* @public
|
|
6399
6962
|
* <p>A map of attribute name to attribute values, representing the primary key of an item
|
|
6400
6963
|
* to be processed by <code>PutItem</code>. All of the table's primary key attributes must
|
|
6401
6964
|
* be specified, and their data types must match those of the table's key schema. If any
|
|
@@ -6415,11 +6978,13 @@ export interface PutRequest {
|
|
|
6415
6978
|
*/
|
|
6416
6979
|
export interface KeysAndAttributes {
|
|
6417
6980
|
/**
|
|
6981
|
+
* @public
|
|
6418
6982
|
* <p>The primary key attribute values that define the items and the attributes associated
|
|
6419
6983
|
* with the items.</p>
|
|
6420
6984
|
*/
|
|
6421
6985
|
Keys: Record<string, AttributeValue>[] | undefined;
|
|
6422
6986
|
/**
|
|
6987
|
+
* @public
|
|
6423
6988
|
* <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more
|
|
6424
6989
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.html">Legacy
|
|
6425
6990
|
* Conditional Parameters</a> in the <i>Amazon DynamoDB Developer
|
|
@@ -6427,11 +6992,13 @@ export interface KeysAndAttributes {
|
|
|
6427
6992
|
*/
|
|
6428
6993
|
AttributesToGet?: string[];
|
|
6429
6994
|
/**
|
|
6995
|
+
* @public
|
|
6430
6996
|
* <p>The consistency of a read operation. If set to <code>true</code>, then a strongly
|
|
6431
6997
|
* consistent read is used; otherwise, an eventually consistent read is used.</p>
|
|
6432
6998
|
*/
|
|
6433
6999
|
ConsistentRead?: boolean;
|
|
6434
7000
|
/**
|
|
7001
|
+
* @public
|
|
6435
7002
|
* <p>A string that identifies one or more attributes to retrieve from the table. These
|
|
6436
7003
|
* attributes can include scalars, sets, or elements of a JSON document. The attributes in
|
|
6437
7004
|
* the <code>ProjectionExpression</code> must be separated by commas.</p>
|
|
@@ -6442,6 +7009,7 @@ export interface KeysAndAttributes {
|
|
|
6442
7009
|
*/
|
|
6443
7010
|
ProjectionExpression?: string;
|
|
6444
7011
|
/**
|
|
7012
|
+
* @public
|
|
6445
7013
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
6446
7014
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
6447
7015
|
* <ul>
|
|
@@ -6502,6 +7070,7 @@ export interface KeysAndAttributes {
|
|
|
6502
7070
|
*/
|
|
6503
7071
|
export interface TransactGetItem {
|
|
6504
7072
|
/**
|
|
7073
|
+
* @public
|
|
6505
7074
|
* <p>Contains the primary key that identifies the item to get, together with the name of
|
|
6506
7075
|
* the table that contains the item, and optionally the specific attributes of the item to
|
|
6507
7076
|
* retrieve.</p>
|
|
@@ -6513,10 +7082,12 @@ export interface TransactGetItem {
|
|
|
6513
7082
|
*/
|
|
6514
7083
|
export interface BatchExecuteStatementInput {
|
|
6515
7084
|
/**
|
|
7085
|
+
* @public
|
|
6516
7086
|
* <p>The list of PartiQL statements representing the batch to run.</p>
|
|
6517
7087
|
*/
|
|
6518
7088
|
Statements: BatchStatementRequest[] | undefined;
|
|
6519
7089
|
/**
|
|
7090
|
+
* @public
|
|
6520
7091
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
6521
7092
|
* consumption that is returned in the response:</p>
|
|
6522
7093
|
* <ul>
|
|
@@ -6550,15 +7121,18 @@ export interface BatchExecuteStatementInput {
|
|
|
6550
7121
|
*/
|
|
6551
7122
|
export interface ExecuteTransactionInput {
|
|
6552
7123
|
/**
|
|
7124
|
+
* @public
|
|
6553
7125
|
* <p>The list of PartiQL statements representing the transaction to run.</p>
|
|
6554
7126
|
*/
|
|
6555
7127
|
TransactStatements: ParameterizedStatement[] | undefined;
|
|
6556
7128
|
/**
|
|
7129
|
+
* @public
|
|
6557
7130
|
* <p>Set this value to get remaining results, if <code>NextToken</code> was returned in the
|
|
6558
7131
|
* statement response.</p>
|
|
6559
7132
|
*/
|
|
6560
7133
|
ClientRequestToken?: string;
|
|
6561
7134
|
/**
|
|
7135
|
+
* @public
|
|
6562
7136
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
6563
7137
|
* consumption that is returned in the response. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactGetItems.html">TransactGetItems</a> and <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_TransactWriteItems.html">TransactWriteItems</a>.</p>
|
|
6564
7138
|
*/
|
|
@@ -6569,10 +7143,12 @@ export interface ExecuteTransactionInput {
|
|
|
6569
7143
|
*/
|
|
6570
7144
|
export interface ExecuteTransactionOutput {
|
|
6571
7145
|
/**
|
|
7146
|
+
* @public
|
|
6572
7147
|
* <p>The response to a PartiQL transaction.</p>
|
|
6573
7148
|
*/
|
|
6574
7149
|
Responses?: ItemResponse[];
|
|
6575
7150
|
/**
|
|
7151
|
+
* @public
|
|
6576
7152
|
* <p>The capacity units consumed by the entire operation. The values of the list are
|
|
6577
7153
|
* ordered according to the ordering of the statements.</p>
|
|
6578
7154
|
*/
|
|
@@ -6583,6 +7159,7 @@ export interface ExecuteTransactionOutput {
|
|
|
6583
7159
|
*/
|
|
6584
7160
|
export interface TransactGetItemsOutput {
|
|
6585
7161
|
/**
|
|
7162
|
+
* @public
|
|
6586
7163
|
* <p>If the <i>ReturnConsumedCapacity</i> value was <code>TOTAL</code>, this
|
|
6587
7164
|
* is an array of <code>ConsumedCapacity</code> objects, one for each table addressed by
|
|
6588
7165
|
* <code>TransactGetItem</code> objects in the <i>TransactItems</i>
|
|
@@ -6591,6 +7168,7 @@ export interface TransactGetItemsOutput {
|
|
|
6591
7168
|
*/
|
|
6592
7169
|
ConsumedCapacity?: ConsumedCapacity[];
|
|
6593
7170
|
/**
|
|
7171
|
+
* @public
|
|
6594
7172
|
* <p>An ordered array of up to 100 <code>ItemResponse</code> objects, each of which
|
|
6595
7173
|
* corresponds to the <code>TransactGetItem</code> object in the same position in the
|
|
6596
7174
|
* <i>TransactItems</i> array. Each <code>ItemResponse</code> object
|
|
@@ -6841,6 +7419,7 @@ export declare class TransactionCanceledException extends __BaseException {
|
|
|
6841
7419
|
readonly $fault: "client";
|
|
6842
7420
|
Message?: string;
|
|
6843
7421
|
/**
|
|
7422
|
+
* @public
|
|
6844
7423
|
* <p>A list of cancellation reasons.</p>
|
|
6845
7424
|
*/
|
|
6846
7425
|
CancellationReasons?: CancellationReason[];
|
|
@@ -6855,6 +7434,7 @@ export declare class TransactionCanceledException extends __BaseException {
|
|
|
6855
7434
|
*/
|
|
6856
7435
|
export interface BatchGetItemInput {
|
|
6857
7436
|
/**
|
|
7437
|
+
* @public
|
|
6858
7438
|
* <p>A map of one or more table names and, for each table, a map that describes one or more
|
|
6859
7439
|
* items to retrieve from that table. Each table name can be used only once per
|
|
6860
7440
|
* <code>BatchGetItem</code> request.</p>
|
|
@@ -6957,6 +7537,7 @@ export interface BatchGetItemInput {
|
|
|
6957
7537
|
*/
|
|
6958
7538
|
RequestItems: Record<string, KeysAndAttributes> | undefined;
|
|
6959
7539
|
/**
|
|
7540
|
+
* @public
|
|
6960
7541
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
6961
7542
|
* consumption that is returned in the response:</p>
|
|
6962
7543
|
* <ul>
|
|
@@ -7017,6 +7598,7 @@ export interface BatchGetItemInput {
|
|
|
7017
7598
|
*/
|
|
7018
7599
|
export interface ExpectedAttributeValue {
|
|
7019
7600
|
/**
|
|
7601
|
+
* @public
|
|
7020
7602
|
* <p>Represents the data for the expected attribute.</p>
|
|
7021
7603
|
* <p>Each attribute value is described as a name-value pair. The name is the data type, and
|
|
7022
7604
|
* the value is the data itself.</p>
|
|
@@ -7025,6 +7607,7 @@ export interface ExpectedAttributeValue {
|
|
|
7025
7607
|
*/
|
|
7026
7608
|
Value?: AttributeValue;
|
|
7027
7609
|
/**
|
|
7610
|
+
* @public
|
|
7028
7611
|
* <p>Causes DynamoDB to evaluate the value before attempting a conditional
|
|
7029
7612
|
* operation:</p>
|
|
7030
7613
|
* <ul>
|
|
@@ -7064,6 +7647,7 @@ export interface ExpectedAttributeValue {
|
|
|
7064
7647
|
*/
|
|
7065
7648
|
Exists?: boolean;
|
|
7066
7649
|
/**
|
|
7650
|
+
* @public
|
|
7067
7651
|
* <p>A comparator for evaluating attributes in the <code>AttributeValueList</code>. For
|
|
7068
7652
|
* example, equals, greater than, less than, etc.</p>
|
|
7069
7653
|
* <p>The following comparison operators are available:</p>
|
|
@@ -7249,6 +7833,7 @@ export interface ExpectedAttributeValue {
|
|
|
7249
7833
|
*/
|
|
7250
7834
|
ComparisonOperator?: ComparisonOperator | string;
|
|
7251
7835
|
/**
|
|
7836
|
+
* @public
|
|
7252
7837
|
* <p>One or more values to evaluate against the supplied attribute. The number of values in
|
|
7253
7838
|
* the list depends on the <code>ComparisonOperator</code> being used.</p>
|
|
7254
7839
|
* <p>For type Number, value comparisons are numeric.</p>
|
|
@@ -7267,11 +7852,13 @@ export interface ExpectedAttributeValue {
|
|
|
7267
7852
|
*/
|
|
7268
7853
|
export interface TransactGetItemsInput {
|
|
7269
7854
|
/**
|
|
7855
|
+
* @public
|
|
7270
7856
|
* <p>An ordered array of up to 100 <code>TransactGetItem</code> objects, each of which
|
|
7271
7857
|
* contains a <code>Get</code> structure.</p>
|
|
7272
7858
|
*/
|
|
7273
7859
|
TransactItems: TransactGetItem[] | undefined;
|
|
7274
7860
|
/**
|
|
7861
|
+
* @public
|
|
7275
7862
|
* <p>A value of <code>TOTAL</code> causes consumed capacity information to be returned, and
|
|
7276
7863
|
* a value of <code>NONE</code> prevents that information from being returned. No other
|
|
7277
7864
|
* value is valid.</p>
|
|
@@ -7283,12 +7870,14 @@ export interface TransactGetItemsInput {
|
|
|
7283
7870
|
*/
|
|
7284
7871
|
export interface TransactWriteItemsOutput {
|
|
7285
7872
|
/**
|
|
7873
|
+
* @public
|
|
7286
7874
|
* <p>The capacity units consumed by the entire <code>TransactWriteItems</code> operation.
|
|
7287
7875
|
* The values of the list are ordered according to the ordering of the
|
|
7288
7876
|
* <code>TransactItems</code> request parameter. </p>
|
|
7289
7877
|
*/
|
|
7290
7878
|
ConsumedCapacity?: ConsumedCapacity[];
|
|
7291
7879
|
/**
|
|
7880
|
+
* @public
|
|
7292
7881
|
* <p>A list of tables that were processed by <code>TransactWriteItems</code> and, for each
|
|
7293
7882
|
* table, information about any item collections that were affected by individual
|
|
7294
7883
|
* <code>UpdateItem</code>, <code>PutItem</code>, or <code>DeleteItem</code>
|
|
@@ -7303,31 +7892,37 @@ export interface TransactWriteItemsOutput {
|
|
|
7303
7892
|
*/
|
|
7304
7893
|
export interface ConditionCheck {
|
|
7305
7894
|
/**
|
|
7895
|
+
* @public
|
|
7306
7896
|
* <p>The primary key of the item to be checked. Each element consists of an attribute name
|
|
7307
7897
|
* and a value for that attribute.</p>
|
|
7308
7898
|
*/
|
|
7309
7899
|
Key: Record<string, AttributeValue> | undefined;
|
|
7310
7900
|
/**
|
|
7901
|
+
* @public
|
|
7311
7902
|
* <p>Name of the table for the check item request.</p>
|
|
7312
7903
|
*/
|
|
7313
7904
|
TableName: string | undefined;
|
|
7314
7905
|
/**
|
|
7906
|
+
* @public
|
|
7315
7907
|
* <p>A condition that must be satisfied in order for a conditional update to
|
|
7316
7908
|
* succeed. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html">Condition expressions</a> in the <i>Amazon DynamoDB Developer
|
|
7317
7909
|
* Guide</i>.</p>
|
|
7318
7910
|
*/
|
|
7319
7911
|
ConditionExpression: string | undefined;
|
|
7320
7912
|
/**
|
|
7913
|
+
* @public
|
|
7321
7914
|
* <p>One or more substitution tokens for attribute names in an expression. For more information, see
|
|
7322
7915
|
* <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ExpressionAttributeNames.html">Expression attribute names</a>
|
|
7323
7916
|
* in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
7324
7917
|
*/
|
|
7325
7918
|
ExpressionAttributeNames?: Record<string, string>;
|
|
7326
7919
|
/**
|
|
7920
|
+
* @public
|
|
7327
7921
|
* <p>One or more values that can be substituted in an expression. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.ConditionExpressions.html">Condition expressions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>
|
|
7328
7922
|
*/
|
|
7329
7923
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
7330
7924
|
/**
|
|
7925
|
+
* @public
|
|
7331
7926
|
* <p>Use <code>ReturnValuesOnConditionCheckFailure</code> to get the item attributes if the
|
|
7332
7927
|
* <code>ConditionCheck</code> condition fails. For
|
|
7333
7928
|
* <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE and
|
|
@@ -7341,28 +7936,34 @@ export interface ConditionCheck {
|
|
|
7341
7936
|
*/
|
|
7342
7937
|
export interface Delete {
|
|
7343
7938
|
/**
|
|
7939
|
+
* @public
|
|
7344
7940
|
* <p>The primary key of the item to be deleted. Each element consists of an attribute name
|
|
7345
7941
|
* and a value for that attribute.</p>
|
|
7346
7942
|
*/
|
|
7347
7943
|
Key: Record<string, AttributeValue> | undefined;
|
|
7348
7944
|
/**
|
|
7945
|
+
* @public
|
|
7349
7946
|
* <p>Name of the table in which the item to be deleted resides.</p>
|
|
7350
7947
|
*/
|
|
7351
7948
|
TableName: string | undefined;
|
|
7352
7949
|
/**
|
|
7950
|
+
* @public
|
|
7353
7951
|
* <p>A condition that must be satisfied in order for a conditional delete to
|
|
7354
7952
|
* succeed.</p>
|
|
7355
7953
|
*/
|
|
7356
7954
|
ConditionExpression?: string;
|
|
7357
7955
|
/**
|
|
7956
|
+
* @public
|
|
7358
7957
|
* <p>One or more substitution tokens for attribute names in an expression.</p>
|
|
7359
7958
|
*/
|
|
7360
7959
|
ExpressionAttributeNames?: Record<string, string>;
|
|
7361
7960
|
/**
|
|
7961
|
+
* @public
|
|
7362
7962
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
7363
7963
|
*/
|
|
7364
7964
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
7365
7965
|
/**
|
|
7966
|
+
* @public
|
|
7366
7967
|
* <p>Use <code>ReturnValuesOnConditionCheckFailure</code> to get the item attributes if the
|
|
7367
7968
|
* <code>Delete</code> condition fails. For
|
|
7368
7969
|
* <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE and
|
|
@@ -7376,6 +7977,7 @@ export interface Delete {
|
|
|
7376
7977
|
*/
|
|
7377
7978
|
export interface Put {
|
|
7378
7979
|
/**
|
|
7980
|
+
* @public
|
|
7379
7981
|
* <p>A map of attribute name to attribute values, representing the primary key of the item
|
|
7380
7982
|
* to be written by <code>PutItem</code>. All of the table's primary key attributes must be
|
|
7381
7983
|
* specified, and their data types must match those of the table's key schema. If any
|
|
@@ -7384,23 +7986,28 @@ export interface Put {
|
|
|
7384
7986
|
*/
|
|
7385
7987
|
Item: Record<string, AttributeValue> | undefined;
|
|
7386
7988
|
/**
|
|
7989
|
+
* @public
|
|
7387
7990
|
* <p>Name of the table in which to write the item.</p>
|
|
7388
7991
|
*/
|
|
7389
7992
|
TableName: string | undefined;
|
|
7390
7993
|
/**
|
|
7994
|
+
* @public
|
|
7391
7995
|
* <p>A condition that must be satisfied in order for a conditional update to
|
|
7392
7996
|
* succeed.</p>
|
|
7393
7997
|
*/
|
|
7394
7998
|
ConditionExpression?: string;
|
|
7395
7999
|
/**
|
|
8000
|
+
* @public
|
|
7396
8001
|
* <p>One or more substitution tokens for attribute names in an expression.</p>
|
|
7397
8002
|
*/
|
|
7398
8003
|
ExpressionAttributeNames?: Record<string, string>;
|
|
7399
8004
|
/**
|
|
8005
|
+
* @public
|
|
7400
8006
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
7401
8007
|
*/
|
|
7402
8008
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
7403
8009
|
/**
|
|
8010
|
+
* @public
|
|
7404
8011
|
* <p>Use <code>ReturnValuesOnConditionCheckFailure</code> to get the item attributes if the
|
|
7405
8012
|
* <code>Put</code> condition fails. For
|
|
7406
8013
|
* <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE and
|
|
@@ -7414,33 +8021,40 @@ export interface Put {
|
|
|
7414
8021
|
*/
|
|
7415
8022
|
export interface Update {
|
|
7416
8023
|
/**
|
|
8024
|
+
* @public
|
|
7417
8025
|
* <p>The primary key of the item to be updated. Each element consists of an attribute name
|
|
7418
8026
|
* and a value for that attribute.</p>
|
|
7419
8027
|
*/
|
|
7420
8028
|
Key: Record<string, AttributeValue> | undefined;
|
|
7421
8029
|
/**
|
|
8030
|
+
* @public
|
|
7422
8031
|
* <p>An expression that defines one or more attributes to be updated, the action to be
|
|
7423
8032
|
* performed on them, and new value(s) for them.</p>
|
|
7424
8033
|
*/
|
|
7425
8034
|
UpdateExpression: string | undefined;
|
|
7426
8035
|
/**
|
|
8036
|
+
* @public
|
|
7427
8037
|
* <p>Name of the table for the <code>UpdateItem</code> request.</p>
|
|
7428
8038
|
*/
|
|
7429
8039
|
TableName: string | undefined;
|
|
7430
8040
|
/**
|
|
8041
|
+
* @public
|
|
7431
8042
|
* <p>A condition that must be satisfied in order for a conditional update to
|
|
7432
8043
|
* succeed.</p>
|
|
7433
8044
|
*/
|
|
7434
8045
|
ConditionExpression?: string;
|
|
7435
8046
|
/**
|
|
8047
|
+
* @public
|
|
7436
8048
|
* <p>One or more substitution tokens for attribute names in an expression.</p>
|
|
7437
8049
|
*/
|
|
7438
8050
|
ExpressionAttributeNames?: Record<string, string>;
|
|
7439
8051
|
/**
|
|
8052
|
+
* @public
|
|
7440
8053
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
7441
8054
|
*/
|
|
7442
8055
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
7443
8056
|
/**
|
|
8057
|
+
* @public
|
|
7444
8058
|
* <p>Use <code>ReturnValuesOnConditionCheckFailure</code> to get the item attributes if the
|
|
7445
8059
|
* <code>Update</code> condition fails. For
|
|
7446
8060
|
* <code>ReturnValuesOnConditionCheckFailure</code>, the valid values are: NONE and
|
|
@@ -7454,14 +8068,17 @@ export interface Update {
|
|
|
7454
8068
|
*/
|
|
7455
8069
|
export interface BatchStatementResponse {
|
|
7456
8070
|
/**
|
|
8071
|
+
* @public
|
|
7457
8072
|
* <p> The error associated with a failed PartiQL batch statement. </p>
|
|
7458
8073
|
*/
|
|
7459
8074
|
Error?: BatchStatementError;
|
|
7460
8075
|
/**
|
|
8076
|
+
* @public
|
|
7461
8077
|
* <p> The table name associated with a failed PartiQL batch statement. </p>
|
|
7462
8078
|
*/
|
|
7463
8079
|
TableName?: string;
|
|
7464
8080
|
/**
|
|
8081
|
+
* @public
|
|
7465
8082
|
* <p> A DynamoDB item associated with a BatchStatementResponse </p>
|
|
7466
8083
|
*/
|
|
7467
8084
|
Item?: Record<string, AttributeValue>;
|
|
@@ -7472,6 +8089,7 @@ export interface BatchStatementResponse {
|
|
|
7472
8089
|
*/
|
|
7473
8090
|
export interface DeleteItemOutput {
|
|
7474
8091
|
/**
|
|
8092
|
+
* @public
|
|
7475
8093
|
* <p>A map of attribute names to <code>AttributeValue</code> objects, representing the item
|
|
7476
8094
|
* as it appeared before the <code>DeleteItem</code> operation. This map appears in the
|
|
7477
8095
|
* response only if <code>ReturnValues</code> was specified as <code>ALL_OLD</code> in the
|
|
@@ -7479,6 +8097,7 @@ export interface DeleteItemOutput {
|
|
|
7479
8097
|
*/
|
|
7480
8098
|
Attributes?: Record<string, AttributeValue>;
|
|
7481
8099
|
/**
|
|
8100
|
+
* @public
|
|
7482
8101
|
* <p>The capacity units consumed by the <code>DeleteItem</code> operation. The data
|
|
7483
8102
|
* returned includes the total provisioned throughput consumed, along with statistics for
|
|
7484
8103
|
* the table and any indexes involved in the operation. <code>ConsumedCapacity</code> is
|
|
@@ -7488,6 +8107,7 @@ export interface DeleteItemOutput {
|
|
|
7488
8107
|
*/
|
|
7489
8108
|
ConsumedCapacity?: ConsumedCapacity;
|
|
7490
8109
|
/**
|
|
8110
|
+
* @public
|
|
7491
8111
|
* <p>Information about item collections, if any, that were affected by the
|
|
7492
8112
|
* <code>DeleteItem</code> operation. <code>ItemCollectionMetrics</code> is only
|
|
7493
8113
|
* returned if the <code>ReturnItemCollectionMetrics</code> parameter was specified. If the
|
|
@@ -7520,18 +8140,21 @@ export interface DeleteItemOutput {
|
|
|
7520
8140
|
*/
|
|
7521
8141
|
export interface ExecuteStatementOutput {
|
|
7522
8142
|
/**
|
|
8143
|
+
* @public
|
|
7523
8144
|
* <p>If a read operation was used, this property will contain the result of the read
|
|
7524
8145
|
* operation; a map of attribute names and their values. For the write operations this
|
|
7525
8146
|
* value will be empty.</p>
|
|
7526
8147
|
*/
|
|
7527
8148
|
Items?: Record<string, AttributeValue>[];
|
|
7528
8149
|
/**
|
|
8150
|
+
* @public
|
|
7529
8151
|
* <p>If the response of a read request exceeds the response payload limit DynamoDB will set
|
|
7530
8152
|
* this value in the response. If set, you can use that this value in the subsequent
|
|
7531
8153
|
* request to get the remaining results.</p>
|
|
7532
8154
|
*/
|
|
7533
8155
|
NextToken?: string;
|
|
7534
8156
|
/**
|
|
8157
|
+
* @public
|
|
7535
8158
|
* <p>The capacity units consumed by an operation. The data returned includes the total
|
|
7536
8159
|
* provisioned throughput consumed, along with statistics for the table and any indexes
|
|
7537
8160
|
* involved in the operation. <code>ConsumedCapacity</code> is only returned if the request
|
|
@@ -7540,6 +8163,7 @@ export interface ExecuteStatementOutput {
|
|
|
7540
8163
|
*/
|
|
7541
8164
|
ConsumedCapacity?: ConsumedCapacity;
|
|
7542
8165
|
/**
|
|
8166
|
+
* @public
|
|
7543
8167
|
* <p>The primary key of the item where the operation stopped, inclusive of the previous
|
|
7544
8168
|
* result set. Use this value to start a new operation, excluding this value in the new
|
|
7545
8169
|
* request. If <code>LastEvaluatedKey</code> is empty, then the "last page" of results has
|
|
@@ -7556,12 +8180,14 @@ export interface ExecuteStatementOutput {
|
|
|
7556
8180
|
*/
|
|
7557
8181
|
export interface PutItemOutput {
|
|
7558
8182
|
/**
|
|
8183
|
+
* @public
|
|
7559
8184
|
* <p>The attribute values as they appeared before the <code>PutItem</code> operation, but
|
|
7560
8185
|
* only if <code>ReturnValues</code> is specified as <code>ALL_OLD</code> in the request.
|
|
7561
8186
|
* Each element consists of an attribute name and an attribute value.</p>
|
|
7562
8187
|
*/
|
|
7563
8188
|
Attributes?: Record<string, AttributeValue>;
|
|
7564
8189
|
/**
|
|
8190
|
+
* @public
|
|
7565
8191
|
* <p>The capacity units consumed by the <code>PutItem</code> operation. The data returned
|
|
7566
8192
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
7567
8193
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
@@ -7571,6 +8197,7 @@ export interface PutItemOutput {
|
|
|
7571
8197
|
*/
|
|
7572
8198
|
ConsumedCapacity?: ConsumedCapacity;
|
|
7573
8199
|
/**
|
|
8200
|
+
* @public
|
|
7574
8201
|
* <p>Information about item collections, if any, that were affected by the
|
|
7575
8202
|
* <code>PutItem</code> operation. <code>ItemCollectionMetrics</code> is only returned
|
|
7576
8203
|
* if the <code>ReturnItemCollectionMetrics</code> parameter was specified. If the table
|
|
@@ -7604,11 +8231,13 @@ export interface PutItemOutput {
|
|
|
7604
8231
|
*/
|
|
7605
8232
|
export interface QueryOutput {
|
|
7606
8233
|
/**
|
|
8234
|
+
* @public
|
|
7607
8235
|
* <p>An array of item attributes that match the query criteria. Each element in this array
|
|
7608
8236
|
* consists of an attribute name and the value for that attribute.</p>
|
|
7609
8237
|
*/
|
|
7610
8238
|
Items?: Record<string, AttributeValue>[];
|
|
7611
8239
|
/**
|
|
8240
|
+
* @public
|
|
7612
8241
|
* <p>The number of items in the response.</p>
|
|
7613
8242
|
* <p>If you used a <code>QueryFilter</code> in the request, then <code>Count</code> is the
|
|
7614
8243
|
* number of items returned after the filter was applied, and <code>ScannedCount</code> is
|
|
@@ -7618,6 +8247,7 @@ export interface QueryOutput {
|
|
|
7618
8247
|
*/
|
|
7619
8248
|
Count?: number;
|
|
7620
8249
|
/**
|
|
8250
|
+
* @public
|
|
7621
8251
|
* <p>The number of items evaluated, before any <code>QueryFilter</code> is applied. A high
|
|
7622
8252
|
* <code>ScannedCount</code> value with few, or no, <code>Count</code> results
|
|
7623
8253
|
* indicates an inefficient <code>Query</code> operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count">Count and
|
|
@@ -7628,6 +8258,7 @@ export interface QueryOutput {
|
|
|
7628
8258
|
*/
|
|
7629
8259
|
ScannedCount?: number;
|
|
7630
8260
|
/**
|
|
8261
|
+
* @public
|
|
7631
8262
|
* <p>The primary key of the item where the operation stopped, inclusive of the previous
|
|
7632
8263
|
* result set. Use this value to start a new operation, excluding this value in the new
|
|
7633
8264
|
* request.</p>
|
|
@@ -7639,6 +8270,7 @@ export interface QueryOutput {
|
|
|
7639
8270
|
*/
|
|
7640
8271
|
LastEvaluatedKey?: Record<string, AttributeValue>;
|
|
7641
8272
|
/**
|
|
8273
|
+
* @public
|
|
7642
8274
|
* <p>The capacity units consumed by the <code>Query</code> operation. The data returned
|
|
7643
8275
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
7644
8276
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
@@ -7654,11 +8286,13 @@ export interface QueryOutput {
|
|
|
7654
8286
|
*/
|
|
7655
8287
|
export interface ScanOutput {
|
|
7656
8288
|
/**
|
|
8289
|
+
* @public
|
|
7657
8290
|
* <p>An array of item attributes that match the scan criteria. Each element in this array
|
|
7658
8291
|
* consists of an attribute name and the value for that attribute.</p>
|
|
7659
8292
|
*/
|
|
7660
8293
|
Items?: Record<string, AttributeValue>[];
|
|
7661
8294
|
/**
|
|
8295
|
+
* @public
|
|
7662
8296
|
* <p>The number of items in the response.</p>
|
|
7663
8297
|
* <p>If you set <code>ScanFilter</code> in the request, then <code>Count</code> is the
|
|
7664
8298
|
* number of items returned after the filter was applied, and <code>ScannedCount</code> is
|
|
@@ -7668,6 +8302,7 @@ export interface ScanOutput {
|
|
|
7668
8302
|
*/
|
|
7669
8303
|
Count?: number;
|
|
7670
8304
|
/**
|
|
8305
|
+
* @public
|
|
7671
8306
|
* <p>The number of items evaluated, before any <code>ScanFilter</code> is applied. A high
|
|
7672
8307
|
* <code>ScannedCount</code> value with few, or no, <code>Count</code> results
|
|
7673
8308
|
* indicates an inefficient <code>Scan</code> operation. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#Count">Count and
|
|
@@ -7678,6 +8313,7 @@ export interface ScanOutput {
|
|
|
7678
8313
|
*/
|
|
7679
8314
|
ScannedCount?: number;
|
|
7680
8315
|
/**
|
|
8316
|
+
* @public
|
|
7681
8317
|
* <p>The primary key of the item where the operation stopped, inclusive of the previous
|
|
7682
8318
|
* result set. Use this value to start a new operation, excluding this value in the new
|
|
7683
8319
|
* request.</p>
|
|
@@ -7689,6 +8325,7 @@ export interface ScanOutput {
|
|
|
7689
8325
|
*/
|
|
7690
8326
|
LastEvaluatedKey?: Record<string, AttributeValue>;
|
|
7691
8327
|
/**
|
|
8328
|
+
* @public
|
|
7692
8329
|
* <p>The capacity units consumed by the <code>Scan</code> operation. The data returned
|
|
7693
8330
|
* includes the total provisioned throughput consumed, along with statistics for the table
|
|
7694
8331
|
* and any indexes involved in the operation. <code>ConsumedCapacity</code> is only
|
|
@@ -7705,6 +8342,7 @@ export interface ScanOutput {
|
|
|
7705
8342
|
*/
|
|
7706
8343
|
export interface UpdateItemOutput {
|
|
7707
8344
|
/**
|
|
8345
|
+
* @public
|
|
7708
8346
|
* <p>A map of attribute values as they appear before or after the <code>UpdateItem</code>
|
|
7709
8347
|
* operation, as determined by the <code>ReturnValues</code> parameter.</p>
|
|
7710
8348
|
* <p>The <code>Attributes</code> map is only present if the update was successful and <code>ReturnValues</code> was
|
|
@@ -7713,6 +8351,7 @@ export interface UpdateItemOutput {
|
|
|
7713
8351
|
*/
|
|
7714
8352
|
Attributes?: Record<string, AttributeValue>;
|
|
7715
8353
|
/**
|
|
8354
|
+
* @public
|
|
7716
8355
|
* <p>The capacity units consumed by the <code>UpdateItem</code> operation. The data
|
|
7717
8356
|
* returned includes the total provisioned throughput consumed, along with statistics for
|
|
7718
8357
|
* the table and any indexes involved in the operation. <code>ConsumedCapacity</code> is
|
|
@@ -7722,6 +8361,7 @@ export interface UpdateItemOutput {
|
|
|
7722
8361
|
*/
|
|
7723
8362
|
ConsumedCapacity?: ConsumedCapacity;
|
|
7724
8363
|
/**
|
|
8364
|
+
* @public
|
|
7725
8365
|
* <p>Information about item collections, if any, that were affected by the
|
|
7726
8366
|
* <code>UpdateItem</code> operation. <code>ItemCollectionMetrics</code> is only
|
|
7727
8367
|
* returned if the <code>ReturnItemCollectionMetrics</code> parameter was specified. If the
|
|
@@ -7758,10 +8398,12 @@ export interface UpdateItemOutput {
|
|
|
7758
8398
|
*/
|
|
7759
8399
|
export interface WriteRequest {
|
|
7760
8400
|
/**
|
|
8401
|
+
* @public
|
|
7761
8402
|
* <p>A request to perform a <code>PutItem</code> operation.</p>
|
|
7762
8403
|
*/
|
|
7763
8404
|
PutRequest?: PutRequest;
|
|
7764
8405
|
/**
|
|
8406
|
+
* @public
|
|
7765
8407
|
* <p>A request to perform a <code>DeleteItem</code> operation.</p>
|
|
7766
8408
|
*/
|
|
7767
8409
|
DeleteRequest?: DeleteRequest;
|
|
@@ -7771,11 +8413,13 @@ export interface WriteRequest {
|
|
|
7771
8413
|
*/
|
|
7772
8414
|
export interface BatchExecuteStatementOutput {
|
|
7773
8415
|
/**
|
|
8416
|
+
* @public
|
|
7774
8417
|
* <p>The response to each PartiQL statement in the batch. The values of the list are
|
|
7775
8418
|
* ordered according to the ordering of the request statements.</p>
|
|
7776
8419
|
*/
|
|
7777
8420
|
Responses?: BatchStatementResponse[];
|
|
7778
8421
|
/**
|
|
8422
|
+
* @public
|
|
7779
8423
|
* <p>The capacity units consumed by the entire operation. The values of the list are
|
|
7780
8424
|
* ordered according to the ordering of the statements.</p>
|
|
7781
8425
|
*/
|
|
@@ -7787,12 +8431,14 @@ export interface BatchExecuteStatementOutput {
|
|
|
7787
8431
|
*/
|
|
7788
8432
|
export interface BatchGetItemOutput {
|
|
7789
8433
|
/**
|
|
8434
|
+
* @public
|
|
7790
8435
|
* <p>A map of table name to a list of items. Each object in <code>Responses</code> consists
|
|
7791
8436
|
* of a table name, along with a map of attribute data consisting of the data type and
|
|
7792
8437
|
* attribute value.</p>
|
|
7793
8438
|
*/
|
|
7794
8439
|
Responses?: Record<string, Record<string, AttributeValue>[]>;
|
|
7795
8440
|
/**
|
|
8441
|
+
* @public
|
|
7796
8442
|
* <p>A map of tables and their respective keys that were not processed with the current
|
|
7797
8443
|
* response. The <code>UnprocessedKeys</code> value is in the same form as
|
|
7798
8444
|
* <code>RequestItems</code>, so the value can be provided directly to a subsequent
|
|
@@ -7823,6 +8469,7 @@ export interface BatchGetItemOutput {
|
|
|
7823
8469
|
*/
|
|
7824
8470
|
UnprocessedKeys?: Record<string, KeysAndAttributes>;
|
|
7825
8471
|
/**
|
|
8472
|
+
* @public
|
|
7826
8473
|
* <p>The read capacity units consumed by the entire <code>BatchGetItem</code>
|
|
7827
8474
|
* operation.</p>
|
|
7828
8475
|
* <p>Each element consists of:</p>
|
|
@@ -7846,23 +8493,27 @@ export interface BatchGetItemOutput {
|
|
|
7846
8493
|
*/
|
|
7847
8494
|
export interface ScanInput {
|
|
7848
8495
|
/**
|
|
8496
|
+
* @public
|
|
7849
8497
|
* <p>The name of the table containing the requested items; or, if you provide
|
|
7850
8498
|
* <code>IndexName</code>, the name of the table to which that index belongs.</p>
|
|
7851
8499
|
*/
|
|
7852
8500
|
TableName: string | undefined;
|
|
7853
8501
|
/**
|
|
8502
|
+
* @public
|
|
7854
8503
|
* <p>The name of a secondary index to scan. This index can be any local secondary index or
|
|
7855
8504
|
* global secondary index. Note that if you use the <code>IndexName</code> parameter, you
|
|
7856
8505
|
* must also provide <code>TableName</code>.</p>
|
|
7857
8506
|
*/
|
|
7858
8507
|
IndexName?: string;
|
|
7859
8508
|
/**
|
|
8509
|
+
* @public
|
|
7860
8510
|
* <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more
|
|
7861
8511
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer
|
|
7862
8512
|
* Guide</i>.</p>
|
|
7863
8513
|
*/
|
|
7864
8514
|
AttributesToGet?: string[];
|
|
7865
8515
|
/**
|
|
8516
|
+
* @public
|
|
7866
8517
|
* <p>The maximum number of items to evaluate (not necessarily the number of matching
|
|
7867
8518
|
* items). If DynamoDB processes the number of items up to the limit while processing the
|
|
7868
8519
|
* results, it stops the operation and returns the matching values up to that point, and a
|
|
@@ -7875,6 +8526,7 @@ export interface ScanInput {
|
|
|
7875
8526
|
*/
|
|
7876
8527
|
Limit?: number;
|
|
7877
8528
|
/**
|
|
8529
|
+
* @public
|
|
7878
8530
|
* <p>The attributes to be returned in the result. You can retrieve all item attributes,
|
|
7879
8531
|
* specific item attributes, the count of matching items, or in the case of an index, some
|
|
7880
8532
|
* or all of the attributes projected into the index.</p>
|
|
@@ -7932,18 +8584,21 @@ export interface ScanInput {
|
|
|
7932
8584
|
*/
|
|
7933
8585
|
Select?: Select | string;
|
|
7934
8586
|
/**
|
|
8587
|
+
* @public
|
|
7935
8588
|
* <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more
|
|
7936
8589
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ScanFilter.html">ScanFilter</a> in the <i>Amazon DynamoDB Developer
|
|
7937
8590
|
* Guide</i>.</p>
|
|
7938
8591
|
*/
|
|
7939
8592
|
ScanFilter?: Record<string, Condition>;
|
|
7940
8593
|
/**
|
|
8594
|
+
* @public
|
|
7941
8595
|
* <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more
|
|
7942
8596
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer
|
|
7943
8597
|
* Guide</i>.</p>
|
|
7944
8598
|
*/
|
|
7945
8599
|
ConditionalOperator?: ConditionalOperator | string;
|
|
7946
8600
|
/**
|
|
8601
|
+
* @public
|
|
7947
8602
|
* <p>The primary key of the first item that this operation will evaluate. Use the value
|
|
7948
8603
|
* that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
|
7949
8604
|
* <p>The data type for <code>ExclusiveStartKey</code> must be String, Number or Binary. No
|
|
@@ -7955,6 +8610,7 @@ export interface ScanInput {
|
|
|
7955
8610
|
*/
|
|
7956
8611
|
ExclusiveStartKey?: Record<string, AttributeValue>;
|
|
7957
8612
|
/**
|
|
8613
|
+
* @public
|
|
7958
8614
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
7959
8615
|
* consumption that is returned in the response:</p>
|
|
7960
8616
|
* <ul>
|
|
@@ -7983,6 +8639,7 @@ export interface ScanInput {
|
|
|
7983
8639
|
*/
|
|
7984
8640
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
7985
8641
|
/**
|
|
8642
|
+
* @public
|
|
7986
8643
|
* <p>For a parallel <code>Scan</code> request, <code>TotalSegments</code> represents the
|
|
7987
8644
|
* total number of segments into which the <code>Scan</code> operation will be divided. The
|
|
7988
8645
|
* value of <code>TotalSegments</code> corresponds to the number of application workers
|
|
@@ -7997,6 +8654,7 @@ export interface ScanInput {
|
|
|
7997
8654
|
*/
|
|
7998
8655
|
TotalSegments?: number;
|
|
7999
8656
|
/**
|
|
8657
|
+
* @public
|
|
8000
8658
|
* <p>For a parallel <code>Scan</code> request, <code>Segment</code> identifies an
|
|
8001
8659
|
* individual segment to be scanned by an application worker.</p>
|
|
8002
8660
|
* <p>Segment IDs are zero-based, so the first segment is always 0. For example, if you want
|
|
@@ -8013,6 +8671,7 @@ export interface ScanInput {
|
|
|
8013
8671
|
*/
|
|
8014
8672
|
Segment?: number;
|
|
8015
8673
|
/**
|
|
8674
|
+
* @public
|
|
8016
8675
|
* <p>A string that identifies one or more attributes to retrieve from the specified table
|
|
8017
8676
|
* or index. These attributes can include scalars, sets, or elements of a JSON document.
|
|
8018
8677
|
* The attributes in the expression must be separated by commas.</p>
|
|
@@ -8023,6 +8682,7 @@ export interface ScanInput {
|
|
|
8023
8682
|
*/
|
|
8024
8683
|
ProjectionExpression?: string;
|
|
8025
8684
|
/**
|
|
8685
|
+
* @public
|
|
8026
8686
|
* <p>A string that contains conditions that DynamoDB applies after the <code>Scan</code>
|
|
8027
8687
|
* operation, but before the data is returned to you. Items that do not satisfy the
|
|
8028
8688
|
* <code>FilterExpression</code> criteria are not returned.</p>
|
|
@@ -8035,6 +8695,7 @@ export interface ScanInput {
|
|
|
8035
8695
|
*/
|
|
8036
8696
|
FilterExpression?: string;
|
|
8037
8697
|
/**
|
|
8698
|
+
* @public
|
|
8038
8699
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
8039
8700
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
8040
8701
|
* <ul>
|
|
@@ -8089,6 +8750,7 @@ export interface ScanInput {
|
|
|
8089
8750
|
*/
|
|
8090
8751
|
ExpressionAttributeNames?: Record<string, string>;
|
|
8091
8752
|
/**
|
|
8753
|
+
* @public
|
|
8092
8754
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
8093
8755
|
* <p>Use the <b>:</b> (colon) character in an expression to
|
|
8094
8756
|
* dereference an attribute value. For example, suppose that you wanted to check whether
|
|
@@ -8111,6 +8773,7 @@ export interface ScanInput {
|
|
|
8111
8773
|
*/
|
|
8112
8774
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
8113
8775
|
/**
|
|
8776
|
+
* @public
|
|
8114
8777
|
* <p>A Boolean value that determines the read consistency model during the scan:</p>
|
|
8115
8778
|
* <ul>
|
|
8116
8779
|
* <li>
|
|
@@ -8138,6 +8801,7 @@ export interface ScanInput {
|
|
|
8138
8801
|
*/
|
|
8139
8802
|
export interface BatchWriteItemInput {
|
|
8140
8803
|
/**
|
|
8804
|
+
* @public
|
|
8141
8805
|
* <p>A map of one or more table names and, for each table, a list of operations to be
|
|
8142
8806
|
* performed (<code>DeleteRequest</code> or <code>PutRequest</code>). Each element in the
|
|
8143
8807
|
* map consists of the following:</p>
|
|
@@ -8184,6 +8848,7 @@ export interface BatchWriteItemInput {
|
|
|
8184
8848
|
*/
|
|
8185
8849
|
RequestItems: Record<string, WriteRequest[]> | undefined;
|
|
8186
8850
|
/**
|
|
8851
|
+
* @public
|
|
8187
8852
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
8188
8853
|
* consumption that is returned in the response:</p>
|
|
8189
8854
|
* <ul>
|
|
@@ -8212,6 +8877,7 @@ export interface BatchWriteItemInput {
|
|
|
8212
8877
|
*/
|
|
8213
8878
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
8214
8879
|
/**
|
|
8880
|
+
* @public
|
|
8215
8881
|
* <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>,
|
|
8216
8882
|
* the response includes statistics about item collections, if any, that were modified
|
|
8217
8883
|
* during the operation are returned in the response. If set to <code>NONE</code> (the
|
|
@@ -8225,10 +8891,12 @@ export interface BatchWriteItemInput {
|
|
|
8225
8891
|
*/
|
|
8226
8892
|
export interface DeleteItemInput {
|
|
8227
8893
|
/**
|
|
8894
|
+
* @public
|
|
8228
8895
|
* <p>The name of the table from which to delete the item.</p>
|
|
8229
8896
|
*/
|
|
8230
8897
|
TableName: string | undefined;
|
|
8231
8898
|
/**
|
|
8899
|
+
* @public
|
|
8232
8900
|
* <p>A map of attribute names to <code>AttributeValue</code> objects, representing the
|
|
8233
8901
|
* primary key of the item to delete.</p>
|
|
8234
8902
|
* <p>For the primary key, you must provide all of the key attributes. For example, with a
|
|
@@ -8238,18 +8906,21 @@ export interface DeleteItemInput {
|
|
|
8238
8906
|
*/
|
|
8239
8907
|
Key: Record<string, AttributeValue> | undefined;
|
|
8240
8908
|
/**
|
|
8909
|
+
* @public
|
|
8241
8910
|
* <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more
|
|
8242
8911
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer
|
|
8243
8912
|
* Guide</i>.</p>
|
|
8244
8913
|
*/
|
|
8245
8914
|
Expected?: Record<string, ExpectedAttributeValue>;
|
|
8246
8915
|
/**
|
|
8916
|
+
* @public
|
|
8247
8917
|
* <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more
|
|
8248
8918
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer
|
|
8249
8919
|
* Guide</i>.</p>
|
|
8250
8920
|
*/
|
|
8251
8921
|
ConditionalOperator?: ConditionalOperator | string;
|
|
8252
8922
|
/**
|
|
8923
|
+
* @public
|
|
8253
8924
|
* <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared
|
|
8254
8925
|
* before they were deleted. For <code>DeleteItem</code>, the valid values are:</p>
|
|
8255
8926
|
* <ul>
|
|
@@ -8275,6 +8946,7 @@ export interface DeleteItemInput {
|
|
|
8275
8946
|
*/
|
|
8276
8947
|
ReturnValues?: ReturnValue | string;
|
|
8277
8948
|
/**
|
|
8949
|
+
* @public
|
|
8278
8950
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
8279
8951
|
* consumption that is returned in the response:</p>
|
|
8280
8952
|
* <ul>
|
|
@@ -8303,6 +8975,7 @@ export interface DeleteItemInput {
|
|
|
8303
8975
|
*/
|
|
8304
8976
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
8305
8977
|
/**
|
|
8978
|
+
* @public
|
|
8306
8979
|
* <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>,
|
|
8307
8980
|
* the response includes statistics about item collections, if any, that were modified
|
|
8308
8981
|
* during the operation are returned in the response. If set to <code>NONE</code> (the
|
|
@@ -8310,6 +8983,7 @@ export interface DeleteItemInput {
|
|
|
8310
8983
|
*/
|
|
8311
8984
|
ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics | string;
|
|
8312
8985
|
/**
|
|
8986
|
+
* @public
|
|
8313
8987
|
* <p>A condition that must be satisfied in order for a conditional <code>DeleteItem</code>
|
|
8314
8988
|
* to succeed.</p>
|
|
8315
8989
|
* <p>An expression can contain any of the following:</p>
|
|
@@ -8336,6 +9010,7 @@ export interface DeleteItemInput {
|
|
|
8336
9010
|
*/
|
|
8337
9011
|
ConditionExpression?: string;
|
|
8338
9012
|
/**
|
|
9013
|
+
* @public
|
|
8339
9014
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
8340
9015
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
8341
9016
|
* <ul>
|
|
@@ -8390,6 +9065,7 @@ export interface DeleteItemInput {
|
|
|
8390
9065
|
*/
|
|
8391
9066
|
ExpressionAttributeNames?: Record<string, string>;
|
|
8392
9067
|
/**
|
|
9068
|
+
* @public
|
|
8393
9069
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
8394
9070
|
* <p>Use the <b>:</b> (colon) character in an expression to
|
|
8395
9071
|
* dereference an attribute value. For example, suppose that you wanted to check whether
|
|
@@ -8412,6 +9088,7 @@ export interface DeleteItemInput {
|
|
|
8412
9088
|
*/
|
|
8413
9089
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
8414
9090
|
/**
|
|
9091
|
+
* @public
|
|
8415
9092
|
* <p>An optional parameter that returns the item attributes for a <code>DeleteItem</code>
|
|
8416
9093
|
* operation that failed a condition check.</p>
|
|
8417
9094
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
@@ -8426,10 +9103,12 @@ export interface DeleteItemInput {
|
|
|
8426
9103
|
*/
|
|
8427
9104
|
export interface PutItemInput {
|
|
8428
9105
|
/**
|
|
9106
|
+
* @public
|
|
8429
9107
|
* <p>The name of the table to contain the item.</p>
|
|
8430
9108
|
*/
|
|
8431
9109
|
TableName: string | undefined;
|
|
8432
9110
|
/**
|
|
9111
|
+
* @public
|
|
8433
9112
|
* <p>A map of attribute name/value pairs, one for each attribute. Only the primary key
|
|
8434
9113
|
* attributes are required; you can optionally provide other attribute name-value pairs for
|
|
8435
9114
|
* the item.</p>
|
|
@@ -8450,12 +9129,14 @@ export interface PutItemInput {
|
|
|
8450
9129
|
*/
|
|
8451
9130
|
Item: Record<string, AttributeValue> | undefined;
|
|
8452
9131
|
/**
|
|
9132
|
+
* @public
|
|
8453
9133
|
* <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more
|
|
8454
9134
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer
|
|
8455
9135
|
* Guide</i>.</p>
|
|
8456
9136
|
*/
|
|
8457
9137
|
Expected?: Record<string, ExpectedAttributeValue>;
|
|
8458
9138
|
/**
|
|
9139
|
+
* @public
|
|
8459
9140
|
* <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared
|
|
8460
9141
|
* before they were updated with the <code>PutItem</code> request. For
|
|
8461
9142
|
* <code>PutItem</code>, the valid values are:</p>
|
|
@@ -8484,6 +9165,7 @@ export interface PutItemInput {
|
|
|
8484
9165
|
*/
|
|
8485
9166
|
ReturnValues?: ReturnValue | string;
|
|
8486
9167
|
/**
|
|
9168
|
+
* @public
|
|
8487
9169
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
8488
9170
|
* consumption that is returned in the response:</p>
|
|
8489
9171
|
* <ul>
|
|
@@ -8512,6 +9194,7 @@ export interface PutItemInput {
|
|
|
8512
9194
|
*/
|
|
8513
9195
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
8514
9196
|
/**
|
|
9197
|
+
* @public
|
|
8515
9198
|
* <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>,
|
|
8516
9199
|
* the response includes statistics about item collections, if any, that were modified
|
|
8517
9200
|
* during the operation are returned in the response. If set to <code>NONE</code> (the
|
|
@@ -8519,12 +9202,14 @@ export interface PutItemInput {
|
|
|
8519
9202
|
*/
|
|
8520
9203
|
ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics | string;
|
|
8521
9204
|
/**
|
|
9205
|
+
* @public
|
|
8522
9206
|
* <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more
|
|
8523
9207
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer
|
|
8524
9208
|
* Guide</i>.</p>
|
|
8525
9209
|
*/
|
|
8526
9210
|
ConditionalOperator?: ConditionalOperator | string;
|
|
8527
9211
|
/**
|
|
9212
|
+
* @public
|
|
8528
9213
|
* <p>A condition that must be satisfied in order for a conditional <code>PutItem</code>
|
|
8529
9214
|
* operation to succeed.</p>
|
|
8530
9215
|
* <p>An expression can contain any of the following:</p>
|
|
@@ -8551,6 +9236,7 @@ export interface PutItemInput {
|
|
|
8551
9236
|
*/
|
|
8552
9237
|
ConditionExpression?: string;
|
|
8553
9238
|
/**
|
|
9239
|
+
* @public
|
|
8554
9240
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
8555
9241
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
8556
9242
|
* <ul>
|
|
@@ -8605,6 +9291,7 @@ export interface PutItemInput {
|
|
|
8605
9291
|
*/
|
|
8606
9292
|
ExpressionAttributeNames?: Record<string, string>;
|
|
8607
9293
|
/**
|
|
9294
|
+
* @public
|
|
8608
9295
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
8609
9296
|
* <p>Use the <b>:</b> (colon) character in an expression to
|
|
8610
9297
|
* dereference an attribute value. For example, suppose that you wanted to check whether
|
|
@@ -8627,6 +9314,7 @@ export interface PutItemInput {
|
|
|
8627
9314
|
*/
|
|
8628
9315
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
8629
9316
|
/**
|
|
9317
|
+
* @public
|
|
8630
9318
|
* <p>An optional parameter that returns the item attributes for a <code>PutItem</code>
|
|
8631
9319
|
* operation that failed a condition check.</p>
|
|
8632
9320
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
@@ -8641,10 +9329,12 @@ export interface PutItemInput {
|
|
|
8641
9329
|
*/
|
|
8642
9330
|
export interface QueryInput {
|
|
8643
9331
|
/**
|
|
9332
|
+
* @public
|
|
8644
9333
|
* <p>The name of the table containing the requested items.</p>
|
|
8645
9334
|
*/
|
|
8646
9335
|
TableName: string | undefined;
|
|
8647
9336
|
/**
|
|
9337
|
+
* @public
|
|
8648
9338
|
* <p>The name of an index to query. This index can be any local secondary index or global
|
|
8649
9339
|
* secondary index on the table. Note that if you use the <code>IndexName</code> parameter,
|
|
8650
9340
|
* you must also provide <code>TableName.</code>
|
|
@@ -8652,6 +9342,7 @@ export interface QueryInput {
|
|
|
8652
9342
|
*/
|
|
8653
9343
|
IndexName?: string;
|
|
8654
9344
|
/**
|
|
9345
|
+
* @public
|
|
8655
9346
|
* <p>The attributes to be returned in the result. You can retrieve all item attributes,
|
|
8656
9347
|
* specific item attributes, the count of matching items, or in the case of an index, some
|
|
8657
9348
|
* or all of the attributes projected into the index.</p>
|
|
@@ -8709,12 +9400,14 @@ export interface QueryInput {
|
|
|
8709
9400
|
*/
|
|
8710
9401
|
Select?: Select | string;
|
|
8711
9402
|
/**
|
|
9403
|
+
* @public
|
|
8712
9404
|
* <p>This is a legacy parameter. Use <code>ProjectionExpression</code> instead. For more
|
|
8713
9405
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html">AttributesToGet</a> in the <i>Amazon DynamoDB Developer
|
|
8714
9406
|
* Guide</i>.</p>
|
|
8715
9407
|
*/
|
|
8716
9408
|
AttributesToGet?: string[];
|
|
8717
9409
|
/**
|
|
9410
|
+
* @public
|
|
8718
9411
|
* <p>The maximum number of items to evaluate (not necessarily the number of matching
|
|
8719
9412
|
* items). If DynamoDB processes the number of items up to the limit while processing the
|
|
8720
9413
|
* results, it stops the operation and returns the matching values up to that point, and a
|
|
@@ -8727,6 +9420,7 @@ export interface QueryInput {
|
|
|
8727
9420
|
*/
|
|
8728
9421
|
Limit?: number;
|
|
8729
9422
|
/**
|
|
9423
|
+
* @public
|
|
8730
9424
|
* <p>Determines the read consistency model: If set to <code>true</code>, then the operation
|
|
8731
9425
|
* uses strongly consistent reads; otherwise, the operation uses eventually consistent
|
|
8732
9426
|
* reads.</p>
|
|
@@ -8736,24 +9430,28 @@ export interface QueryInput {
|
|
|
8736
9430
|
*/
|
|
8737
9431
|
ConsistentRead?: boolean;
|
|
8738
9432
|
/**
|
|
9433
|
+
* @public
|
|
8739
9434
|
* <p>This is a legacy parameter. Use <code>KeyConditionExpression</code> instead. For more
|
|
8740
9435
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.KeyConditions.html">KeyConditions</a> in the <i>Amazon DynamoDB Developer
|
|
8741
9436
|
* Guide</i>.</p>
|
|
8742
9437
|
*/
|
|
8743
9438
|
KeyConditions?: Record<string, Condition>;
|
|
8744
9439
|
/**
|
|
9440
|
+
* @public
|
|
8745
9441
|
* <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more
|
|
8746
9442
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.QueryFilter.html">QueryFilter</a> in the <i>Amazon DynamoDB Developer
|
|
8747
9443
|
* Guide</i>.</p>
|
|
8748
9444
|
*/
|
|
8749
9445
|
QueryFilter?: Record<string, Condition>;
|
|
8750
9446
|
/**
|
|
9447
|
+
* @public
|
|
8751
9448
|
* <p>This is a legacy parameter. Use <code>FilterExpression</code> instead. For more
|
|
8752
9449
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer
|
|
8753
9450
|
* Guide</i>.</p>
|
|
8754
9451
|
*/
|
|
8755
9452
|
ConditionalOperator?: ConditionalOperator | string;
|
|
8756
9453
|
/**
|
|
9454
|
+
* @public
|
|
8757
9455
|
* <p>Specifies the order for index traversal: If <code>true</code> (default), the traversal
|
|
8758
9456
|
* is performed in ascending order; if <code>false</code>, the traversal is performed in
|
|
8759
9457
|
* descending order. </p>
|
|
@@ -8768,6 +9466,7 @@ export interface QueryInput {
|
|
|
8768
9466
|
*/
|
|
8769
9467
|
ScanIndexForward?: boolean;
|
|
8770
9468
|
/**
|
|
9469
|
+
* @public
|
|
8771
9470
|
* <p>The primary key of the first item that this operation will evaluate. Use the value
|
|
8772
9471
|
* that was returned for <code>LastEvaluatedKey</code> in the previous operation.</p>
|
|
8773
9472
|
* <p>The data type for <code>ExclusiveStartKey</code> must be String, Number, or Binary. No
|
|
@@ -8775,6 +9474,7 @@ export interface QueryInput {
|
|
|
8775
9474
|
*/
|
|
8776
9475
|
ExclusiveStartKey?: Record<string, AttributeValue>;
|
|
8777
9476
|
/**
|
|
9477
|
+
* @public
|
|
8778
9478
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
8779
9479
|
* consumption that is returned in the response:</p>
|
|
8780
9480
|
* <ul>
|
|
@@ -8803,6 +9503,7 @@ export interface QueryInput {
|
|
|
8803
9503
|
*/
|
|
8804
9504
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
8805
9505
|
/**
|
|
9506
|
+
* @public
|
|
8806
9507
|
* <p>A string that identifies one or more attributes to retrieve from the table. These
|
|
8807
9508
|
* attributes can include scalars, sets, or elements of a JSON document. The attributes in
|
|
8808
9509
|
* the expression must be separated by commas.</p>
|
|
@@ -8813,6 +9514,7 @@ export interface QueryInput {
|
|
|
8813
9514
|
*/
|
|
8814
9515
|
ProjectionExpression?: string;
|
|
8815
9516
|
/**
|
|
9517
|
+
* @public
|
|
8816
9518
|
* <p>A string that contains conditions that DynamoDB applies after the <code>Query</code>
|
|
8817
9519
|
* operation, but before the data is returned to you. Items that do not satisfy the
|
|
8818
9520
|
* <code>FilterExpression</code> criteria are not returned.</p>
|
|
@@ -8827,6 +9529,7 @@ export interface QueryInput {
|
|
|
8827
9529
|
*/
|
|
8828
9530
|
FilterExpression?: string;
|
|
8829
9531
|
/**
|
|
9532
|
+
* @public
|
|
8830
9533
|
* <p>The condition that specifies the key values for items to be retrieved by the
|
|
8831
9534
|
* <code>Query</code> action.</p>
|
|
8832
9535
|
* <p>The condition must perform an equality test on a single partition key value.</p>
|
|
@@ -8943,6 +9646,7 @@ export interface QueryInput {
|
|
|
8943
9646
|
*/
|
|
8944
9647
|
KeyConditionExpression?: string;
|
|
8945
9648
|
/**
|
|
9649
|
+
* @public
|
|
8946
9650
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
8947
9651
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
8948
9652
|
* <ul>
|
|
@@ -8997,6 +9701,7 @@ export interface QueryInput {
|
|
|
8997
9701
|
*/
|
|
8998
9702
|
ExpressionAttributeNames?: Record<string, string>;
|
|
8999
9703
|
/**
|
|
9704
|
+
* @public
|
|
9000
9705
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
9001
9706
|
* <p>Use the <b>:</b> (colon) character in an expression to
|
|
9002
9707
|
* dereference an attribute value. For example, suppose that you wanted to check whether
|
|
@@ -9025,6 +9730,7 @@ export interface QueryInput {
|
|
|
9025
9730
|
*/
|
|
9026
9731
|
export interface BatchWriteItemOutput {
|
|
9027
9732
|
/**
|
|
9733
|
+
* @public
|
|
9028
9734
|
* <p>A map of tables and requests against those tables that were not processed. The
|
|
9029
9735
|
* <code>UnprocessedItems</code> value is in the same form as
|
|
9030
9736
|
* <code>RequestItems</code>, so you can provide this value directly to a subsequent
|
|
@@ -9074,6 +9780,7 @@ export interface BatchWriteItemOutput {
|
|
|
9074
9780
|
*/
|
|
9075
9781
|
UnprocessedItems?: Record<string, WriteRequest[]>;
|
|
9076
9782
|
/**
|
|
9783
|
+
* @public
|
|
9077
9784
|
* <p>A list of tables that were processed by <code>BatchWriteItem</code> and, for each
|
|
9078
9785
|
* table, information about any item collections that were affected by individual
|
|
9079
9786
|
* <code>DeleteItem</code> or <code>PutItem</code> operations.</p>
|
|
@@ -9099,6 +9806,7 @@ export interface BatchWriteItemOutput {
|
|
|
9099
9806
|
*/
|
|
9100
9807
|
ItemCollectionMetrics?: Record<string, ItemCollectionMetrics[]>;
|
|
9101
9808
|
/**
|
|
9809
|
+
* @public
|
|
9102
9810
|
* <p>The capacity units consumed by the entire <code>BatchWriteItem</code>
|
|
9103
9811
|
* operation.</p>
|
|
9104
9812
|
* <p>Each element consists of:</p>
|
|
@@ -9122,10 +9830,12 @@ export interface BatchWriteItemOutput {
|
|
|
9122
9830
|
*/
|
|
9123
9831
|
export interface UpdateItemInput {
|
|
9124
9832
|
/**
|
|
9833
|
+
* @public
|
|
9125
9834
|
* <p>The name of the table containing the item to update.</p>
|
|
9126
9835
|
*/
|
|
9127
9836
|
TableName: string | undefined;
|
|
9128
9837
|
/**
|
|
9838
|
+
* @public
|
|
9129
9839
|
* <p>The primary key of the item to be updated. Each element consists of an attribute name
|
|
9130
9840
|
* and a value for that attribute.</p>
|
|
9131
9841
|
* <p>For the primary key, you must provide all of the attributes. For example, with a
|
|
@@ -9135,24 +9845,28 @@ export interface UpdateItemInput {
|
|
|
9135
9845
|
*/
|
|
9136
9846
|
Key: Record<string, AttributeValue> | undefined;
|
|
9137
9847
|
/**
|
|
9848
|
+
* @public
|
|
9138
9849
|
* <p>This is a legacy parameter. Use <code>UpdateExpression</code> instead. For more
|
|
9139
9850
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributeUpdates.html">AttributeUpdates</a> in the <i>Amazon DynamoDB Developer
|
|
9140
9851
|
* Guide</i>.</p>
|
|
9141
9852
|
*/
|
|
9142
9853
|
AttributeUpdates?: Record<string, AttributeValueUpdate>;
|
|
9143
9854
|
/**
|
|
9855
|
+
* @public
|
|
9144
9856
|
* <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more
|
|
9145
9857
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.Expected.html">Expected</a> in the <i>Amazon DynamoDB Developer
|
|
9146
9858
|
* Guide</i>.</p>
|
|
9147
9859
|
*/
|
|
9148
9860
|
Expected?: Record<string, ExpectedAttributeValue>;
|
|
9149
9861
|
/**
|
|
9862
|
+
* @public
|
|
9150
9863
|
* <p>This is a legacy parameter. Use <code>ConditionExpression</code> instead. For more
|
|
9151
9864
|
* information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.ConditionalOperator.html">ConditionalOperator</a> in the <i>Amazon DynamoDB Developer
|
|
9152
9865
|
* Guide</i>.</p>
|
|
9153
9866
|
*/
|
|
9154
9867
|
ConditionalOperator?: ConditionalOperator | string;
|
|
9155
9868
|
/**
|
|
9869
|
+
* @public
|
|
9156
9870
|
* <p>Use <code>ReturnValues</code> if you want to get the item attributes as they appear
|
|
9157
9871
|
* before or after they are successfully updated. For <code>UpdateItem</code>, the valid values
|
|
9158
9872
|
* are:</p>
|
|
@@ -9191,6 +9905,7 @@ export interface UpdateItemInput {
|
|
|
9191
9905
|
*/
|
|
9192
9906
|
ReturnValues?: ReturnValue | string;
|
|
9193
9907
|
/**
|
|
9908
|
+
* @public
|
|
9194
9909
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
9195
9910
|
* consumption that is returned in the response:</p>
|
|
9196
9911
|
* <ul>
|
|
@@ -9219,6 +9934,7 @@ export interface UpdateItemInput {
|
|
|
9219
9934
|
*/
|
|
9220
9935
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
9221
9936
|
/**
|
|
9937
|
+
* @public
|
|
9222
9938
|
* <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>,
|
|
9223
9939
|
* the response includes statistics about item collections, if any, that were modified
|
|
9224
9940
|
* during the operation are returned in the response. If set to <code>NONE</code> (the
|
|
@@ -9226,6 +9942,7 @@ export interface UpdateItemInput {
|
|
|
9226
9942
|
*/
|
|
9227
9943
|
ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics | string;
|
|
9228
9944
|
/**
|
|
9945
|
+
* @public
|
|
9229
9946
|
* <p>An expression that defines one or more attributes to be updated, the action to be
|
|
9230
9947
|
* performed on them, and new values for them.</p>
|
|
9231
9948
|
* <p>The following action values are available for <code>UpdateExpression</code>.</p>
|
|
@@ -9331,6 +10048,7 @@ export interface UpdateItemInput {
|
|
|
9331
10048
|
*/
|
|
9332
10049
|
UpdateExpression?: string;
|
|
9333
10050
|
/**
|
|
10051
|
+
* @public
|
|
9334
10052
|
* <p>A condition that must be satisfied in order for a conditional update to
|
|
9335
10053
|
* succeed.</p>
|
|
9336
10054
|
* <p>An expression can contain any of the following:</p>
|
|
@@ -9357,6 +10075,7 @@ export interface UpdateItemInput {
|
|
|
9357
10075
|
*/
|
|
9358
10076
|
ConditionExpression?: string;
|
|
9359
10077
|
/**
|
|
10078
|
+
* @public
|
|
9360
10079
|
* <p>One or more substitution tokens for attribute names in an expression. The following
|
|
9361
10080
|
* are some use cases for using <code>ExpressionAttributeNames</code>:</p>
|
|
9362
10081
|
* <ul>
|
|
@@ -9411,6 +10130,7 @@ export interface UpdateItemInput {
|
|
|
9411
10130
|
*/
|
|
9412
10131
|
ExpressionAttributeNames?: Record<string, string>;
|
|
9413
10132
|
/**
|
|
10133
|
+
* @public
|
|
9414
10134
|
* <p>One or more values that can be substituted in an expression.</p>
|
|
9415
10135
|
* <p>Use the <b>:</b> (colon) character in an expression to
|
|
9416
10136
|
* dereference an attribute value. For example, suppose that you wanted to check whether
|
|
@@ -9433,6 +10153,7 @@ export interface UpdateItemInput {
|
|
|
9433
10153
|
*/
|
|
9434
10154
|
ExpressionAttributeValues?: Record<string, AttributeValue>;
|
|
9435
10155
|
/**
|
|
10156
|
+
* @public
|
|
9436
10157
|
* <p>An optional parameter that returns the item attributes for an <code>UpdateItem</code> operation that failed a
|
|
9437
10158
|
* condition check.</p>
|
|
9438
10159
|
* <p>There is no additional cost associated with requesting a return value aside from the
|
|
@@ -9448,18 +10169,22 @@ export interface UpdateItemInput {
|
|
|
9448
10169
|
*/
|
|
9449
10170
|
export interface TransactWriteItem {
|
|
9450
10171
|
/**
|
|
10172
|
+
* @public
|
|
9451
10173
|
* <p>A request to perform a check item operation.</p>
|
|
9452
10174
|
*/
|
|
9453
10175
|
ConditionCheck?: ConditionCheck;
|
|
9454
10176
|
/**
|
|
10177
|
+
* @public
|
|
9455
10178
|
* <p>A request to perform a <code>PutItem</code> operation.</p>
|
|
9456
10179
|
*/
|
|
9457
10180
|
Put?: Put;
|
|
9458
10181
|
/**
|
|
10182
|
+
* @public
|
|
9459
10183
|
* <p>A request to perform a <code>DeleteItem</code> operation.</p>
|
|
9460
10184
|
*/
|
|
9461
10185
|
Delete?: Delete;
|
|
9462
10186
|
/**
|
|
10187
|
+
* @public
|
|
9463
10188
|
* <p>A request to perform an <code>UpdateItem</code> operation.</p>
|
|
9464
10189
|
*/
|
|
9465
10190
|
Update?: Update;
|
|
@@ -9469,6 +10194,7 @@ export interface TransactWriteItem {
|
|
|
9469
10194
|
*/
|
|
9470
10195
|
export interface TransactWriteItemsInput {
|
|
9471
10196
|
/**
|
|
10197
|
+
* @public
|
|
9472
10198
|
* <p>An ordered array of up to 100 <code>TransactWriteItem</code> objects, each of which
|
|
9473
10199
|
* contains a <code>ConditionCheck</code>, <code>Put</code>, <code>Update</code>, or
|
|
9474
10200
|
* <code>Delete</code> object. These can operate on items in different tables, but the
|
|
@@ -9477,6 +10203,7 @@ export interface TransactWriteItemsInput {
|
|
|
9477
10203
|
*/
|
|
9478
10204
|
TransactItems: TransactWriteItem[] | undefined;
|
|
9479
10205
|
/**
|
|
10206
|
+
* @public
|
|
9480
10207
|
* <p>Determines the level of detail about either provisioned or on-demand throughput
|
|
9481
10208
|
* consumption that is returned in the response:</p>
|
|
9482
10209
|
* <ul>
|
|
@@ -9505,6 +10232,7 @@ export interface TransactWriteItemsInput {
|
|
|
9505
10232
|
*/
|
|
9506
10233
|
ReturnConsumedCapacity?: ReturnConsumedCapacity | string;
|
|
9507
10234
|
/**
|
|
10235
|
+
* @public
|
|
9508
10236
|
* <p>Determines whether item collection metrics are returned. If set to <code>SIZE</code>,
|
|
9509
10237
|
* the response includes statistics about item collections (if any), that were modified
|
|
9510
10238
|
* during the operation and are returned in the response. If set to <code>NONE</code> (the
|
|
@@ -9512,6 +10240,7 @@ export interface TransactWriteItemsInput {
|
|
|
9512
10240
|
*/
|
|
9513
10241
|
ReturnItemCollectionMetrics?: ReturnItemCollectionMetrics | string;
|
|
9514
10242
|
/**
|
|
10243
|
+
* @public
|
|
9515
10244
|
* <p>Providing a <code>ClientRequestToken</code> makes the call to
|
|
9516
10245
|
* <code>TransactWriteItems</code> idempotent, meaning that multiple identical calls
|
|
9517
10246
|
* have the same effect as one single call.</p>
|