/
models_0.ts
11700 lines (10705 loc) · 438 KB
/
models_0.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// smithy-typescript generated code
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
import { DynamoDBServiceException as __BaseException } from "./DynamoDBServiceException";
/**
* <p>Contains details of a table archival operation.</p>
*/
export interface ArchivalSummary {
/**
* <p>The date and time when table archival was initiated by DynamoDB, in UNIX epoch time
* format.</p>
*/
ArchivalDateTime?: Date;
/**
* <p>The reason DynamoDB archived the table. Currently, the only possible value is:</p>
* <ul>
* <li>
* <p>
* <code>INACCESSIBLE_ENCRYPTION_CREDENTIALS</code> - The table was archived due
* to the table's KMS key being inaccessible for more than seven
* days. An On-Demand backup was created at the archival time.</p>
* </li>
* </ul>
*/
ArchivalReason?: string;
/**
* <p>The Amazon Resource Name (ARN) of the backup the table was archived to, when
* applicable in the archival reason. If you wish to restore this backup to the same table
* name, you will need to delete the original table.</p>
*/
ArchivalBackupArn?: string;
}
export enum AttributeAction {
ADD = "ADD",
DELETE = "DELETE",
PUT = "PUT",
}
export enum ScalarAttributeType {
B = "B",
N = "N",
S = "S",
}
/**
* <p>Represents an attribute for describing the key schema for the table and
* indexes.</p>
*/
export interface AttributeDefinition {
/**
* <p>A name for the attribute.</p>
*/
AttributeName: string | undefined;
/**
* <p>The data type for the attribute, where:</p>
* <ul>
* <li>
* <p>
* <code>S</code> - the attribute is of type String</p>
* </li>
* <li>
* <p>
* <code>N</code> - the attribute is of type Number</p>
* </li>
* <li>
* <p>
* <code>B</code> - the attribute is of type Binary</p>
* </li>
* </ul>
*/
AttributeType: ScalarAttributeType | string | undefined;
}
/**
* <p>Represents the properties of a target tracking scaling policy.</p>
*/
export interface AutoScalingTargetTrackingScalingPolicyConfigurationDescription {
/**
* <p>Indicates whether scale in by the target tracking policy is disabled. If the value is
* true, scale in is disabled and the target tracking policy won't remove capacity from the
* scalable resource. Otherwise, scale in is enabled and the target tracking policy can
* remove capacity from the scalable resource. The default value is false.</p>
*/
DisableScaleIn?: boolean;
/**
* <p>The amount of time, in seconds, after a scale in activity completes before another
* scale in activity can start. The cooldown period is used to block subsequent scale in
* requests until it has expired. You should scale in conservatively to protect your
* application's availability. However, if another alarm triggers a scale out policy during
* the cooldown period after a scale-in, application auto scaling scales out your scalable
* target immediately. </p>
*/
ScaleInCooldown?: number;
/**
* <p>The amount of time, in seconds, after a scale out activity completes before another
* scale out activity can start. While the cooldown period is in effect, the capacity that
* has been added by the previous scale out event that initiated the cooldown is calculated
* as part of the desired capacity for the next scale out. You should continuously (but not
* excessively) scale out.</p>
*/
ScaleOutCooldown?: number;
/**
* <p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)
* or 2e-360 to 2e360 (Base 2).</p>
*/
TargetValue: number | undefined;
}
/**
* <p>Represents the properties of the scaling policy.</p>
*/
export interface AutoScalingPolicyDescription {
/**
* <p>The name of the scaling policy.</p>
*/
PolicyName?: string;
/**
* <p>Represents a target tracking scaling policy configuration.</p>
*/
TargetTrackingScalingPolicyConfiguration?: AutoScalingTargetTrackingScalingPolicyConfigurationDescription;
}
/**
* <p>Represents the settings of a target tracking scaling policy that will be
* modified.</p>
*/
export interface AutoScalingTargetTrackingScalingPolicyConfigurationUpdate {
/**
* <p>Indicates whether scale in by the target tracking policy is disabled. If the value is
* true, scale in is disabled and the target tracking policy won't remove capacity from the
* scalable resource. Otherwise, scale in is enabled and the target tracking policy can
* remove capacity from the scalable resource. The default value is false.</p>
*/
DisableScaleIn?: boolean;
/**
* <p>The amount of time, in seconds, after a scale in activity completes before another
* scale in activity can start. The cooldown period is used to block subsequent scale in
* requests until it has expired. You should scale in conservatively to protect your
* application's availability. However, if another alarm triggers a scale out policy during
* the cooldown period after a scale-in, application auto scaling scales out your scalable
* target immediately. </p>
*/
ScaleInCooldown?: number;
/**
* <p>The amount of time, in seconds, after a scale out activity completes before another
* scale out activity can start. While the cooldown period is in effect, the capacity that
* has been added by the previous scale out event that initiated the cooldown is calculated
* as part of the desired capacity for the next scale out. You should continuously (but not
* excessively) scale out.</p>
*/
ScaleOutCooldown?: number;
/**
* <p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)
* or 2e-360 to 2e360 (Base 2).</p>
*/
TargetValue: number | undefined;
}
/**
* <p>Represents the auto scaling policy to be modified.</p>
*/
export interface AutoScalingPolicyUpdate {
/**
* <p>The name of the scaling policy.</p>
*/
PolicyName?: string;
/**
* <p>Represents a target tracking scaling policy configuration.</p>
*/
TargetTrackingScalingPolicyConfiguration: AutoScalingTargetTrackingScalingPolicyConfigurationUpdate | undefined;
}
/**
* <p>Represents the auto scaling settings for a global table or global secondary
* index.</p>
*/
export interface AutoScalingSettingsDescription {
/**
* <p>The minimum capacity units that a global table or global secondary index should be
* scaled down to.</p>
*/
MinimumUnits?: number;
/**
* <p>The maximum capacity units that a global table or global secondary index should be
* scaled up to.</p>
*/
MaximumUnits?: number;
/**
* <p>Disabled auto scaling for this global table or global secondary index.</p>
*/
AutoScalingDisabled?: boolean;
/**
* <p>Role ARN used for configuring the auto scaling policy.</p>
*/
AutoScalingRoleArn?: string;
/**
* <p>Information about the scaling policies.</p>
*/
ScalingPolicies?: AutoScalingPolicyDescription[];
}
/**
* <p>Represents the auto scaling settings to be modified for a global table or global
* secondary index.</p>
*/
export interface AutoScalingSettingsUpdate {
/**
* <p>The minimum capacity units that a global table or global secondary index should be
* scaled down to.</p>
*/
MinimumUnits?: number;
/**
* <p>The maximum capacity units that a global table or global secondary index should be
* scaled up to.</p>
*/
MaximumUnits?: number;
/**
* <p>Disabled auto scaling for this global table or global secondary index.</p>
*/
AutoScalingDisabled?: boolean;
/**
* <p>Role ARN used for configuring auto scaling policy.</p>
*/
AutoScalingRoleArn?: string;
/**
* <p>The scaling policy to apply for scaling target global table or global secondary index
* capacity units.</p>
*/
ScalingPolicyUpdate?: AutoScalingPolicyUpdate;
}
export enum BackupStatus {
AVAILABLE = "AVAILABLE",
CREATING = "CREATING",
DELETED = "DELETED",
}
export enum BackupType {
AWS_BACKUP = "AWS_BACKUP",
SYSTEM = "SYSTEM",
USER = "USER",
}
/**
* <p>Contains the details of the backup created for the table.</p>
*/
export interface BackupDetails {
/**
* <p>ARN associated with the backup.</p>
*/
BackupArn: string | undefined;
/**
* <p>Name of the requested backup.</p>
*/
BackupName: string | undefined;
/**
* <p>Size of the backup in bytes. DynamoDB updates this value approximately every six
* hours. Recent changes might not be reflected in this value.</p>
*/
BackupSizeBytes?: number;
/**
* <p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED. </p>
*/
BackupStatus: BackupStatus | string | undefined;
/**
* <p>BackupType:</p>
* <ul>
* <li>
* <p>
* <code>USER</code> - You create and manage these using the on-demand backup
* feature.</p>
* </li>
* <li>
* <p>
* <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled,
* a <code>SYSTEM</code> backup is automatically created and is retained for 35
* days (at no additional cost). System backups allow you to restore the deleted
* table to the state it was in just before the point of deletion. </p>
* </li>
* <li>
* <p>
* <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service.</p>
* </li>
* </ul>
*/
BackupType: BackupType | string | undefined;
/**
* <p>Time at which the backup was created. This is the request time of the backup. </p>
*/
BackupCreationDateTime: Date | undefined;
/**
* <p>Time at which the automatic on-demand backup created by DynamoDB will
* expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after
* its creation.</p>
*/
BackupExpiryDateTime?: Date;
}
export enum BillingMode {
PAY_PER_REQUEST = "PAY_PER_REQUEST",
PROVISIONED = "PROVISIONED",
}
export enum KeyType {
HASH = "HASH",
RANGE = "RANGE",
}
/**
* <p>Represents <i>a single element</i> of a key schema. A key schema
* specifies the attributes that make up the primary key of a table, or the key attributes
* of an index.</p>
* <p>A <code>KeySchemaElement</code> represents exactly one attribute of the primary key.
* For example, a simple primary key would be represented by one
* <code>KeySchemaElement</code> (for the partition key). A composite primary key would
* require one <code>KeySchemaElement</code> for the partition key, and another
* <code>KeySchemaElement</code> for the sort key.</p>
* <p>A <code>KeySchemaElement</code> must be a scalar, top-level attribute (not a nested
* attribute). The data type must be one of String, Number, or Binary. The attribute cannot
* be nested within a List or a Map.</p>
*/
export interface KeySchemaElement {
/**
* <p>The name of a key attribute.</p>
*/
AttributeName: string | undefined;
/**
* <p>The role that this key attribute will assume:</p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key</p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key</p>
* </li>
* </ul>
* <note>
* <p>The partition key of an item is also known as its <i>hash
* attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across
* partitions, based on their partition key values.</p>
* <p>The sort key of an item is also known as its <i>range attribute</i>.
* The term "range attribute" derives from the way DynamoDB stores items with
* the same partition key physically close together, in sorted order by the sort key
* value.</p>
* </note>
*/
KeyType: KeyType | string | undefined;
}
/**
* <p>Represents the provisioned throughput settings for a specified table or index. The
* settings can be modified using the <code>UpdateTable</code> operation.</p>
* <p>For current minimum and maximum provisioned throughput values, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html">Service,
* Account, and Table Quotas</a> in the <i>Amazon DynamoDB Developer
* Guide</i>.</p>
*/
export interface ProvisionedThroughput {
/**
* <p>The maximum number of strongly consistent reads consumed per second before DynamoDB
* 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
* Developer Guide</i>.</p>
* <p>If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to
* 0.</p>
*/
ReadCapacityUnits: number | undefined;
/**
* <p>The maximum number of writes consumed per second before DynamoDB 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
* Developer Guide</i>.</p>
* <p>If read/write capacity mode is <code>PAY_PER_REQUEST</code> the value is set to
* 0.</p>
*/
WriteCapacityUnits: number | undefined;
}
/**
* <p>Contains the details of the table when the backup was created. </p>
*/
export interface SourceTableDetails {
/**
* <p>The name of the table for which the backup was created. </p>
*/
TableName: string | undefined;
/**
* <p>Unique identifier for the table for which the backup was created. </p>
*/
TableId: string | undefined;
/**
* <p>ARN of the table for which backup was created. </p>
*/
TableArn?: string;
/**
* <p>Size of the table in bytes. Note that this is an approximate value.</p>
*/
TableSizeBytes?: number;
/**
* <p>Schema of the table. </p>
*/
KeySchema: KeySchemaElement[] | undefined;
/**
* <p>Time when the source table was created. </p>
*/
TableCreationDateTime: Date | undefined;
/**
* <p>Read IOPs and Write IOPS on the table when the backup was created.</p>
*/
ProvisionedThroughput: ProvisionedThroughput | undefined;
/**
* <p>Number of items in the table. Note that this is an approximate value. </p>
*/
ItemCount?: number;
/**
* <p>Controls how you are charged for read and write throughput and how you manage
* capacity. This setting can be changed later.</p>
* <ul>
* <li>
* <p>
* <code>PROVISIONED</code> - Sets the read/write capacity mode to
* <code>PROVISIONED</code>. We recommend using <code>PROVISIONED</code> for
* predictable workloads.</p>
* </li>
* <li>
* <p>
* <code>PAY_PER_REQUEST</code> - Sets the read/write capacity mode to
* <code>PAY_PER_REQUEST</code>. We recommend using
* <code>PAY_PER_REQUEST</code> for unpredictable workloads. </p>
* </li>
* </ul>
*/
BillingMode?: BillingMode | string;
}
export enum ProjectionType {
ALL = "ALL",
INCLUDE = "INCLUDE",
KEYS_ONLY = "KEYS_ONLY",
}
/**
* <p>Represents attributes that are copied (projected) from the table into an index. These
* are in addition to the primary key attributes and index key attributes, which are
* automatically projected.</p>
*/
export interface Projection {
/**
* <p>The set of attributes that are projected into the index:</p>
* <ul>
* <li>
* <p>
* <code>KEYS_ONLY</code> - Only the index and primary keys are projected into the
* index.</p>
* </li>
* <li>
* <p>
* <code>INCLUDE</code> - In addition to the attributes described in
* <code>KEYS_ONLY</code>, the secondary index will include other non-key
* attributes that you specify.</p>
* </li>
* <li>
* <p>
* <code>ALL</code> - All of the table attributes are projected into the
* index.</p>
* </li>
* </ul>
*/
ProjectionType?: ProjectionType | string;
/**
* <p>Represents the non-key attribute names which will be projected into the index.</p>
* <p>For local secondary indexes, the total count of <code>NonKeyAttributes</code> summed
* across all of the local secondary indexes, must not exceed 100. If you project the same
* attribute into two different indexes, this counts as two distinct attributes when
* determining the total.</p>
*/
NonKeyAttributes?: string[];
}
/**
* <p>Represents the properties of a global secondary index for the table when the backup
* was created.</p>
*/
export interface GlobalSecondaryIndexInfo {
/**
* <p>The name of the global secondary index.</p>
*/
IndexName?: string;
/**
* <p>The complete key schema for a global secondary index, which consists of one or more
* pairs of attribute names and key types:</p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key</p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key</p>
* </li>
* </ul>
* <note>
* <p>The partition key of an item is also known as its <i>hash
* attribute</i>. The term "hash attribute" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across
* partitions, based on their partition key values.</p>
* <p>The sort key of an item is also known as its <i>range attribute</i>.
* The term "range attribute" derives from the way DynamoDB stores items with
* the same partition key physically close together, in sorted order by the sort key
* value.</p>
* </note>
*/
KeySchema?: KeySchemaElement[];
/**
* <p>Represents attributes that are copied (projected) from the table into the global
* secondary index. These are in addition to the primary key attributes and index key
* attributes, which are automatically projected. </p>
*/
Projection?: Projection;
/**
* <p>Represents the provisioned throughput settings for the specified global secondary
* index. </p>
*/
ProvisionedThroughput?: ProvisionedThroughput;
}
/**
* <p>Represents the properties of a local secondary index for the table when the backup was
* created.</p>
*/
export interface LocalSecondaryIndexInfo {
/**
* <p>Represents the name of the local secondary index.</p>
*/
IndexName?: string;
/**
* <p>The complete key schema for a local secondary index, which consists of one or more
* pairs of attribute names and key types:</p>
* <ul>
* <li>
* <p>
* <code>HASH</code> - partition key</p>
* </li>
* <li>
* <p>
* <code>RANGE</code> - sort key</p>
* </li>
* </ul>
* <note>
* <p>The partition key of an item is also known as its <i>hash
* attribute</i>. The term "hash attribute" derives from DynamoDB's usage of
* an internal hash function to evenly distribute data items across partitions, based
* on their partition key values.</p>
* <p>The sort key of an item is also known as its <i>range attribute</i>.
* The term "range attribute" derives from the way DynamoDB stores items with the same
* partition key physically close together, in sorted order by the sort key
* value.</p>
* </note>
*/
KeySchema?: KeySchemaElement[];
/**
* <p>Represents attributes that are copied (projected) from the table into the global
* secondary index. These are in addition to the primary key attributes and index key
* attributes, which are automatically projected. </p>
*/
Projection?: Projection;
}
export enum SSEType {
AES256 = "AES256",
KMS = "KMS",
}
export enum SSEStatus {
DISABLED = "DISABLED",
DISABLING = "DISABLING",
ENABLED = "ENABLED",
ENABLING = "ENABLING",
UPDATING = "UPDATING",
}
/**
* <p>The description of the server-side encryption status on the specified table.</p>
*/
export interface SSEDescription {
/**
* <p>Represents the current state of server-side encryption. The only supported values
* are:</p>
* <ul>
* <li>
* <p>
* <code>ENABLED</code> - Server-side encryption is enabled.</p>
* </li>
* <li>
* <p>
* <code>UPDATING</code> - Server-side encryption is being updated.</p>
* </li>
* </ul>
*/
Status?: SSEStatus | string;
/**
* <p>Server-side encryption type. The only supported value is:</p>
* <ul>
* <li>
* <p>
* <code>KMS</code> - Server-side encryption that uses Key Management Service. The
* key is stored in your account and is managed by KMS (KMS charges apply).</p>
* </li>
* </ul>
*/
SSEType?: SSEType | string;
/**
* <p>The KMS key ARN used for the KMS encryption.</p>
*/
KMSMasterKeyArn?: string;
/**
* <p>Indicates the time, in UNIX epoch date format, when DynamoDB detected that
* the table's KMS key was inaccessible. This attribute will automatically
* be cleared when DynamoDB detects that the table's KMS key is accessible
* again. DynamoDB will initiate the table archival process when table's KMS key remains inaccessible for more than seven days from this date.</p>
*/
InaccessibleEncryptionDateTime?: Date;
}
export enum StreamViewType {
KEYS_ONLY = "KEYS_ONLY",
NEW_AND_OLD_IMAGES = "NEW_AND_OLD_IMAGES",
NEW_IMAGE = "NEW_IMAGE",
OLD_IMAGE = "OLD_IMAGE",
}
/**
* <p>Represents the DynamoDB Streams configuration for a table in DynamoDB.</p>
*/
export interface StreamSpecification {
/**
* <p>Indicates whether DynamoDB Streams is enabled (true) or disabled (false) on the
* table.</p>
*/
StreamEnabled: boolean | undefined;
/**
* <p> When an item in the table is modified, <code>StreamViewType</code> determines what
* information is written to the stream for this table. Valid values for
* <code>StreamViewType</code> are:</p>
* <ul>
* <li>
* <p>
* <code>KEYS_ONLY</code> - Only the key attributes of the modified item are
* written to the stream.</p>
* </li>
* <li>
* <p>
* <code>NEW_IMAGE</code> - The entire item, as it appears after it was modified,
* is written to the stream.</p>
* </li>
* <li>
* <p>
* <code>OLD_IMAGE</code> - The entire item, as it appeared before it was modified,
* is written to the stream.</p>
* </li>
* <li>
* <p>
* <code>NEW_AND_OLD_IMAGES</code> - Both the new and the old item images of the
* item are written to the stream.</p>
* </li>
* </ul>
*/
StreamViewType?: StreamViewType | string;
}
export enum TimeToLiveStatus {
DISABLED = "DISABLED",
DISABLING = "DISABLING",
ENABLED = "ENABLED",
ENABLING = "ENABLING",
}
/**
* <p>The description of the Time to Live (TTL) status on the specified table. </p>
*/
export interface TimeToLiveDescription {
/**
* <p> The TTL status for the table.</p>
*/
TimeToLiveStatus?: TimeToLiveStatus | string;
/**
* <p> The name of the TTL attribute for items in the table.</p>
*/
AttributeName?: string;
}
/**
* <p>Contains the details of the features enabled on the table when the backup was created.
* For example, LSIs, GSIs, streams, TTL. </p>
*/
export interface SourceTableFeatureDetails {
/**
* <p>Represents the LSI properties for the table when the backup was created. It includes
* the IndexName, KeySchema and Projection for the LSIs on the table at the time of backup.
* </p>
*/
LocalSecondaryIndexes?: LocalSecondaryIndexInfo[];
/**
* <p>Represents the GSI properties for the table when the backup was created. It includes
* the IndexName, KeySchema, Projection, and ProvisionedThroughput for the GSIs on the
* table at the time of backup. </p>
*/
GlobalSecondaryIndexes?: GlobalSecondaryIndexInfo[];
/**
* <p>Stream settings on the table when the backup was created.</p>
*/
StreamDescription?: StreamSpecification;
/**
* <p>Time to Live settings on the table when the backup was created.</p>
*/
TimeToLiveDescription?: TimeToLiveDescription;
/**
* <p>The description of the server-side encryption status on the table when the backup was
* created.</p>
*/
SSEDescription?: SSEDescription;
}
/**
* <p>Contains the description of the backup created for the table.</p>
*/
export interface BackupDescription {
/**
* <p>Contains the details of the backup created for the table. </p>
*/
BackupDetails?: BackupDetails;
/**
* <p>Contains the details of the table when the backup was created. </p>
*/
SourceTableDetails?: SourceTableDetails;
/**
* <p>Contains the details of the features enabled on the table when the backup was created.
* For example, LSIs, GSIs, streams, TTL.</p>
*/
SourceTableFeatureDetails?: SourceTableFeatureDetails;
}
/**
* <p>There is another ongoing conflicting backup control plane operation on the table.
* The backup is either being created, deleted or restored to a table.</p>
*/
export class BackupInUseException extends __BaseException {
readonly name: "BackupInUseException" = "BackupInUseException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<BackupInUseException, __BaseException>) {
super({
name: "BackupInUseException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, BackupInUseException.prototype);
}
}
/**
* <p>Backup not found for the given BackupARN. </p>
*/
export class BackupNotFoundException extends __BaseException {
readonly name: "BackupNotFoundException" = "BackupNotFoundException";
readonly $fault: "client" = "client";
/**
* @internal
*/
constructor(opts: __ExceptionOptionType<BackupNotFoundException, __BaseException>) {
super({
name: "BackupNotFoundException",
$fault: "client",
...opts,
});
Object.setPrototypeOf(this, BackupNotFoundException.prototype);
}
}
/**
* <p>Contains details for the backup.</p>
*/
export interface BackupSummary {
/**
* <p>Name of the table.</p>
*/
TableName?: string;
/**
* <p>Unique identifier for the table.</p>
*/
TableId?: string;
/**
* <p>ARN associated with the table.</p>
*/
TableArn?: string;
/**
* <p>ARN associated with the backup.</p>
*/
BackupArn?: string;
/**
* <p>Name of the specified backup.</p>
*/
BackupName?: string;
/**
* <p>Time at which the backup was created.</p>
*/
BackupCreationDateTime?: Date;
/**
* <p>Time at which the automatic on-demand backup created by DynamoDB will
* expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after
* its creation.</p>
*/
BackupExpiryDateTime?: Date;
/**
* <p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED.</p>
*/
BackupStatus?: BackupStatus | string;
/**
* <p>BackupType:</p>
* <ul>
* <li>
* <p>
* <code>USER</code> - You create and manage these using the on-demand backup
* feature.</p>
* </li>
* <li>
* <p>
* <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled,
* a <code>SYSTEM</code> backup is automatically created and is retained for 35
* days (at no additional cost). System backups allow you to restore the deleted
* table to the state it was in just before the point of deletion. </p>
* </li>
* <li>
* <p>
* <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service.</p>
* </li>
* </ul>
*/
BackupType?: BackupType | string;
/**
* <p>Size of the backup in bytes.</p>
*/
BackupSizeBytes?: number;
}
export enum BackupTypeFilter {
ALL = "ALL",
AWS_BACKUP = "AWS_BACKUP",
SYSTEM = "SYSTEM",
USER = "USER",
}
export enum ReturnConsumedCapacity {
INDEXES = "INDEXES",
NONE = "NONE",
TOTAL = "TOTAL",
}
/**
* <p>Represents the amount of provisioned throughput capacity consumed on a table or an
* index.</p>
*/
export interface Capacity {
/**
* <p>The total number of read capacity units consumed on a table or an index.</p>
*/
ReadCapacityUnits?: number;
/**
* <p>The total number of write capacity units consumed on a table or an index.</p>
*/
WriteCapacityUnits?: number;
/**
* <p>The total number of capacity units consumed on a table or an index.</p>
*/
CapacityUnits?: number;
}
/**
* <p>The capacity units consumed by an operation. The data returned includes the total
* provisioned throughput consumed, along with statistics for the table and any indexes
* involved in the operation. <code>ConsumedCapacity</code> is only returned if the request
* asked for it. For more information, see <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughputIntro.html">Provisioned Throughput</a> in the <i>Amazon DynamoDB Developer
* Guide</i>.</p>
*/
export interface ConsumedCapacity {
/**
* <p>The name of the table that was affected by the operation.</p>
*/
TableName?: string;
/**
* <p>The total number of capacity units consumed by the operation.</p>
*/
CapacityUnits?: number;
/**
* <p>The total number of read capacity units consumed by the operation.</p>
*/
ReadCapacityUnits?: number;
/**
* <p>The total number of write capacity units consumed by the operation.</p>
*/
WriteCapacityUnits?: number;
/**
* <p>The amount of throughput consumed on the table affected by the operation.</p>
*/
Table?: Capacity;
/**
* <p>The amount of throughput consumed on each local index affected by the
* operation.</p>
*/
LocalSecondaryIndexes?: Record<string, Capacity>;
/**
* <p>The amount of throughput consumed on each global index affected by the
* operation.</p>
*/
GlobalSecondaryIndexes?: Record<string, Capacity>;
}
export enum BatchStatementErrorCodeEnum {
AccessDenied = "AccessDenied",
ConditionalCheckFailed = "ConditionalCheckFailed",
DuplicateItem = "DuplicateItem",
InternalServerError = "InternalServerError",
ItemCollectionSizeLimitExceeded = "ItemCollectionSizeLimitExceeded",
ProvisionedThroughputExceeded = "ProvisionedThroughputExceeded",
RequestLimitExceeded = "RequestLimitExceeded",
ResourceNotFound = "ResourceNotFound",
ThrottlingError = "ThrottlingError",
TransactionConflict = "TransactionConflict",
ValidationError = "ValidationError",