/
AWS_DynamoDB.yml
6246 lines (6246 loc) · 433 KB
/
AWS_DynamoDB.yml
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
category: IT Services
commonfields:
id: Amazon DynamoDB
version: -1
configuration:
- display: Role Arn
name: roleArn
required: false
type: 0
- display: Role Session Name
name: roleSessionName
required: false
type: 0
- display: AWS Default Region
name: defaultRegion
options:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- ca-central-1
- eu-west-1
- eu-central-1
- eu-west-2
- ap-northeast-1
- ap-northeast-2
- ap-southeast-1
- ap-southeast-2
- ap-south-1
- sa-east-1
- eu-north-1
- eu-west-3
- us-gov-east-1
- us-gov-west-1
required: false
type: 15
- display: Role Session Duration
name: sessionDuration
required: false
type: 0
- display: Access Key
name: credentials
required: false
type: 9
displaypassword: Secret Key
- display: Access Key
name: access_key
required: false
type: 0
hidden: true
- display: Secret Key
name: secret_key
required: false
type: 4
hidden: true
- display: Trust any certificate (not secure)
name: insecure
required: false
type: 8
- display: Use system proxy settings
name: proxy
required: false
type: 8
description: 'Amazon DynamoDB Amazon DynamoDB is a fully managed NoSQL database service
that provides fast and predictable performance with seamless scalability. DynamoDB
lets you offload the administrative burdens of operating and scaling a distributed
database, so that you don''t have to worry about hardware provisioning, setup and
configuration, replication, software patching, or cluster scaling. With DynamoDB,
you can create database tables that can store and retrieve any amount of data, and
serve any level of request traffic. You can scale up or scale down your tables''
throughput capacity without downtime or performance degradation, and use the AWS
Management Console to monitor resource utilization and performance metrics. DynamoDB
automatically spreads the data and traffic for your tables over a sufficient number
of servers to handle your throughput and storage requirements, while maintaining
consistent and fast performance. All of your data is stored on solid state disks
(SSDs) and automatically replicated across multiple Availability Zones in an AWS
region, providing built-in high availability and data durability. '
display: Amazon DynamoDB
name: Amazon DynamoDB
script:
commands:
- arguments:
- description: The AWS Region, if not specified the default region will be used.
name: region
- description: The Amazon Resource Name (ARN) of the role to assume.
name: roleArn
- description: An identifier for the assumed role session.
name: roleSessionName
- description: 'The duration, in seconds, of the role session. The value can range
from 900 seconds (15 minutes) up to the maximum session duration setting for
the role. '
name: roleSessionDuration
- description: Override arguments and send a formatted JSON file.
name: raw_json
- description: "A map of one or more table names and, for each table, a map that\
\ describes one or more items to retrieve from that table. Each table name\
\ can be used only once per BatchGetItem request. Each element in the map\
\ of items to retrieve consists of the following: * ConsistentRead - If\
\ true, a strongly consistent read is used; if false (the default), an eventually\
\ consistent read is used. \n * ExpressionAttributeNames - One or more substitution\
\ tokens for attribute names in the ProjectionExpression parameter. The following\
\ are some use cases for using ExpressionAttributeNames: \n\t + To access\
\ an attribute whose name conflicts with a DynamoDB reserved word. \n\t +\
\ To create a placeholder for repeating occurrences of an attribute name\
\ in an expression. \n\t + To prevent special characters in an attribute\
\ name from being misinterpreted in an expression. \n\t Use the **#** character\
\ in an expression to dereference an attribute name. For example, consider\
\ the following attribute name: \n\t + Percentile \n\t The name of this\
\ attribute conflicts with a reserved word, so it cannot be used directly\
\ in an expression. (For the complete list of reserved words, see Reserved\
\ Words in the *Amazon DynamoDB Developer Guide*). To work around this, you\
\ could specify the following for ExpressionAttributeNames: \n\t + {\"#P\"\
:\"Percentile\"} \n\t You could then use this substitution in an expression,\
\ as in this example: \n\t + #P = :val \n\t Tokens that begin with the\
\ **:** character are *expression attribute values*, which are placeholders\
\ for the actual value at runtime. For more information about expression\
\ attribute names, see Accessing Item Attributes in the *Amazon DynamoDB Developer\
\ Guide*. \n * Keys - An array of primary key attribute values that define\
\ specific items in the table. For each primary key, you must provide *all*\
\ of the key attributes. For example, with a simple primary key, you only\
\ need to provide the partition key value. For a composite key, you must provide\
\ *both* the partition key value and the sort key value. \n * ProjectionExpression\
\ - A string that identifies one or more attributes to retrieve from the table.\
\ These attributes can include scalars, sets, or elements of a JSON document.\
\ The attributes in the expression must be separated by commas. If no attribute\
\ names are specified, then all attributes are returned. If any of the requested\
\ attributes are not found, they do not appear in the result. For more information,\
\ see Accessing Item Attributes in the *Amazon DynamoDB Developer Guide*.\
\ \n * AttributesToGet - This is a legacy parameter. Use ProjectionExpression\
\ instead. For more information, see AttributesToGet in the *Amazon DynamoDB\
\ Developer Guide*. \n "
name: request_items
- auto: PREDEFINED
description: 'A value of TOTAL causes consumed capacity information to be returned,
and a value of NONE prevents that information from being returned. No other
value is valid.'
name: return_consumed_capacity
predefined:
- INDEXES
- TOTAL
- NONE
description: The BatchGetItem operation returns the attributes of one or more
items from one or more tables. You identify requested items by primary key.
A single operation can retrieve up to 16 MB of data, which can contain as many
as 100 items. BatchGetItem returns a partial result if the response size limit
is exceeded, the table's provisioned throughput is exceeded, or an internal
processing failure occurs. If a partial result is returned, the operation returns
a value for UnprocessedKeys. You can use this value to retry the operation starting
with the next item to get. If you request more than 100 items, BatchGetItem
returns a ValidationException with the message "Too many items requested for
the BatchGetItem call." For example, if you ask to retrieve 100 items, but
each individual item is 300 KB in size, the system returns 52 items (so as not
to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value
so you can get the next page of results. If desired, your application can include
its own logic to assemble the pages of results into one dataset. If *none* of
the items can be processed due to insufficient provisioned throughput on all
of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException.
If *at least one* of the items is successfully processed, then BatchGetItem
completes successfully, while returning the keys of the unread items in UnprocessedKeys. If
DynamoDB returns any unprocessed items, you should retry the batch operation
on those items. However, *we strongly recommend that you use an exponential
backoff algorithm*. If you retry the batch operation immediately, the underlying
read or write requests can still fail due to throttling on the individual tables.
If you delay the batch operation using exponential backoff, the individual requests
in the batch are much more likely to succeed. For more information, see Batch
Operations and Error Handling in the *Amazon DynamoDB Developer Guide*. By
default, BatchGetItem performs eventually consistent reads on every table in
the request. If you want strongly consistent reads instead, you can set ConsistentRead
to true for any or all tables. In order to minimize response latency, BatchGetItem
retrieves items in parallel. When designing your application, keep in mind that
DynamoDB does not return items in any particular order. To help parse the response
by item, include the primary key values for the items in your request in the
ProjectionExpression parameter. If a requested item does not exist, it is not
returned in the result. Requests for nonexistent items consume the minimum read
capacity units according to the type of read. For more information, see Working
with Tables in the *Amazon DynamoDB Developer Guide*.
name: aws-dynamodb-batch-get-item
outputs:
- contextPath: AWS-DynamoDB.Responses
description: A map of table name to a list of items. Each object in Responses
consists of a table name, along with a map of attribute data consisting of
the data type and attribute value.
- contextPath: AWS-DynamoDB.UnprocessedKeys
description: "A map of tables and their respective keys that were not processed\
\ with the current response. The UnprocessedKeys value is in the same form\
\ as RequestItems, so the value can be provided directly to a subsequent BatchGetItem\
\ operation. For more information, see RequestItems in the Request Parameters\
\ section. Each element consists of: * Keys - An array of primary key attribute\
\ values that define specific items in the table. \n * ProjectionExpression\
\ - One or more attributes to be retrieved from the table or index. By default,\
\ all attributes are returned. If a requested attribute is not found, it does\
\ not appear in the result. \n * ConsistentRead - The consistency of a read\
\ operation. If set to true, then a strongly consistent read is used; otherwise,\
\ an eventually consistent read is used. \n If there are no unprocessed keys\
\ remaining, the response contains an empty UnprocessedKeys map."
- contextPath: AWS-DynamoDB.TableName
description: The name of the table that was affected by the operation.
- contextPath: AWS-DynamoDB.CapacityUnits
description: The total number of capacity units consumed by the operation.
- contextPath: AWS-DynamoDB.ReadCapacityUnits
description: The total number of read capacity units consumed by the operation.
- contextPath: AWS-DynamoDB.WriteCapacityUnits
description: The total number of write capacity units consumed by the operation.
- contextPath: AWS-DynamoDB.Table.ReadCapacityUnits
description: The total number of read capacity units consumed on a table or
an index.
- contextPath: AWS-DynamoDB.Table.WriteCapacityUnits
description: The total number of write capacity units consumed on a table or
an index.
- contextPath: AWS-DynamoDB.Table.CapacityUnits
description: The total number of capacity units consumed on a table or an index.
- contextPath: AWS-DynamoDB.Table
description: The amount of throughput consumed on the table affected by the
operation.
- contextPath: AWS-DynamoDB.LocalSecondaryIndexes
description: The amount of throughput consumed on each local index affected
by the operation.
- contextPath: AWS-DynamoDB.GlobalSecondaryIndexes
description: The amount of throughput consumed on each global index affected
by the operation.
- contextPath: AWS-DynamoDB.docs
description: "The read capacity units consumed by the entire BatchGetItem operation.\
\ Each element consists of: * TableName - The table that consumed the provisioned\
\ throughput. \n * CapacityUnits - The total number of capacity units consumed.\
\ \n "
- arguments:
- description: The AWS Region, if not specified the default region will be used.
name: region
- description: The Amazon Resource Name (ARN) of the role to assume.
name: roleArn
- description: An identifier for the assumed role session.
name: roleSessionName
- description: 'The duration, in seconds, of the role session. The value can range
from 900 seconds (15 minutes) up to the maximum session duration setting for
the role. '
name: roleSessionDuration
- description: Override arguments and send a formatted JSON file.
name: raw_json
- description: "A map of one or more table names and, for each table, a list of\
\ operations to be performed (DeleteRequest or PutRequest). Each element in\
\ the map consists of the following: * DeleteRequest - Perform a DeleteItem\
\ operation on the specified item. The item to be deleted is identified by\
\ a Key subelement: \n\t + Key - A map of primary key attribute values that\
\ uniquely identify the item. Each entry in this map consists of an attribute\
\ name and an attribute value. For each primary key, you must provide *all*\
\ of the key attributes. For example, with a simple primary key, you only\
\ need to provide a value for the partition key. For a composite primary key,\
\ you must provide values for *both* the partition key and the sort key. \n\
\t \n * PutRequest - Perform a PutItem operation on the specified item.\
\ The item to be put is identified by an Item subelement: \n\t + Item -\
\ A map of attributes and their values. Each entry in this map consists of\
\ an attribute name and an attribute value. Attribute values must not be null;\
\ string and binary type attributes must have lengths greater than zero; and\
\ set type attributes must not be empty. Requests that contain empty values\
\ are rejected with a ValidationException exception. If you specify any attributes\
\ that are part of an index key, then the data types for those attributes\
\ must match those of the schema in the table's attribute definition. \n\t\
\ \n "
name: request_items
- auto: PREDEFINED
description: 'A value of TOTAL causes consumed capacity information to be returned,
and a value of NONE prevents that information from being returned. No other
value is valid.'
name: return_consumed_capacity
predefined:
- INDEXES
- TOTAL
- NONE
- auto: PREDEFINED
description: Determines whether item collection metrics are returned. If set
to SIZE, the response includes statistics about item collections, if any,
that were modified during the operation are returned in the response. If set
to NONE (the default), no statistics are returned.
name: return_item_collection_metrics
predefined:
- SIZE
- NONE
description: "The BatchWriteItem operation puts or deletes multiple items in one\
\ or more tables. A single call to BatchWriteItem can write up to 16 MB of data,\
\ which can comprise as many as 25 put or delete requests. Individual items\
\ to be written can be as large as 400 KB. BatchWriteItem cannot update items.\
\ To update items, use the UpdateItem action. The individual PutItem and DeleteItem\
\ operations specified in BatchWriteItem are atomic; however BatchWriteItem\
\ as a whole is not. If any requested operations fail because the table's provisioned\
\ throughput is exceeded or an internal processing failure occurs, the failed\
\ operations are returned in the UnprocessedItems response parameter. You can\
\ investigate and optionally resend the requests. Typically, you would call\
\ BatchWriteItem in a loop. Each iteration would check for unprocessed items\
\ and submit a new BatchWriteItem request with those unprocessed items until\
\ all items have been processed. If *none* of the items can be processed due\
\ to insufficient provisioned throughput on all of the tables in the request,\
\ then BatchWriteItem returns a ProvisionedThroughputExceededException. If\
\ DynamoDB returns any unprocessed items, you should retry the batch operation\
\ on those items. However, *we strongly recommend that you use an exponential\
\ backoff algorithm*. If you retry the batch operation immediately, the underlying\
\ read or write requests can still fail due to throttling on the individual\
\ tables. If you delay the batch operation using exponential backoff, the individual\
\ requests in the batch are much more likely to succeed. For more information,\
\ see Batch Operations and Error Handling in the *Amazon DynamoDB Developer\
\ Guide*. With BatchWriteItem, you can efficiently write or delete large amounts\
\ of data, such as from Amazon EMR, or copy data from another database into\
\ DynamoDB. In order to improve performance with these large-scale operations,\
\ BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem\
\ calls would. For example, you cannot specify conditions on individual put\
\ and delete requests, and BatchWriteItem does not return deleted items in the\
\ response. If you use a programming language that supports concurrency, you\
\ can use threads to write items in parallel. Your application must include\
\ the necessary logic to manage the threads. With languages that don't support\
\ threading, you must update or delete the specified items one at a time. In\
\ both situations, BatchWriteItem performs the specified put and delete operations\
\ in parallel, giving you the power of the thread pool approach without having\
\ to introduce complexity into your application. Parallel processing reduces\
\ latency, but each specified put and delete request consumes the same number\
\ of write capacity units whether it is processed in parallel or not. Delete\
\ operations on nonexistent items consume one write capacity unit. If one or\
\ more of the following is true, DynamoDB rejects the entire batch write operation:\
\ * One or more tables specified in the BatchWriteItem request does not exist.\
\ \n * Primary key attributes specified on an item in the request do not match\
\ those in the corresponding table's primary key schema. \n * You try to perform\
\ multiple operations on the same item in the same BatchWriteItem request. For\
\ example, you cannot put and delete the same item in the same BatchWriteItem\
\ request. \n * Your request contains at least two items with identical hash\
\ and range keys (which essentially is two put operations). \n * There are\
\ more than 25 requests in the batch. \n * Any individual item in a batch exceeds\
\ 400 KB. \n * The total request size exceeds 16 MB. \n "
name: aws-dynamodb-batch-write-item
outputs:
- contextPath: AWS-DynamoDB.UnprocessedItems
description: "A map of tables and requests against those tables that were not\
\ processed. The UnprocessedItems value is in the same form as RequestItems,\
\ so you can provide this value directly to a subsequent BatchGetItem operation.\
\ For more information, see RequestItems in the Request Parameters section.\
\ Each UnprocessedItems entry consists of a table name and, for that table,\
\ a list of operations to perform (DeleteRequest or PutRequest). * DeleteRequest\
\ - Perform a DeleteItem operation on the specified item. The item to be deleted\
\ is identified by a Key subelement: \n\t + Key - A map of primary key attribute\
\ values that uniquely identify the item. Each entry in this map consists\
\ of an attribute name and an attribute value. \n\t \n * PutRequest - Perform\
\ a PutItem operation on the specified item. The item to be put is identified\
\ by an Item subelement: \n\t + Item - A map of attributes and their values.\
\ Each entry in this map consists of an attribute name and an attribute value.\
\ Attribute values must not be null; string and binary type attributes must\
\ have lengths greater than zero; and set type attributes must not be empty.\
\ Requests that contain empty values will be rejected with a ValidationException\
\ exception. If you specify any attributes that are part of an index key,\
\ then the data types for those attributes must match those of the schema\
\ in the table's attribute definition. \n\t \n If there are no unprocessed\
\ items remaining, the response contains an empty UnprocessedItems map."
- contextPath: AWS-DynamoDB.ItemCollectionMetrics
description: "A list of tables that were processed by BatchWriteItem and, for\
\ each table, information about any item collections that were affected by\
\ individual DeleteItem or PutItem operations. Each entry consists of the\
\ following subelements: * ItemCollectionKey - The partition key value\
\ of the item collection. This is the same as the partition key value of the\
\ item. \n * SizeEstimateRangeGB - An estimate of item collection size,\
\ expressed in GB. This is a two-element array containing a lower bound and\
\ an upper bound for the estimate. The estimate includes the size of all the\
\ items in the table, plus the size of all attributes projected into all of\
\ the local secondary indexes on the table. Use this estimate to measure whether\
\ a local secondary index is approaching its size limit. The estimate is subject\
\ to change over time; therefore, do not rely on the precision or accuracy\
\ of the estimate. \n "
- contextPath: AWS-DynamoDB.TableName
description: The name of the table that was affected by the operation.
- contextPath: AWS-DynamoDB.CapacityUnits
description: The total number of capacity units consumed by the operation.
- contextPath: AWS-DynamoDB.ReadCapacityUnits
description: The total number of read capacity units consumed by the operation.
- contextPath: AWS-DynamoDB.WriteCapacityUnits
description: The total number of write capacity units consumed by the operation.
- contextPath: AWS-DynamoDB.Table.ReadCapacityUnits
description: The total number of read capacity units consumed on a table or
an index.
- contextPath: AWS-DynamoDB.Table.WriteCapacityUnits
description: The total number of write capacity units consumed on a table or
an index.
- contextPath: AWS-DynamoDB.Table.CapacityUnits
description: The total number of capacity units consumed on a table or an index.
- contextPath: AWS-DynamoDB.Table
description: The amount of throughput consumed on the table affected by the
operation.
- contextPath: AWS-DynamoDB.LocalSecondaryIndexes
description: The amount of throughput consumed on each local index affected
by the operation.
- contextPath: AWS-DynamoDB.GlobalSecondaryIndexes
description: The amount of throughput consumed on each global index affected
by the operation.
- contextPath: AWS-DynamoDB.docs
description: "The capacity units consumed by the entire BatchWriteItem operation.\
\ Each element consists of: * TableName - The table that consumed the provisioned\
\ throughput. \n * CapacityUnits - The total number of capacity units consumed.\
\ \n "
- arguments:
- description: The AWS Region, if not specified the default region will be used.
name: region
- description: The Amazon Resource Name (ARN) of the role to assume.
name: roleArn
- description: An identifier for the assumed role session.
name: roleSessionName
- description: 'The duration, in seconds, of the role session. The value can range
from 900 seconds (15 minutes) up to the maximum session duration setting for
the role. '
name: roleSessionDuration
- description: Override arguments and send a formatted JSON file.
name: raw_json
- description: The name of the table.
name: table_name
- description: Specified name for the backup.
name: backup_name
description: "Creates a backup for an existing table. Each time you create an\
\ on-demand backup, the entire table data is backed up. There is no limit to\
\ the number of on-demand backups that can be taken. When you create an on-demand\
\ backup, a time marker of the request is cataloged, and the backup is created\
\ asynchronously, by applying all changes until the time of the request to the\
\ last full table snapshot. Backup requests are processed instantaneously and\
\ become available for restore within minutes. You can call CreateBackup at\
\ a maximum rate of 50 times per second. All backups in DynamoDB work without\
\ consuming any provisioned throughput on the table. If you submit a backup\
\ request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all\
\ data committed to the table up to 14:24:00, and data committed after 14:26:00\
\ will not be. The backup might contain data modifications made between 14:24:00\
\ and 14:26:00. On-demand backup does not support causal consistency. Along\
\ with data, the following are also included on the backups: * Global secondary\
\ indexes (GSIs) \n * Local secondary indexes (LSIs) \n * Streams \n * Provisioned\
\ read and write capacity \n "
name: aws-dynamodb-create-backup
outputs:
- contextPath: AWS-DynamoDB.BackupDetails.BackupArn
description: ARN associated with the backup.
- contextPath: AWS-DynamoDB.BackupDetails.BackupName
description: Name of the requested backup.
- contextPath: AWS-DynamoDB.BackupDetails.BackupSizeBytes
description: Size of the backup in bytes.
- contextPath: AWS-DynamoDB.BackupDetails.BackupStatus
description: 'Backup can be in one of the following states: CREATING, ACTIVE,
DELETED. '
- contextPath: AWS-DynamoDB.BackupDetails.BackupType
description: "BackupType: * USER - You create and manage these using the\
\ on-demand backup feature. \n * SYSTEM - If you delete a table with point-in-time\
\ recovery enabled, a SYSTEM 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.\
\ \n * AWS\\_BACKUP - On-demand backup created by you from AWS Backup service.\
\ \n "
- contextPath: AWS-DynamoDB.BackupDetails.BackupCreationDateTime
description: 'Time at which the backup was created. This is the request time
of the backup. '
- contextPath: AWS-DynamoDB.BackupDetails.BackupExpiryDateTime
description: Time at which the automatic on-demand backup created by DynamoDB
will expire. This SYSTEM on-demand backup expires automatically 35 days after
its creation.
- contextPath: AWS-DynamoDB.BackupDetails
description: Contains the details of the backup created for the table.
- arguments:
- description: The AWS Region, if not specified the default region will be used.
name: region
- description: The Amazon Resource Name (ARN) of the role to assume.
name: roleArn
- description: An identifier for the assumed role session.
name: roleSessionName
- description: 'The duration, in seconds, of the role session. The value can range
from 900 seconds (15 minutes) up to the maximum session duration setting for
the role. '
name: roleSessionDuration
- description: Override arguments and send a formatted JSON file.
name: raw_json
- description: The global table name.
name: global_table_name
- description: The Region where the replica needs to be created.
name: replication_group_region_name
description: "Creates a global table from an existing table. A global table creates\
\ a replication relationship between two or more DynamoDB tables with the same\
\ table name in the provided Regions. If you want to add a new replica table\
\ to a global table, each of the following conditions must be true: * The\
\ table must have the same primary key as all of the other replicas. \n * The\
\ table must have the same name as all of the other replicas. \n * The table\
\ must have DynamoDB Streams enabled, with the stream containing both the new\
\ and the old images of the item. \n * None of the replica tables in the global\
\ table can contain any data. \n If global secondary indexes are specified,\
\ then the following conditions must also be met: * The global secondary\
\ indexes must have the same name. \n * The global secondary indexes must\
\ have the same hash key and sort key (if present). \n Write capacity settings\
\ should be set consistently across your replica tables and secondary indexes.\
\ DynamoDB strongly recommends enabling auto scaling to manage the write capacity\
\ settings for all of your global tables replicas and indexes. If you prefer\
\ to manage write capacity settings manually, you should provision equal replicated\
\ write capacity units to your replica tables. You should also provision equal\
\ replicated write capacity units to matching secondary indexes across your\
\ global table. "
name: aws-dynamodb-create-global-table
outputs:
- contextPath: AWS-DynamoDB.GlobalTableDescription.ReplicationGroup.RegionName
description: The name of the Region.
- contextPath: AWS-DynamoDB.GlobalTableDescription.ReplicationGroup
description: The Regions where the global table has replicas.
- contextPath: AWS-DynamoDB.GlobalTableDescription.GlobalTableArn
description: The unique identifier of the global table.
- contextPath: AWS-DynamoDB.GlobalTableDescription.CreationDateTime
description: The creation time of the global table.
- contextPath: AWS-DynamoDB.GlobalTableDescription.GlobalTableStatus
description: "The current state of the global table: * CREATING - The global\
\ table is being created. \n * UPDATING - The global table is being updated.\
\ \n * DELETING - The global table is being deleted. \n * ACTIVE - The\
\ global table is ready for use. \n "
- contextPath: AWS-DynamoDB.GlobalTableDescription.GlobalTableName
description: The global table name.
- contextPath: AWS-DynamoDB.GlobalTableDescription
description: Contains the details of the global table.
- arguments:
- description: The AWS Region, if not specified the default region will be used.
name: region
- description: The Amazon Resource Name (ARN) of the role to assume.
name: roleArn
- description: An identifier for the assumed role session.
name: roleSessionName
- description: 'The duration, in seconds, of the role session. The value can range
from 900 seconds (15 minutes) up to the maximum session duration setting for
the role. '
name: roleSessionDuration
- description: Override arguments and send a formatted JSON file.
name: raw_json
- description: A name for the attribute.
name: attribute_definitions_attribute_name
- auto: PREDEFINED
description: "The data type for the attribute, where: * S - the attribute\
\ is of type String \n * N - the attribute is of type Number \n * B -\
\ the attribute is of type Binary \n "
name: attribute_definitions_attribute_type
predefined:
- S
- N
- B
- description: The name of the table to create.
name: table_name
- description: The name of the local secondary index. The name must be unique
among all other indexes on this table.
name: local_secondary_indexes_index_name
- description: The name of a key attribute.
name: key_schema_attribute_name
- description: The name of the global secondary index. The name must be unique
among all other indexes on this table.
name: global_secondary_indexes_index_name
- auto: PREDEFINED
description: "The role that this key attribute will assume: * HASH - partition\
\ key \n * RANGE - sort key \n The partition key of an item is also known\
\ as its *hash attribute*. 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. The sort key of an item\
\ is also known as its *range attribute*. 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. "
name: key_schema_key_type
predefined:
- HASH
- RANGE
- auto: PREDEFINED
description: "The set of attributes that are projected into the index: * \
\ KEYS\\_ONLY - Only the index and primary keys are projected into the index.\
\ \n * INCLUDE - Only the specified table attributes are projected into\
\ the index. The list of projected attributes is in NonKeyAttributes. \n *\
\ ALL - All of the table attributes are projected into the index. \n "
name: projection_projection_type
predefined:
- ALL
- KEYS_ONLY
- INCLUDE
- description: Represents the non-key attribute names which will be projected
into the index. For local secondary indexes, the total count of NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 20. If you
project the same attribute into two different indexes, this counts as two
distinct attributes when determining the total.
name: projection_non_key_attributes
- auto: PREDEFINED
description: "Controls how you are charged for read and write throughput and\
\ how you manage capacity. This setting can be changed later. * PROVISIONED\
\ - We recommend using PROVISIONED for predictable workloads. PROVISIONED\
\ sets the billing mode to Provisioned Mode. \n * PAY\\_PER\\_REQUEST -\
\ We recommend using PAY\\_PER\\_REQUEST for unpredictable workloads. PAY\\\
_PER\\_REQUEST sets the billing mode to On-Demand Mode. \n "
name: billing_mode
predefined:
- PROVISIONED
- PAY_PER_REQUEST
- description: The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException. For more information, see Specifying
Read and Write Requirements in the *Amazon DynamoDB Developer Guide*. If read/write
capacity mode is PAY\_PER\_REQUEST the value is set to 0.
name: provisioned_throughput_read_capacity_units
- description: The maximum number of writes consumed per second before DynamoDB
returns a ThrottlingException. For more information, see Specifying Read and
Write Requirements in the *Amazon DynamoDB Developer Guide*. If read/write
capacity mode is PAY\_PER\_REQUEST the value is set to 0.
name: provisioned_throughput_write_capacity_units
- auto: PREDEFINED
description: <p>Indicates whether DynamoDB Streams is enabled (true) or disabled
(false) on the table.</p>
name: stream_specification_stream_enabled
predefined:
- 'True'
- 'False'
- auto: PREDEFINED
description: " When an item in the table is modified, StreamViewType determines\
\ what information is written to the stream for this table. Valid values for\
\ StreamViewType are: * KEYS\\_ONLY - Only the key attributes of the modified\
\ item are written to the stream. \n * NEW\\_IMAGE - The entire item, as\
\ it appears after it was modified, is written to the stream. \n * OLD\\\
_IMAGE - The entire item, as it appeared before it was modified, is written\
\ to the stream. \n * NEW\\_AND\\_OLD\\_IMAGES - Both the new and the old\
\ item images of the item are written to the stream. \n "
name: stream_specification_stream_view_type
predefined:
- NEW_IMAGE
- OLD_IMAGE
- NEW_AND_OLD_IMAGES
- KEYS_ONLY
- auto: PREDEFINED
description: <p>Indicates whether server-side encryption is done using an AWS
managed CMK or an AWS owned CMK. If enabled (true), server-side encryption
type is set to <code>KMS</code> and an AWS managed CMK is used (AWS KMS charges
apply). If disabled (false) or not specified, server-side encryption is set
to AWS owned CMK.</p>
name: sse_specification_enabled
predefined:
- 'True'
- 'False'
- auto: PREDEFINED
description: "Server-side encryption type. The only supported value is: * \
\ KMS - Server-side encryption that uses AWS Key Management Service. The\
\ key is stored in your account and is managed by AWS KMS (AWS KMS charges\
\ apply). \n "
name: sse_specification_sse_type
predefined:
- AES256
- KMS
- description: The KMS customer master key (CMK) that should be used for the AWS
KMS encryption. To specify a CMK, use its key ID, Amazon Resource Name (ARN),
alias name, or alias ARN. Note that you should only provide this parameter
if the key is different from the default DynamoDB customer master key alias/aws/dynamodb.
name: sse_specification_kms_master_key_id
- description: The Tags key identifier.
name: tag_key
- description: The Tags value identifier.
name: tag_value
- description: 'List of Tags separated by Key Value. For example: "key=key1,value=value1;key=key2,value=value2"'
name: tags
description: The CreateTable operation adds a new table to your account. In an
AWS account, table names must be unique within each Region. That is, you can
have two tables with same name if you create the tables in different Regions. CreateTable
is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB
immediately returns a response with a TableStatus of CREATING. After the table
is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and
write operations only on an ACTIVE table. You can optionally define secondary
indexes on the new table, as part of the CreateTable operation. If you want
to create multiple tables with secondary indexes on them, you must create the
tables sequentially. Only one table with secondary indexes can be in the CREATING
state at any given time. You can use the DescribeTable action to check the table
status.
name: aws-dynamodb-create-table
outputs:
- contextPath: AWS-DynamoDB.TableDescription.AttributeDefinitions.AttributeName
description: A name for the attribute.
- contextPath: AWS-DynamoDB.TableDescription.AttributeDefinitions.AttributeType
description: "The data type for the attribute, where: * S - the attribute\
\ is of type String \n * N - the attribute is of type Number \n * B -\
\ the attribute is of type Binary \n "
- contextPath: AWS-DynamoDB.TableDescription.AttributeDefinitions
description: "An array of AttributeDefinition objects. Each of these objects\
\ describes one attribute in the table and index key schema. Each AttributeDefinition\
\ object in this array is composed of: * AttributeName - The name of the\
\ attribute. \n * AttributeType - The data type for the attribute. \n "
- contextPath: AWS-DynamoDB.TableDescription.TableName
description: The name of the table.
- contextPath: AWS-DynamoDB.TableDescription.KeySchema.AttributeName
description: The name of a key attribute.
- contextPath: AWS-DynamoDB.TableDescription.KeySchema.KeyType
description: "The role that this key attribute will assume: * HASH - partition\
\ key \n * RANGE - sort key \n The partition key of an item is also known\
\ as its *hash attribute*. 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. The sort key of an item\
\ is also known as its *range attribute*. 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. "
- contextPath: AWS-DynamoDB.TableDescription.KeySchema
description: "The primary key structure for the table. Each KeySchemaElement\
\ consists of: * AttributeName - The name of the attribute. \n * KeyType\
\ - The role of the attribute: \n\t + HASH - partition key \n\t + RANGE\
\ - sort key \n\t The partition key of an item is also known as its *hash\
\ attribute*. 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. The sort key of an item is also known\
\ as its *range attribute*. 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. \n For more information about primary\
\ keys, see Primary Key in the *Amazon DynamoDB Developer Guide*."
- contextPath: AWS-DynamoDB.TableDescription.TableStatus
description: "The current state of the table: * CREATING - The table is being\
\ created. \n * UPDATING - The table is being updated. \n * DELETING -\
\ The table is being deleted. \n * ACTIVE - The table is ready for use.\
\ \n "
- contextPath: AWS-DynamoDB.TableDescription.CreationDateTime
description: The date and time when the table was created, in UNIX epoch time
format.
- contextPath: AWS-DynamoDB.TableDescription.ProvisionedThroughput.LastIncreaseDateTime
description: The date and time of the last provisioned throughput increase for
this table.
- contextPath: AWS-DynamoDB.TableDescription.ProvisionedThroughput.LastDecreaseDateTime
description: The date and time of the last provisioned throughput decrease for
this table.
- contextPath: AWS-DynamoDB.TableDescription.ProvisionedThroughput.NumberOfDecreasesToday
description: The number of provisioned throughput decreases for this table during
this UTC calendar day. For current maximums on provisioned throughput decreases,
see Limits in the *Amazon DynamoDB Developer Guide*.
- contextPath: AWS-DynamoDB.TableDescription.ProvisionedThroughput.ReadCapacityUnits
description: The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException. Eventually consistent reads
require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits
per second provides 100 eventually consistent ReadCapacityUnits per second.
- contextPath: AWS-DynamoDB.TableDescription.ProvisionedThroughput.WriteCapacityUnits
description: The maximum number of writes consumed per second before DynamoDB
returns a ThrottlingException.
- contextPath: AWS-DynamoDB.TableDescription.ProvisionedThroughput
description: The provisioned throughput settings for the table, consisting of
read and write capacity units, along with data about increases and decreases.
- contextPath: AWS-DynamoDB.TableDescription.TableSizeBytes
description: The total size of the specified table, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected
in this value.
- contextPath: AWS-DynamoDB.TableDescription.ItemCount
description: The number of items in the specified table. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected
in this value.
- contextPath: AWS-DynamoDB.TableDescription.TableArn
description: The Amazon Resource Name (ARN) that uniquely identifies the table.
- contextPath: AWS-DynamoDB.TableDescription.TableId
description: 'Unique identifier for the table for which the backup was created. '
- contextPath: AWS-DynamoDB.TableDescription.BillingModeSummary.BillingMode
description: "Controls how you are charged for read and write throughput and\
\ how you manage capacity. This setting can be changed later. * PROVISIONED\
\ - Sets the read/write capacity mode to PROVISIONED. We recommend using PROVISIONED\
\ for predictable workloads. \n * PAY\\_PER\\_REQUEST - Sets the read/write\
\ capacity mode to PAY\\_PER\\_REQUEST. We recommend using PAY\\_PER\\_REQUEST\
\ for unpredictable workloads. \n "
- contextPath: AWS-DynamoDB.TableDescription.BillingModeSummary.LastUpdateToPayPerRequestDateTime
description: Represents the time when PAY\_PER\_REQUEST was last set as the
read/write capacity mode.
- contextPath: AWS-DynamoDB.TableDescription.BillingModeSummary
description: Contains the details for the read/write capacity mode.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.IndexName
description: Represents the name of the local secondary index.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.KeySchema.AttributeName
description: The name of a key attribute.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.KeySchema.KeyType
description: "The role that this key attribute will assume: * HASH - partition\
\ key \n * RANGE - sort key \n The partition key of an item is also known\
\ as its *hash attribute*. 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. The sort key of an item\
\ is also known as its *range attribute*. 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. "
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.KeySchema
description: "The complete key schema for the local secondary index, consisting\
\ of one or more pairs of attribute names and key types: * HASH - partition\
\ key \n * RANGE - sort key \n The partition key of an item is also known\
\ as its *hash attribute*. 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. The sort key of an item\
\ is also known as its *range attribute*. 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. "
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.Projection.ProjectionType
description: "The set of attributes that are projected into the index: * \
\ KEYS\\_ONLY - Only the index and primary keys are projected into the index.\
\ \n * INCLUDE - Only the specified table attributes are projected into\
\ the index. The list of projected attributes is in NonKeyAttributes. \n *\
\ ALL - All of the table attributes are projected into the index. \n "
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.Projection.NonKeyAttributes
description: Represents the non-key attribute names which will be projected
into the index. For local secondary indexes, the total count of NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 20. If you
project the same attribute into two different indexes, this counts as two
distinct attributes when determining the total.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.Projection
description: '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. '
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.IndexSizeBytes
description: The total size of the specified index, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected
in this value.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.ItemCount
description: The number of items in the specified index. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected
in this value.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes.IndexArn
description: The Amazon Resource Name (ARN) that uniquely identifies the index.
- contextPath: AWS-DynamoDB.TableDescription.LocalSecondaryIndexes
description: "Represents one or more local secondary indexes on the table. Each\
\ index is scoped to a given partition key value. Tables with one or more\
\ local secondary indexes are subject to an item collection size limit, where\
\ the amount of data within a given item collection cannot exceed 10 GB. Each\
\ element is composed of: * IndexName - The name of the local secondary\
\ index. \n * KeySchema - Specifies the complete index key schema. The attribute\
\ names in the key schema must be between 1 and 255 characters (inclusive).\
\ The key schema must begin with the same partition key as the table. \n *\
\ Projection - Specifies attributes that are copied (projected) from the\
\ table into the index. These are in addition to the primary key attributes\
\ and index key attributes, which are automatically projected. Each attribute\
\ specification is composed of: \n\t + ProjectionType - One of the following:\
\ \n\t\t - KEYS\\_ONLY - Only the index and primary keys are projected into\
\ the index. \n\t\t - INCLUDE - Only the specified table attributes are\
\ projected into the index. The list of projected attributes is in NonKeyAttributes.\
\ \n\t\t - ALL - All of the table attributes are projected into the index.\
\ \n\t\t \n\t + NonKeyAttributes - A list of one or more non-key attribute\
\ names that are projected into the secondary index. The total count of attributes\
\ provided in NonKeyAttributes, summed across all of the secondary indexes,\
\ must not exceed 20. If you project the same attribute into two different\
\ indexes, this counts as two distinct attributes when determining the total.\
\ \n\t \n * IndexSizeBytes - Represents the total size of the index, in\
\ bytes. DynamoDB updates this value approximately every six hours. Recent\
\ changes might not be reflected in this value. \n * ItemCount - Represents\
\ the number of items in the index. DynamoDB updates this value approximately\
\ every six hours. Recent changes might not be reflected in this value. \n\
\ If the table is in the DELETING state, no information about indexes will\
\ be returned."
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.IndexName
description: The name of the global secondary index.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.KeySchema.AttributeName
description: The name of a key attribute.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.KeySchema.KeyType
description: "The role that this key attribute will assume: * HASH - partition\
\ key \n * RANGE - sort key \n The partition key of an item is also known\
\ as its *hash attribute*. 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. The sort key of an item\
\ is also known as its *range attribute*. 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. "
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.KeySchema
description: "The complete key schema for a global secondary index, which consists\
\ of one or more pairs of attribute names and key types: * HASH - partition\
\ key \n * RANGE - sort key \n The partition key of an item is also known\
\ as its *hash attribute*. 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. The sort key of an item\
\ is also known as its *range attribute*. 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. "
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.Projection.ProjectionType
description: "The set of attributes that are projected into the index: * \
\ KEYS\\_ONLY - Only the index and primary keys are projected into the index.\
\ \n * INCLUDE - Only the specified table attributes are projected into\
\ the index. The list of projected attributes is in NonKeyAttributes. \n *\
\ ALL - All of the table attributes are projected into the index. \n "
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.Projection.NonKeyAttributes
description: Represents the non-key attribute names which will be projected
into the index. For local secondary indexes, the total count of NonKeyAttributes
summed across all of the local secondary indexes, must not exceed 20. If you
project the same attribute into two different indexes, this counts as two
distinct attributes when determining the total.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.Projection
description: '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. '
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.IndexStatus
description: "The current state of the global secondary index: * CREATING\
\ - The index is being created. \n * UPDATING - The index is being updated.\
\ \n * DELETING - The index is being deleted. \n * ACTIVE - The index\
\ is ready for use. \n "
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.Backfilling
description: 'Indicates whether the index is currently backfilling. *Backfilling*
is the process of reading items from the table and determining whether they
can be added to the index. (Not all items will qualify: For example, a partition
key cannot have any duplicate values.) If an item can be added to the index,
DynamoDB will do so. After all items have been processed, the backfilling
operation is complete and Backfilling is false. You can delete an index that
is being created during the Backfilling phase when IndexStatus is set to CREATING
and Backfilling is true. You can''t delete the index that is being created
when IndexStatus is set to CREATING and Backfilling is false. For indexes
that were created during a CreateTable operation, the Backfilling attribute
does not appear in the DescribeTable output. '
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ProvisionedThroughput.LastIncreaseDateTime
description: The date and time of the last provisioned throughput increase for
this table.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ProvisionedThroughput.LastDecreaseDateTime
description: The date and time of the last provisioned throughput decrease for
this table.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ProvisionedThroughput.NumberOfDecreasesToday
description: The number of provisioned throughput decreases for this table during
this UTC calendar day. For current maximums on provisioned throughput decreases,
see Limits in the *Amazon DynamoDB Developer Guide*.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ProvisionedThroughput.ReadCapacityUnits
description: The maximum number of strongly consistent reads consumed per second
before DynamoDB returns a ThrottlingException. Eventually consistent reads
require less effort than strongly consistent reads, so a setting of 50 ReadCapacityUnits
per second provides 100 eventually consistent ReadCapacityUnits per second.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ProvisionedThroughput.WriteCapacityUnits
description: The maximum number of writes consumed per second before DynamoDB
returns a ThrottlingException.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ProvisionedThroughput
description: Represents the provisioned throughput settings for the specified
global secondary index. For current minimum and maximum provisioned throughput
values, see Limits in the *Amazon DynamoDB Developer Guide*.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.IndexSizeBytes
description: The total size of the specified index, in bytes. DynamoDB updates
this value approximately every six hours. Recent changes might not be reflected
in this value.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.ItemCount
description: The number of items in the specified index. DynamoDB updates this
value approximately every six hours. Recent changes might not be reflected
in this value.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes.IndexArn
description: The Amazon Resource Name (ARN) that uniquely identifies the index.
- contextPath: AWS-DynamoDB.TableDescription.GlobalSecondaryIndexes
description: "The global secondary indexes, if any, on the table. Each index\
\ is scoped to a given partition key value. Each element is composed of: \
\ * Backfilling - If true, then the index is currently in the backfilling\
\ phase. Backfilling occurs only when a new global secondary index is added\
\ to the table. It is the process by which DynamoDB populates the new index\
\ with data from the table. (This attribute does not appear for indexes that\
\ were created during a CreateTable operation.) You can delete an index\
\ that is being created during the Backfilling phase when IndexStatus is set\
\ to CREATING and Backfilling is true. You can't delete the index that is\
\ being created when IndexStatus is set to CREATING and Backfilling is false.\
\ (This attribute does not appear for indexes that were created during a CreateTable\
\ operation.) \n * IndexName - The name of the global secondary index. \n\
\ * IndexSizeBytes - The total size of the global secondary index, in bytes.\
\ DynamoDB updates this value approximately every six hours. Recent changes\
\ might not be reflected in this value. \n * IndexStatus - The current\
\ status of the global secondary index: \n\t + CREATING - The index is being\
\ created. \n\t + UPDATING - The index is being updated. \n\t + DELETING\
\ - The index is being deleted. \n\t + ACTIVE - The index is ready for use.\
\ \n\t \n * ItemCount - The number of items in the global secondary index.\
\ DynamoDB updates this value approximately every six hours. Recent changes\
\ might not be reflected in this value. \n * KeySchema - Specifies the\
\ complete index key schema. The attribute names in the key schema must be\
\ between 1 and 255 characters (inclusive). The key schema must begin with\
\ the same partition key as the table. \n * Projection - Specifies attributes\
\ that are copied (projected) from the table into the index. These are in\
\ addition to the primary key attributes and index key attributes, which are\
\ automatically projected. Each attribute specification is composed of: \n\
\t + ProjectionType - One of the following: \n\t\t - KEYS\\_ONLY - Only\
\ the index and primary keys are projected into the index. \n\t\t - INCLUDE\
\ - Only the specified table attributes are projected into the index. The\
\ list of projected attributes is in NonKeyAttributes. \n\t\t - ALL - All\
\ of the table attributes are projected into the index. \n\t\t \n\t + NonKeyAttributes\
\ - A list of one or more non-key attribute names that are projected into\
\ the secondary index. The total count of attributes provided in NonKeyAttributes,\
\ summed across all of the secondary indexes, must not exceed 20. If you project\
\ the same attribute into two different indexes, this counts as two distinct\
\ attributes when determining the total. \n\t \n * ProvisionedThroughput\
\ - The provisioned throughput settings for the global secondary index, consisting\
\ of read and write capacity units, along with data about increases and decreases.\
\ \n If the table is in the DELETING state, no information about indexes\
\ will be returned."
- contextPath: AWS-DynamoDB.TableDescription.StreamSpecification.StreamEnabled
description: Indicates whether DynamoDB Streams is enabled (true) or disabled
(false) on the table.
- contextPath: AWS-DynamoDB.TableDescription.StreamSpecification.StreamViewType
description: " When an item in the table is modified, StreamViewType determines\
\ what information is written to the stream for this table. Valid values for\
\ StreamViewType are: * KEYS\\_ONLY - Only the key attributes of the modified\
\ item are written to the stream. \n * NEW\\_IMAGE - The entire item, as\
\ it appears after it was modified, is written to the stream. \n * OLD\\\
_IMAGE - The entire item, as it appeared before it was modified, is written\
\ to the stream. \n * NEW\\_AND\\_OLD\\_IMAGES - Both the new and the old\
\ item images of the item are written to the stream. \n "
- contextPath: AWS-DynamoDB.TableDescription.StreamSpecification
description: The current DynamoDB Streams configuration for the table.
- contextPath: AWS-DynamoDB.TableDescription.LatestStreamLabel
description: "A timestamp, in ISO 8601 format, for this stream. Note that LatestStreamLabel\
\ is not a unique identifier for the stream, because it is possible that a\
\ stream from another table might have the same timestamp. However, the combination\
\ of the following three elements is guaranteed to be unique: * AWS customer\
\ ID \n * Table name \n * StreamLabel \n "
- contextPath: AWS-DynamoDB.TableDescription.LatestStreamArn
description: The Amazon Resource Name (ARN) that uniquely identifies the latest
stream for this table.
- contextPath: AWS-DynamoDB.TableDescription.RestoreSummary.SourceBackupArn
description: The Amazon Resource Name (ARN) of the backup from which the table
was restored.
- contextPath: AWS-DynamoDB.TableDescription.RestoreSummary.SourceTableArn
description: The ARN of the source table of the backup that is being restored.
- contextPath: AWS-DynamoDB.TableDescription.RestoreSummary.RestoreDateTime
description: Point in time or source backup time.
- contextPath: AWS-DynamoDB.TableDescription.RestoreSummary.RestoreInProgress
description: Indicates if a restore is in progress or not.
- contextPath: AWS-DynamoDB.TableDescription.RestoreSummary
description: Contains details for the restore.
- contextPath: AWS-DynamoDB.TableDescription.SSEDescription.Status
description: "Represents the current state of server-side encryption. The only\
\ supported values are: * ENABLED - Server-side encryption is enabled.\
\ \n * UPDATING - Server-side encryption is being updated. \n "
- contextPath: AWS-DynamoDB.TableDescription.SSEDescription.SSEType
description: "Server-side encryption type. The only supported value is: * \
\ KMS - Server-side encryption that uses AWS Key Management Service. The\
\ key is stored in your account and is managed by AWS KMS (AWS KMS charges\
\ apply). \n "
- contextPath: AWS-DynamoDB.TableDescription.SSEDescription.KMSMasterKeyArn