-
Notifications
You must be signed in to change notification settings - Fork 250
/
Copy pathdynamodb.json
13846 lines (13846 loc) · 911 KB
/
dynamodb.json
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": "2.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
},
{
"id": "RuleSetAwsBuiltIn.AWS::Auth::AccountIdEndpointMode",
"namespace": "*"
},
{
"id": "RuleSetAwsBuiltIn.AWS::Auth::AccountId",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.dynamodb#ApproximateCreationDateTimePrecision": {
"type": "enum",
"members": {
"MILLISECOND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MILLISECOND"
}
},
"MICROSECOND": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "MICROSECOND"
}
}
}
},
"com.amazonaws.dynamodb#ArchivalReason": {
"type": "string"
},
"com.amazonaws.dynamodb#ArchivalSummary": {
"type": "structure",
"members": {
"ArchivalDateTime": {
"target": "com.amazonaws.dynamodb#Date",
"traits": {
"smithy.api#documentation": "<p>The date and time when table archival was initiated by DynamoDB, in UNIX epoch time\n format.</p>"
}
},
"ArchivalReason": {
"target": "com.amazonaws.dynamodb#ArchivalReason",
"traits": {
"smithy.api#documentation": "<p>The reason DynamoDB archived the table. Currently, the only possible value is:</p>\n <ul>\n <li>\n <p>\n <code>INACCESSIBLE_ENCRYPTION_CREDENTIALS</code> - The table was archived due\n to the table's KMS key being inaccessible for more than seven\n days. An On-Demand backup was created at the archival time.</p>\n </li>\n </ul>"
}
},
"ArchivalBackupArn": {
"target": "com.amazonaws.dynamodb#BackupArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the backup the table was archived to, when\n applicable in the archival reason. If you wish to restore this backup to the same table\n name, you will need to delete the original table.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details of a table archival operation.</p>"
}
},
"com.amazonaws.dynamodb#AttributeAction": {
"type": "enum",
"members": {
"ADD": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ADD"
}
},
"PUT": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "PUT"
}
},
"DELETE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DELETE"
}
}
}
},
"com.amazonaws.dynamodb#AttributeDefinition": {
"type": "structure",
"members": {
"AttributeName": {
"target": "com.amazonaws.dynamodb#KeySchemaAttributeName",
"traits": {
"smithy.api#documentation": "<p>A name for the attribute.</p>",
"smithy.api#required": {}
}
},
"AttributeType": {
"target": "com.amazonaws.dynamodb#ScalarAttributeType",
"traits": {
"smithy.api#documentation": "<p>The data type for the attribute, where:</p>\n <ul>\n <li>\n <p>\n <code>S</code> - the attribute is of type String</p>\n </li>\n <li>\n <p>\n <code>N</code> - the attribute is of type Number</p>\n </li>\n <li>\n <p>\n <code>B</code> - the attribute is of type Binary</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents an attribute for describing the schema for the table and\n indexes.</p>"
}
},
"com.amazonaws.dynamodb#AttributeDefinitions": {
"type": "list",
"member": {
"target": "com.amazonaws.dynamodb#AttributeDefinition"
}
},
"com.amazonaws.dynamodb#AttributeMap": {
"type": "map",
"key": {
"target": "com.amazonaws.dynamodb#AttributeName"
},
"value": {
"target": "com.amazonaws.dynamodb#AttributeValue"
}
},
"com.amazonaws.dynamodb#AttributeName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 0,
"max": 65535
}
}
},
"com.amazonaws.dynamodb#AttributeNameList": {
"type": "list",
"member": {
"target": "com.amazonaws.dynamodb#AttributeName"
},
"traits": {
"smithy.api#length": {
"min": 1
}
}
},
"com.amazonaws.dynamodb#AttributeUpdates": {
"type": "map",
"key": {
"target": "com.amazonaws.dynamodb#AttributeName"
},
"value": {
"target": "com.amazonaws.dynamodb#AttributeValueUpdate"
}
},
"com.amazonaws.dynamodb#AttributeValue": {
"type": "union",
"members": {
"S": {
"target": "com.amazonaws.dynamodb#StringAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type String. For example:</p>\n <p>\n <code>\"S\": \"Hello\"</code>\n </p>"
}
},
"N": {
"target": "com.amazonaws.dynamodb#NumberAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Number. For example:</p>\n <p>\n <code>\"N\": \"123.45\"</code>\n </p>\n <p>Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.</p>"
}
},
"B": {
"target": "com.amazonaws.dynamodb#BinaryAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Binary. For example:</p>\n <p>\n <code>\"B\": \"dGhpcyB0ZXh0IGlzIGJhc2U2NC1lbmNvZGVk\"</code>\n </p>"
}
},
"SS": {
"target": "com.amazonaws.dynamodb#StringSetAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type String Set. For example:</p>\n <p>\n <code>\"SS\": [\"Giraffe\", \"Hippo\" ,\"Zebra\"]</code>\n </p>"
}
},
"NS": {
"target": "com.amazonaws.dynamodb#NumberSetAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Number Set. For example:</p>\n <p>\n <code>\"NS\": [\"42.2\", \"-19\", \"7.5\", \"3.14\"]</code>\n </p>\n <p>Numbers are sent across the network to DynamoDB as strings, to maximize compatibility\n across languages and libraries. However, DynamoDB treats them as number type attributes\n for mathematical operations.</p>"
}
},
"BS": {
"target": "com.amazonaws.dynamodb#BinarySetAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Binary Set. For example:</p>\n <p>\n <code>\"BS\": [\"U3Vubnk=\", \"UmFpbnk=\", \"U25vd3k=\"]</code>\n </p>"
}
},
"M": {
"target": "com.amazonaws.dynamodb#MapAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Map. For example:</p>\n <p>\n <code>\"M\": {\"Name\": {\"S\": \"Joe\"}, \"Age\": {\"N\": \"35\"}}</code>\n </p>"
}
},
"L": {
"target": "com.amazonaws.dynamodb#ListAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type List. For example:</p>\n <p>\n <code>\"L\": [ {\"S\": \"Cookies\"} , {\"S\": \"Coffee\"}, {\"N\": \"3.14159\"}]</code>\n </p>"
}
},
"NULL": {
"target": "com.amazonaws.dynamodb#NullAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Null. For example:</p>\n <p>\n <code>\"NULL\": true</code>\n </p>"
}
},
"BOOL": {
"target": "com.amazonaws.dynamodb#BooleanAttributeValue",
"traits": {
"smithy.api#documentation": "<p>An attribute of type Boolean. For example:</p>\n <p>\n <code>\"BOOL\": true</code>\n </p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the data for an attribute.</p>\n <p>Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes\">Data Types</a> in the <i>Amazon DynamoDB Developer\n Guide</i>.</p>"
}
},
"com.amazonaws.dynamodb#AttributeValueList": {
"type": "list",
"member": {
"target": "com.amazonaws.dynamodb#AttributeValue"
}
},
"com.amazonaws.dynamodb#AttributeValueUpdate": {
"type": "structure",
"members": {
"Value": {
"target": "com.amazonaws.dynamodb#AttributeValue",
"traits": {
"smithy.api#documentation": "<p>Represents the data for an attribute.</p>\n <p>Each attribute value is described as a name-value pair. The name is the data type, and\n the value is the data itself.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes\">Data Types</a> in the <i>Amazon DynamoDB Developer Guide</i>.\n </p>"
}
},
"Action": {
"target": "com.amazonaws.dynamodb#AttributeAction",
"traits": {
"smithy.api#documentation": "<p>Specifies how to perform the update. Valid values are <code>PUT</code> (default),\n <code>DELETE</code>, and <code>ADD</code>. The behavior depends on whether the\n specified primary key already exists in the table.</p>\n <p>\n <b>If an item with the specified <i>Key</i> is found in\n the table:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>PUT</code> - Adds the specified attribute to the item. If the attribute\n already exists, it is replaced by the new value. </p>\n </li>\n <li>\n <p>\n <code>DELETE</code> - If no value is specified, the attribute and its value are\n removed from the item. The data type of the specified value must match the\n existing value's data type.</p>\n <p>If a <i>set</i> of values is specified, then those values are\n subtracted from the old set. For example, if the attribute value was the set\n <code>[a,b,c]</code> and the <code>DELETE</code> action specified\n <code>[a,c]</code>, then the final attribute value would be\n <code>[b]</code>. Specifying an empty set is an error.</p>\n </li>\n <li>\n <p>\n <code>ADD</code> - If the attribute does not already exist, then the attribute\n and its values are added to the item. If the attribute does exist, then the\n behavior of <code>ADD</code> depends on the data type of the attribute:</p>\n <ul>\n <li>\n <p>If the existing attribute is a number, and if <code>Value</code> is\n also a number, then the <code>Value</code> is mathematically added to\n the existing attribute. If <code>Value</code> is a negative number, then\n it is subtracted from the existing attribute.</p>\n <note>\n <p> If you use <code>ADD</code> to increment or decrement a number\n value for an item that doesn't exist before the update, DynamoDB\n uses 0 as the initial value.</p>\n <p>In addition, if you use <code>ADD</code> to update an existing\n item, and intend to increment or decrement an attribute value which\n does not yet exist, DynamoDB uses <code>0</code> as the initial\n value. For example, suppose that the item you want to update does\n not yet have an attribute named <i>itemcount</i>, but\n you decide to <code>ADD</code> the number <code>3</code> to this\n attribute anyway, even though it currently does not exist. DynamoDB\n will create the <i>itemcount</i> attribute, set its\n initial value to <code>0</code>, and finally add <code>3</code> to\n it. The result will be a new <i>itemcount</i>\n attribute in the item, with a value of <code>3</code>.</p>\n </note>\n </li>\n <li>\n <p>If the existing data type is a set, and if the <code>Value</code> is\n also a set, then the <code>Value</code> is added to the existing set.\n (This is a <i>set</i> operation, not mathematical\n addition.) For example, if the attribute value was the set\n <code>[1,2]</code>, and the <code>ADD</code> action specified\n <code>[3]</code>, then the final attribute value would be\n <code>[1,2,3]</code>. An error occurs if an Add action is specified\n for a set attribute and the attribute type specified does not match the\n existing set type. </p>\n <p>Both sets must have the same primitive data type. For example, if the\n existing data type is a set of strings, the <code>Value</code> must also\n be a set of strings. The same holds true for number sets and binary\n sets.</p>\n </li>\n </ul>\n <p>This action is only valid for an existing attribute whose data type is number\n or is a set. Do not use <code>ADD</code> for any other data types.</p>\n </li>\n </ul>\n <p>\n <b>If no item with the specified <i>Key</i> is\n found:</b>\n </p>\n <ul>\n <li>\n <p>\n <code>PUT</code> - DynamoDB creates a new item with the specified primary key,\n and then adds the attribute. </p>\n </li>\n <li>\n <p>\n <code>DELETE</code> - Nothing happens; there is no attribute to delete.</p>\n </li>\n <li>\n <p>\n <code>ADD</code> - DynamoDB creates a new item with the supplied primary key and\n number (or set) for the attribute value. The only data types allowed are number,\n number set, string set or binary set.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>For the <code>UpdateItem</code> operation, represents the attributes to be modified,\n the action to perform on each, and the new value for each.</p>\n <note>\n <p>You cannot use <code>UpdateItem</code> to update any primary key attributes.\n Instead, you will need to delete the item, and then use <code>PutItem</code> to\n create a new item with new attributes.</p>\n </note>\n <p>Attribute values cannot be null; string and binary type attributes must have lengths\n greater than zero; and set type attributes must not be empty. Requests with empty values\n will be rejected with a <code>ValidationException</code> exception.</p>"
}
},
"com.amazonaws.dynamodb#AutoScalingPolicyDescription": {
"type": "structure",
"members": {
"PolicyName": {
"target": "com.amazonaws.dynamodb#AutoScalingPolicyName",
"traits": {
"smithy.api#documentation": "<p>The name of the scaling policy.</p>"
}
},
"TargetTrackingScalingPolicyConfiguration": {
"target": "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription",
"traits": {
"smithy.api#documentation": "<p>Represents a target tracking scaling policy configuration.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the properties of the scaling policy.</p>"
}
},
"com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList": {
"type": "list",
"member": {
"target": "com.amazonaws.dynamodb#AutoScalingPolicyDescription"
}
},
"com.amazonaws.dynamodb#AutoScalingPolicyName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 256
},
"smithy.api#pattern": "^\\p{Print}+$"
}
},
"com.amazonaws.dynamodb#AutoScalingPolicyUpdate": {
"type": "structure",
"members": {
"PolicyName": {
"target": "com.amazonaws.dynamodb#AutoScalingPolicyName",
"traits": {
"smithy.api#documentation": "<p>The name of the scaling policy.</p>"
}
},
"TargetTrackingScalingPolicyConfiguration": {
"target": "com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate",
"traits": {
"smithy.api#documentation": "<p>Represents a target tracking scaling policy configuration.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the auto scaling policy to be modified.</p>"
}
},
"com.amazonaws.dynamodb#AutoScalingRoleArn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1600
},
"smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$"
}
},
"com.amazonaws.dynamodb#AutoScalingSettingsDescription": {
"type": "structure",
"members": {
"MinimumUnits": {
"target": "com.amazonaws.dynamodb#PositiveLongObject",
"traits": {
"smithy.api#documentation": "<p>The minimum capacity units that a global table or global secondary index should be\n scaled down to.</p>"
}
},
"MaximumUnits": {
"target": "com.amazonaws.dynamodb#PositiveLongObject",
"traits": {
"smithy.api#documentation": "<p>The maximum capacity units that a global table or global secondary index should be\n scaled up to.</p>"
}
},
"AutoScalingDisabled": {
"target": "com.amazonaws.dynamodb#BooleanObject",
"traits": {
"smithy.api#documentation": "<p>Disabled auto scaling for this global table or global secondary index.</p>"
}
},
"AutoScalingRoleArn": {
"target": "com.amazonaws.dynamodb#String",
"traits": {
"smithy.api#documentation": "<p>Role ARN used for configuring the auto scaling policy.</p>"
}
},
"ScalingPolicies": {
"target": "com.amazonaws.dynamodb#AutoScalingPolicyDescriptionList",
"traits": {
"smithy.api#documentation": "<p>Information about the scaling policies.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the auto scaling settings for a global table or global secondary\n index.</p>"
}
},
"com.amazonaws.dynamodb#AutoScalingSettingsUpdate": {
"type": "structure",
"members": {
"MinimumUnits": {
"target": "com.amazonaws.dynamodb#PositiveLongObject",
"traits": {
"smithy.api#documentation": "<p>The minimum capacity units that a global table or global secondary index should be\n scaled down to.</p>"
}
},
"MaximumUnits": {
"target": "com.amazonaws.dynamodb#PositiveLongObject",
"traits": {
"smithy.api#documentation": "<p>The maximum capacity units that a global table or global secondary index should be\n scaled up to.</p>"
}
},
"AutoScalingDisabled": {
"target": "com.amazonaws.dynamodb#BooleanObject",
"traits": {
"smithy.api#documentation": "<p>Disabled auto scaling for this global table or global secondary index.</p>"
}
},
"AutoScalingRoleArn": {
"target": "com.amazonaws.dynamodb#AutoScalingRoleArn",
"traits": {
"smithy.api#documentation": "<p>Role ARN used for configuring auto scaling policy.</p>"
}
},
"ScalingPolicyUpdate": {
"target": "com.amazonaws.dynamodb#AutoScalingPolicyUpdate",
"traits": {
"smithy.api#documentation": "<p>The scaling policy to apply for scaling target global table or global secondary index\n capacity units.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the auto scaling settings to be modified for a global table or global\n secondary index.</p>"
}
},
"com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationDescription": {
"type": "structure",
"members": {
"DisableScaleIn": {
"target": "com.amazonaws.dynamodb#BooleanObject",
"traits": {
"smithy.api#documentation": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.</p>"
}
},
"ScaleInCooldown": {
"target": "com.amazonaws.dynamodb#IntegerObject",
"traits": {
"smithy.api#documentation": "<p>The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately. </p>"
}
},
"ScaleOutCooldown": {
"target": "com.amazonaws.dynamodb#IntegerObject",
"traits": {
"smithy.api#documentation": "<p>The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.</p>"
}
},
"TargetValue": {
"target": "com.amazonaws.dynamodb#DoubleObject",
"traits": {
"smithy.api#documentation": "<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the properties of a target tracking scaling policy.</p>"
}
},
"com.amazonaws.dynamodb#AutoScalingTargetTrackingScalingPolicyConfigurationUpdate": {
"type": "structure",
"members": {
"DisableScaleIn": {
"target": "com.amazonaws.dynamodb#BooleanObject",
"traits": {
"smithy.api#documentation": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is\n true, scale in is disabled and the target tracking policy won't remove capacity from the\n scalable resource. Otherwise, scale in is enabled and the target tracking policy can\n remove capacity from the scalable resource. The default value is false.</p>"
}
},
"ScaleInCooldown": {
"target": "com.amazonaws.dynamodb#IntegerObject",
"traits": {
"smithy.api#documentation": "<p>The amount of time, in seconds, after a scale in activity completes before another\n scale in activity can start. The cooldown period is used to block subsequent scale in\n requests until it has expired. You should scale in conservatively to protect your\n application's availability. However, if another alarm triggers a scale out policy during\n the cooldown period after a scale-in, application auto scaling scales out your scalable\n target immediately. </p>"
}
},
"ScaleOutCooldown": {
"target": "com.amazonaws.dynamodb#IntegerObject",
"traits": {
"smithy.api#documentation": "<p>The amount of time, in seconds, after a scale out activity completes before another\n scale out activity can start. While the cooldown period is in effect, the capacity that\n has been added by the previous scale out event that initiated the cooldown is calculated\n as part of the desired capacity for the next scale out. You should continuously (but not\n excessively) scale out.</p>"
}
},
"TargetValue": {
"target": "com.amazonaws.dynamodb#DoubleObject",
"traits": {
"smithy.api#documentation": "<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10)\n or 2e-360 to 2e360 (Base 2).</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the settings of a target tracking scaling policy that will be\n modified.</p>"
}
},
"com.amazonaws.dynamodb#Backfilling": {
"type": "boolean"
},
"com.amazonaws.dynamodb#BackupArn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 37,
"max": 1024
}
}
},
"com.amazonaws.dynamodb#BackupCreationDateTime": {
"type": "timestamp"
},
"com.amazonaws.dynamodb#BackupDescription": {
"type": "structure",
"members": {
"BackupDetails": {
"target": "com.amazonaws.dynamodb#BackupDetails",
"traits": {
"smithy.api#documentation": "<p>Contains the details of the backup created for the table. </p>"
}
},
"SourceTableDetails": {
"target": "com.amazonaws.dynamodb#SourceTableDetails",
"traits": {
"smithy.api#documentation": "<p>Contains the details of the table when the backup was created. </p>"
}
},
"SourceTableFeatureDetails": {
"target": "com.amazonaws.dynamodb#SourceTableFeatureDetails",
"traits": {
"smithy.api#documentation": "<p>Contains the details of the features enabled on the table when the backup was created.\n For example, LSIs, GSIs, streams, TTL.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the description of the backup created for the table.</p>"
}
},
"com.amazonaws.dynamodb#BackupDetails": {
"type": "structure",
"members": {
"BackupArn": {
"target": "com.amazonaws.dynamodb#BackupArn",
"traits": {
"smithy.api#documentation": "<p>ARN associated with the backup.</p>",
"smithy.api#required": {}
}
},
"BackupName": {
"target": "com.amazonaws.dynamodb#BackupName",
"traits": {
"smithy.api#documentation": "<p>Name of the requested backup.</p>",
"smithy.api#required": {}
}
},
"BackupSizeBytes": {
"target": "com.amazonaws.dynamodb#BackupSizeBytes",
"traits": {
"smithy.api#documentation": "<p>Size of the backup in bytes. DynamoDB updates this value approximately every six\n hours. Recent changes might not be reflected in this value.</p>"
}
},
"BackupStatus": {
"target": "com.amazonaws.dynamodb#BackupStatus",
"traits": {
"smithy.api#documentation": "<p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED. </p>",
"smithy.api#required": {}
}
},
"BackupType": {
"target": "com.amazonaws.dynamodb#BackupType",
"traits": {
"smithy.api#documentation": "<p>BackupType:</p>\n <ul>\n <li>\n <p>\n <code>USER</code> - You create and manage these using the on-demand backup\n feature.</p>\n </li>\n <li>\n <p>\n <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled,\n a <code>SYSTEM</code> backup is automatically created and is retained for 35\n days (at no additional cost). System backups allow you to restore the deleted\n table to the state it was in just before the point of deletion. </p>\n </li>\n <li>\n <p>\n <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service.</p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"BackupCreationDateTime": {
"target": "com.amazonaws.dynamodb#BackupCreationDateTime",
"traits": {
"smithy.api#documentation": "<p>Time at which the backup was created. This is the request time of the backup. </p>",
"smithy.api#required": {}
}
},
"BackupExpiryDateTime": {
"target": "com.amazonaws.dynamodb#Date",
"traits": {
"smithy.api#documentation": "<p>Time at which the automatic on-demand backup created by DynamoDB will\n expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after\n its creation.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains the details of the backup created for the table.</p>"
}
},
"com.amazonaws.dynamodb#BackupInUseException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.dynamodb#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>There is another ongoing conflicting backup control plane operation on the table.\n The backup is either being created, deleted or restored to a table.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.dynamodb#BackupName": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 3,
"max": 255
},
"smithy.api#pattern": "^[a-zA-Z0-9_.-]+$"
}
},
"com.amazonaws.dynamodb#BackupNotFoundException": {
"type": "structure",
"members": {
"message": {
"target": "com.amazonaws.dynamodb#ErrorMessage"
}
},
"traits": {
"smithy.api#documentation": "<p>Backup not found for the given BackupARN. </p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.dynamodb#BackupSizeBytes": {
"type": "long",
"traits": {
"smithy.api#range": {
"min": 0
}
}
},
"com.amazonaws.dynamodb#BackupStatus": {
"type": "enum",
"members": {
"CREATING": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CREATING"
}
},
"DELETED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "DELETED"
}
},
"AVAILABLE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AVAILABLE"
}
}
}
},
"com.amazonaws.dynamodb#BackupSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.dynamodb#BackupSummary"
}
},
"com.amazonaws.dynamodb#BackupSummary": {
"type": "structure",
"members": {
"TableName": {
"target": "com.amazonaws.dynamodb#TableName",
"traits": {
"smithy.api#documentation": "<p>Name of the table.</p>"
}
},
"TableId": {
"target": "com.amazonaws.dynamodb#TableId",
"traits": {
"smithy.api#documentation": "<p>Unique identifier for the table.</p>"
}
},
"TableArn": {
"target": "com.amazonaws.dynamodb#TableArn",
"traits": {
"smithy.api#documentation": "<p>ARN associated with the table.</p>"
}
},
"BackupArn": {
"target": "com.amazonaws.dynamodb#BackupArn",
"traits": {
"smithy.api#documentation": "<p>ARN associated with the backup.</p>"
}
},
"BackupName": {
"target": "com.amazonaws.dynamodb#BackupName",
"traits": {
"smithy.api#documentation": "<p>Name of the specified backup.</p>"
}
},
"BackupCreationDateTime": {
"target": "com.amazonaws.dynamodb#BackupCreationDateTime",
"traits": {
"smithy.api#documentation": "<p>Time at which the backup was created.</p>"
}
},
"BackupExpiryDateTime": {
"target": "com.amazonaws.dynamodb#Date",
"traits": {
"smithy.api#documentation": "<p>Time at which the automatic on-demand backup created by DynamoDB will\n expire. This <code>SYSTEM</code> on-demand backup expires automatically 35 days after\n its creation.</p>"
}
},
"BackupStatus": {
"target": "com.amazonaws.dynamodb#BackupStatus",
"traits": {
"smithy.api#documentation": "<p>Backup can be in one of the following states: CREATING, ACTIVE, DELETED.</p>"
}
},
"BackupType": {
"target": "com.amazonaws.dynamodb#BackupType",
"traits": {
"smithy.api#documentation": "<p>BackupType:</p>\n <ul>\n <li>\n <p>\n <code>USER</code> - You create and manage these using the on-demand backup\n feature.</p>\n </li>\n <li>\n <p>\n <code>SYSTEM</code> - If you delete a table with point-in-time recovery enabled,\n a <code>SYSTEM</code> backup is automatically created and is retained for 35\n days (at no additional cost). System backups allow you to restore the deleted\n table to the state it was in just before the point of deletion. </p>\n </li>\n <li>\n <p>\n <code>AWS_BACKUP</code> - On-demand backup created by you from Backup service.</p>\n </li>\n </ul>"
}
},
"BackupSizeBytes": {
"target": "com.amazonaws.dynamodb#BackupSizeBytes",
"traits": {
"smithy.api#documentation": "<p>Size of the backup in bytes.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains details for the backup.</p>"
}
},
"com.amazonaws.dynamodb#BackupType": {
"type": "enum",
"members": {
"USER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "USER"
}
},
"SYSTEM": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SYSTEM"
}
},
"AWS_BACKUP": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AWS_BACKUP"
}
}
}
},
"com.amazonaws.dynamodb#BackupTypeFilter": {
"type": "enum",
"members": {
"USER": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "USER"
}
},
"SYSTEM": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "SYSTEM"
}
},
"AWS_BACKUP": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "AWS_BACKUP"
}
},
"ALL": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ALL"
}
}
}
},
"com.amazonaws.dynamodb#BackupsInputLimit": {
"type": "integer",
"traits": {
"smithy.api#range": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.dynamodb#BatchExecuteStatement": {
"type": "operation",
"input": {
"target": "com.amazonaws.dynamodb#BatchExecuteStatementInput"
},
"output": {
"target": "com.amazonaws.dynamodb#BatchExecuteStatementOutput"
},
"errors": [
{
"target": "com.amazonaws.dynamodb#InternalServerError"
},
{
"target": "com.amazonaws.dynamodb#RequestLimitExceeded"
}
],
"traits": {
"smithy.api#documentation": "<p>This operation allows you to perform batch reads or writes on data stored in DynamoDB,\n using PartiQL. Each read statement in a <code>BatchExecuteStatement</code> must specify\n an equality condition on all key attributes. This enforces that each <code>SELECT</code>\n statement in a batch returns at most a single item. For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ql-reference.multiplestatements.batching.html\">Running batch operations with PartiQL for DynamoDB\n </a>.</p>\n <note>\n <p>The entire batch must consist of either read statements or write statements, you\n cannot mix both in one batch.</p>\n </note>\n <important>\n <p>A HTTP 200 response does not mean that all statements in the BatchExecuteStatement\n succeeded. Error details for individual statements can be found under the <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BatchStatementResponse.html#DDB-Type-BatchStatementResponse-Error\">Error</a> field of the <code>BatchStatementResponse</code> for each\n statement.</p>\n </important>"
}
},
"com.amazonaws.dynamodb#BatchExecuteStatementInput": {
"type": "structure",
"members": {
"Statements": {
"target": "com.amazonaws.dynamodb#PartiQLBatchRequest",
"traits": {
"smithy.api#documentation": "<p>The list of PartiQL statements representing the batch to run.</p>",
"smithy.api#required": {}
}
},
"ReturnConsumedCapacity": {
"target": "com.amazonaws.dynamodb#ReturnConsumedCapacity"
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.dynamodb#BatchExecuteStatementOutput": {
"type": "structure",
"members": {
"Responses": {
"target": "com.amazonaws.dynamodb#PartiQLBatchResponse",
"traits": {
"smithy.api#documentation": "<p>The response to each PartiQL statement in the batch. The values of the list are\n ordered according to the ordering of the request statements.</p>"
}
},
"ConsumedCapacity": {
"target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple",
"traits": {
"smithy.api#documentation": "<p>The capacity units consumed by the entire operation. The values of the list are\n ordered according to the ordering of the statements.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.dynamodb#BatchGetItem": {
"type": "operation",
"input": {
"target": "com.amazonaws.dynamodb#BatchGetItemInput"
},
"output": {
"target": "com.amazonaws.dynamodb#BatchGetItemOutput"
},
"errors": [
{
"target": "com.amazonaws.dynamodb#InternalServerError"
},
{
"target": "com.amazonaws.dynamodb#InvalidEndpointException"
},
{
"target": "com.amazonaws.dynamodb#ProvisionedThroughputExceededException"
},
{
"target": "com.amazonaws.dynamodb#RequestLimitExceeded"
},
{
"target": "com.amazonaws.dynamodb#ResourceNotFoundException"
}
],
"traits": {
"aws.api#clientDiscoveredEndpoint": {
"required": false
},
"smithy.api#documentation": "<p>The <code>BatchGetItem</code> operation returns the attributes of one or more items\n from one or more tables. You identify requested items by primary key.</p>\n <p>A single operation can retrieve up to 16 MB of data, which can contain as many as 100\n items. <code>BatchGetItem</code> returns a partial result if the response size limit is\n exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is\n requested, or an internal processing failure occurs. If a partial result is returned,\n the operation returns a value for <code>UnprocessedKeys</code>. You can use this value\n to retry the operation starting with the next item to get.</p>\n <important>\n <p>If you request more than 100 items, <code>BatchGetItem</code> returns a\n <code>ValidationException</code> with the message \"Too many items requested for\n the BatchGetItem call.\"</p>\n </important>\n <p>For example, if you ask to retrieve 100 items, but each individual item is 300 KB in\n size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns\n an appropriate <code>UnprocessedKeys</code> value so you can get the next page of\n results. If desired, your application can include its own logic to assemble the pages of\n results into one dataset.</p>\n <p>If <i>none</i> of the items can be processed due to insufficient\n provisioned throughput on all of the tables in the request, then\n <code>BatchGetItem</code> returns a\n <code>ProvisionedThroughputExceededException</code>. If <i>at least\n one</i> of the items is successfully processed, then\n <code>BatchGetItem</code> completes successfully, while returning the keys of the\n unread items in <code>UnprocessedKeys</code>.</p>\n <important>\n <p>If DynamoDB returns any unprocessed items, you should retry the batch operation on\n those items. However, <i>we strongly recommend that you use an exponential\n backoff algorithm</i>. If you retry the batch operation immediately, the\n underlying read or write requests can still fail due to throttling on the individual\n tables. If you delay the batch operation using exponential backoff, the individual\n requests in the batch are much more likely to succeed.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ErrorHandling.html#BatchOperations\">Batch Operations and Error Handling</a> in the <i>Amazon DynamoDB\n Developer Guide</i>.</p>\n </important>\n <p>By default, <code>BatchGetItem</code> performs eventually consistent reads on every\n table in the request. If you want strongly consistent reads instead, you can set\n <code>ConsistentRead</code> to <code>true</code> for any or all tables.</p>\n <p>In order to minimize response latency, <code>BatchGetItem</code> may retrieve items in\n parallel.</p>\n <p>When designing your application, keep in mind that DynamoDB does not return items in\n any particular order. To help parse the response by item, include the primary key values\n for the items in your request in the <code>ProjectionExpression</code> parameter.</p>\n <p>If a requested item does not exist, it is not returned in the result. Requests for\n nonexistent items consume the minimum read capacity units according to the type of read.\n For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.html#CapacityUnitCalculations\">Working with Tables</a> in the <i>Amazon DynamoDB Developer\n Guide</i>.</p>",
"smithy.api#examples": [
{
"title": "To retrieve multiple items from a table",
"documentation": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.",
"input": {
"RequestItems": {
"Music": {
"Keys": [
{
"Artist": {
"S": "No One You Know"
},
"SongTitle": {
"S": "Call Me Today"
}
},
{
"Artist": {
"S": "Acme Band"
},
"SongTitle": {
"S": "Happy Day"
}
},
{
"Artist": {
"S": "No One You Know"
},
"SongTitle": {
"S": "Scared of My Shadow"
}
}
],
"ProjectionExpression": "AlbumTitle"
}
}
},
"output": {
"Responses": {
"Music": [
{
"AlbumTitle": {
"S": "Somewhat Famous"
}
},
{
"AlbumTitle": {
"S": "Blue Sky Blues"
}
},
{
"AlbumTitle": {
"S": "Louder Than Ever"
}
}
]
}
}
}
]
}
},
"com.amazonaws.dynamodb#BatchGetItemInput": {
"type": "structure",
"members": {
"RequestItems": {
"target": "com.amazonaws.dynamodb#BatchGetRequestMap",
"traits": {
"smithy.api#documentation": "<p>A map of one or more table names or table ARNs and, for each table, a map that\n describes one or more items to retrieve from that table. Each table name or ARN can be\n used only once per <code>BatchGetItem</code> request.</p>\n <p>Each element in the map of items to retrieve consists of the following:</p>\n <ul>\n <li>\n <p>\n <code>ConsistentRead</code> - If <code>true</code>, a strongly consistent read\n is used; if <code>false</code> (the default), an eventually consistent read is\n used.</p>\n </li>\n <li>\n <p>\n <code>ExpressionAttributeNames</code> - One or more substitution tokens for\n attribute names in the <code>ProjectionExpression</code> parameter. The\n following are some use cases for using\n <code>ExpressionAttributeNames</code>:</p>\n <ul>\n <li>\n <p>To access an attribute whose name conflicts with a DynamoDB reserved\n word.</p>\n </li>\n <li>\n <p>To create a placeholder for repeating occurrences of an attribute name\n in an expression.</p>\n </li>\n <li>\n <p>To prevent special characters in an attribute name from being\n misinterpreted in an expression.</p>\n </li>\n </ul>\n <p>Use the <b>#</b> character in an expression to\n dereference an attribute name. For example, consider the following attribute\n name:</p>\n <ul>\n <li>\n <p>\n <code>Percentile</code>\n </p>\n </li>\n </ul>\n <p>The name of this attribute conflicts with a reserved word, so it cannot be\n used directly in an expression. (For the complete list of reserved words, see\n <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html\">Reserved\n Words</a> in the <i>Amazon DynamoDB Developer Guide</i>).\n To work around this, you could specify the following for\n <code>ExpressionAttributeNames</code>:</p>\n <ul>\n <li>\n <p>\n <code>{\"#P\":\"Percentile\"}</code>\n </p>\n </li>\n </ul>\n <p>You could then use this substitution in an expression, as in this\n example:</p>\n <ul>\n <li>\n <p>\n <code>#P = :val</code>\n </p>\n </li>\n </ul>\n <note>\n <p>Tokens that begin with the <b>:</b> character\n are <i>expression attribute values</i>, which are placeholders\n for the actual value at runtime.</p>\n </note>\n <p>For more information about expression attribute names, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html\">Accessing Item Attributes</a> in the <i>Amazon DynamoDB\n Developer Guide</i>.</p>\n </li>\n <li>\n <p>\n <code>Keys</code> - An array of primary key attribute values that define\n specific items in the table. For each primary key, you must provide\n <i>all</i> of the key attributes. For example, with a simple\n primary key, you only need to provide the partition key value. For a composite\n key, you must provide <i>both</i> the partition key value and the\n sort key value.</p>\n </li>\n <li>\n <p>\n <code>ProjectionExpression</code> - A string that identifies one or more\n attributes to retrieve from the table. These attributes can include scalars,\n sets, or elements of a JSON document. The attributes in the expression must be\n separated by commas.</p>\n <p>If no attribute names are specified, then all attributes are returned. If any\n of the requested attributes are not found, they do not appear in the\n result.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.AccessingItemAttributes.html\">Accessing Item Attributes</a> in the <i>Amazon DynamoDB\n Developer Guide</i>.</p>\n </li>\n <li>\n <p>\n <code>AttributesToGet</code> - This is a legacy parameter. Use\n <code>ProjectionExpression</code> instead. For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/LegacyConditionalParameters.AttributesToGet.html\">AttributesToGet</a> in the <i>Amazon DynamoDB Developer\n Guide</i>. </p>\n </li>\n </ul>",
"smithy.api#required": {}
}
},
"ReturnConsumedCapacity": {
"target": "com.amazonaws.dynamodb#ReturnConsumedCapacity"
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the input of a <code>BatchGetItem</code> operation.</p>",
"smithy.api#input": {}
}
},
"com.amazonaws.dynamodb#BatchGetItemOutput": {
"type": "structure",
"members": {
"Responses": {
"target": "com.amazonaws.dynamodb#BatchGetResponseMap",
"traits": {
"smithy.api#documentation": "<p>A map of table name or table ARN to a list of items. Each object in\n <code>Responses</code> consists of a table name or ARN, along with a map of\n attribute data consisting of the data type and attribute value.</p>"
}
},
"UnprocessedKeys": {
"target": "com.amazonaws.dynamodb#BatchGetRequestMap",
"traits": {
"smithy.api#documentation": "<p>A map of tables and their respective keys that were not processed with the current\n response. The <code>UnprocessedKeys</code> value is in the same form as\n <code>RequestItems</code>, so the value can be provided directly to a subsequent\n <code>BatchGetItem</code> operation. For more information, see\n <code>RequestItems</code> in the Request Parameters section.</p>\n <p>Each element consists of:</p>\n <ul>\n <li>\n <p>\n <code>Keys</code> - An array of primary key attribute values that define\n specific items in the table.</p>\n </li>\n <li>\n <p>\n <code>ProjectionExpression</code> - One or more attributes to be retrieved from\n the table or index. By default, all attributes are returned. If a requested\n attribute is not found, it does not appear in the result.</p>\n </li>\n <li>\n <p>\n <code>ConsistentRead</code> - The consistency of a read operation. If set to\n <code>true</code>, then a strongly consistent read is used; otherwise, an\n eventually consistent read is used.</p>\n </li>\n </ul>\n <p>If there are no unprocessed keys remaining, the response contains an empty\n <code>UnprocessedKeys</code> map.</p>"
}
},
"ConsumedCapacity": {
"target": "com.amazonaws.dynamodb#ConsumedCapacityMultiple",
"traits": {
"smithy.api#documentation": "<p>The read capacity units consumed by the entire <code>BatchGetItem</code>\n operation.</p>\n <p>Each element consists of:</p>\n <ul>\n <li>\n <p>\n <code>TableName</code> - The table that consumed the provisioned\n throughput.</p>\n </li>\n <li>\n <p>\n <code>CapacityUnits</code> - The total number of capacity units consumed.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Represents the output of a <code>BatchGetItem</code> operation.</p>",
"smithy.api#output": {}
}
},
"com.amazonaws.dynamodb#BatchGetRequestMap": {
"type": "map",
"key": {
"target": "com.amazonaws.dynamodb#TableArn"
},
"value": {
"target": "com.amazonaws.dynamodb#KeysAndAttributes"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.dynamodb#BatchGetResponseMap": {
"type": "map",
"key": {
"target": "com.amazonaws.dynamodb#TableArn"
},
"value": {
"target": "com.amazonaws.dynamodb#ItemList"
}
},
"com.amazonaws.dynamodb#BatchStatementError": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.dynamodb#BatchStatementErrorCodeEnum",
"traits": {
"smithy.api#documentation": "<p> The error code associated with the failed PartiQL batch statement. </p>"