aws-sdk-dynamodb 1.31.0 → 1.32.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-dynamodb.rb +1 -1
- data/lib/aws-sdk-dynamodb/client.rb +223 -195
- data/lib/aws-sdk-dynamodb/resource.rb +14 -13
- data/lib/aws-sdk-dynamodb/table.rb +53 -53
- data/lib/aws-sdk-dynamodb/types.rb +127 -124
- metadata +2 -2
@@ -96,8 +96,9 @@ module Aws::DynamoDB
|
|
96
96
|
#
|
97
97
|
# </note>
|
98
98
|
#
|
99
|
-
# For more information
|
100
|
-
# Item Attributes][2] in the *Amazon DynamoDB Developer
|
99
|
+
# For more information about expression attribute names, see
|
100
|
+
# [Accessing Item Attributes][2] in the *Amazon DynamoDB Developer
|
101
|
+
# Guide*.
|
101
102
|
#
|
102
103
|
# * `Keys` - An array of primary key attribute values that define
|
103
104
|
# specific items in the table. For each primary key, you must provide
|
@@ -111,9 +112,9 @@ module Aws::DynamoDB
|
|
111
112
|
# scalars, sets, or elements of a JSON document. The attributes in the
|
112
113
|
# expression must be separated by commas.
|
113
114
|
#
|
114
|
-
# If no attribute names are specified, then all attributes
|
115
|
-
# returned. If any of the requested attributes are not found, they
|
116
|
-
#
|
115
|
+
# If no attribute names are specified, then all attributes are
|
116
|
+
# returned. If any of the requested attributes are not found, they do
|
117
|
+
# not appear in the result.
|
117
118
|
#
|
118
119
|
# For more information, see [Accessing Item Attributes][2] in the
|
119
120
|
# *Amazon DynamoDB Developer Guide*.
|
@@ -198,7 +199,7 @@ module Aws::DynamoDB
|
|
198
199
|
# Attribute values must not be null; string and binary type
|
199
200
|
# attributes must have lengths greater than zero; and set type
|
200
201
|
# attributes must not be empty. Requests that contain empty values
|
201
|
-
#
|
202
|
+
# are rejected with a `ValidationException` exception.
|
202
203
|
#
|
203
204
|
# If you specify any attributes that are part of an index key, then
|
204
205
|
# the data types for those attributes must match those of the schema
|
@@ -324,7 +325,7 @@ module Aws::DynamoDB
|
|
324
325
|
# * `RANGE` - sort key
|
325
326
|
#
|
326
327
|
# <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
|
327
|
-
# The term "hash attribute" derives from DynamoDB
|
328
|
+
# The term "hash attribute" derives from the DynamoDB usage of an
|
328
329
|
# internal hash function to evenly distribute data items across
|
329
330
|
# partitions, based on their partition key values.
|
330
331
|
#
|
@@ -343,8 +344,8 @@ module Aws::DynamoDB
|
|
343
344
|
# have a `KeyType` of `HASH`, and the second element must have a
|
344
345
|
# `KeyType` of `RANGE`.
|
345
346
|
#
|
346
|
-
# For more information, see [
|
347
|
-
#
|
347
|
+
# For more information, see [Working with Tables][2] in the *Amazon
|
348
|
+
# DynamoDB Developer Guide*.
|
348
349
|
#
|
349
350
|
#
|
350
351
|
#
|
@@ -378,7 +379,7 @@ module Aws::DynamoDB
|
|
378
379
|
# the index.
|
379
380
|
#
|
380
381
|
# * `INCLUDE` - Only the specified table attributes are projected
|
381
|
-
# into the index. The list of projected attributes
|
382
|
+
# into the index. The list of projected attributes is in
|
382
383
|
# `NonKeyAttributes`.
|
383
384
|
#
|
384
385
|
# * `ALL` - All of the table attributes are projected into the
|
@@ -414,7 +415,7 @@ module Aws::DynamoDB
|
|
414
415
|
# the index.
|
415
416
|
#
|
416
417
|
# * `INCLUDE` - Only the specified table attributes are projected
|
417
|
-
# into the index. The list of projected attributes
|
418
|
+
# into the index. The list of projected attributes is in
|
418
419
|
# `NonKeyAttributes`.
|
419
420
|
#
|
420
421
|
# * `ALL` - All of the table attributes are projected into the
|
@@ -458,8 +459,8 @@ module Aws::DynamoDB
|
|
458
459
|
# The settings for DynamoDB Streams on the table. These settings consist
|
459
460
|
# of:
|
460
461
|
#
|
461
|
-
# * `StreamEnabled` - Indicates whether Streams is to be
|
462
|
-
# or disabled (false).
|
462
|
+
# * `StreamEnabled` - Indicates whether DynamoDB Streams is to be
|
463
|
+
# enabled (true) or disabled (false).
|
463
464
|
#
|
464
465
|
# * `StreamViewType` - When an item in the table is modified,
|
465
466
|
# `StreamViewType` determines what information is written to the
|
@@ -56,7 +56,7 @@ module Aws::DynamoDB
|
|
56
56
|
# * `RANGE` - sort key
|
57
57
|
#
|
58
58
|
# <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
|
59
|
-
# The term "hash attribute" derives from DynamoDB' usage of an
|
59
|
+
# The term "hash attribute" derives from DynamoDB's usage of an
|
60
60
|
# internal hash function to evenly distribute data items across
|
61
61
|
# partitions, based on their partition key values.
|
62
62
|
#
|
@@ -556,8 +556,8 @@ module Aws::DynamoDB
|
|
556
556
|
#
|
557
557
|
# * Logical operators: `AND | OR | NOT`
|
558
558
|
#
|
559
|
-
# For more information
|
560
|
-
#
|
559
|
+
# For more information about condition expressions, see [Condition
|
560
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
561
561
|
#
|
562
562
|
#
|
563
563
|
#
|
@@ -605,7 +605,7 @@ module Aws::DynamoDB
|
|
605
605
|
#
|
606
606
|
# </note>
|
607
607
|
#
|
608
|
-
# For more information on expression attribute names, see [
|
608
|
+
# For more information on expression attribute names, see [Specifying
|
609
609
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
610
610
|
#
|
611
611
|
#
|
@@ -631,8 +631,8 @@ module Aws::DynamoDB
|
|
631
631
|
#
|
632
632
|
# `ProductStatus IN (:avail, :back, :disc)`
|
633
633
|
#
|
634
|
-
# For more information on expression attribute values, see [
|
635
|
-
#
|
634
|
+
# For more information on expression attribute values, see [Condition
|
635
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
636
636
|
#
|
637
637
|
#
|
638
638
|
#
|
@@ -701,11 +701,11 @@ module Aws::DynamoDB
|
|
701
701
|
# JSON document. The attributes in the expression must be separated by
|
702
702
|
# commas.
|
703
703
|
#
|
704
|
-
# If no attribute names are specified, then all attributes
|
705
|
-
#
|
706
|
-
#
|
704
|
+
# If no attribute names are specified, then all attributes are returned.
|
705
|
+
# If any of the requested attributes are not found, they do not appear
|
706
|
+
# in the result.
|
707
707
|
#
|
708
|
-
# For more information, see [
|
708
|
+
# For more information, see [Specifying Item Attributes][1] in the
|
709
709
|
# *Amazon DynamoDB Developer Guide*.
|
710
710
|
#
|
711
711
|
#
|
@@ -754,7 +754,7 @@ module Aws::DynamoDB
|
|
754
754
|
#
|
755
755
|
# </note>
|
756
756
|
#
|
757
|
-
# For more information on expression attribute names, see [
|
757
|
+
# For more information on expression attribute names, see [Specifying
|
758
758
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
759
759
|
#
|
760
760
|
#
|
@@ -816,7 +816,7 @@ module Aws::DynamoDB
|
|
816
816
|
#
|
817
817
|
#
|
818
818
|
#
|
819
|
-
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/
|
819
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey
|
820
820
|
# @option options [Hash<String,Types::ExpectedAttributeValue>] :expected
|
821
821
|
# This is a legacy parameter. Use `ConditionExpression` instead. For
|
822
822
|
# more information, see [Expected][1] in the *Amazon DynamoDB Developer
|
@@ -886,8 +886,8 @@ module Aws::DynamoDB
|
|
886
886
|
#
|
887
887
|
# * Logical operators: `AND | OR | NOT`
|
888
888
|
#
|
889
|
-
# For more information on condition expressions, see [
|
890
|
-
#
|
889
|
+
# For more information on condition expressions, see [Condition
|
890
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
891
891
|
#
|
892
892
|
#
|
893
893
|
#
|
@@ -935,7 +935,7 @@ module Aws::DynamoDB
|
|
935
935
|
#
|
936
936
|
# </note>
|
937
937
|
#
|
938
|
-
# For more information on expression attribute names, see [
|
938
|
+
# For more information on expression attribute names, see [Specifying
|
939
939
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
940
940
|
#
|
941
941
|
#
|
@@ -961,8 +961,8 @@ module Aws::DynamoDB
|
|
961
961
|
#
|
962
962
|
# `ProductStatus IN (:avail, :back, :disc)`
|
963
963
|
#
|
964
|
-
# For more information on expression attribute values, see [
|
965
|
-
#
|
964
|
+
# For more information on expression attribute values, see [Condition
|
965
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
966
966
|
#
|
967
967
|
#
|
968
968
|
#
|
@@ -1023,7 +1023,7 @@ module Aws::DynamoDB
|
|
1023
1023
|
#
|
1024
1024
|
# * `ALL_ATTRIBUTES` - Returns all of the item attributes from the
|
1025
1025
|
# specified table or index. If you query a local secondary index, then
|
1026
|
-
# for each matching item in the index DynamoDB
|
1026
|
+
# for each matching item in the index, DynamoDB fetches the entire
|
1027
1027
|
# item from the parent table. If the index is configured to project
|
1028
1028
|
# all item attributes, then all of the data can be obtained from the
|
1029
1029
|
# local secondary index, and no fetching is required.
|
@@ -1044,7 +1044,7 @@ module Aws::DynamoDB
|
|
1044
1044
|
# attributes that are projected into that index, the operation will
|
1045
1045
|
# read only the index and not the table. If any of the requested
|
1046
1046
|
# attributes are not projected into the local secondary index,
|
1047
|
-
# DynamoDB
|
1047
|
+
# DynamoDB fetches each of these attributes from the parent table.
|
1048
1048
|
# This extra fetching incurs additional throughput cost and latency.
|
1049
1049
|
#
|
1050
1050
|
# If you query or scan a global secondary index, you can only request
|
@@ -1078,7 +1078,7 @@ module Aws::DynamoDB
|
|
1078
1078
|
# limit while processing the results, it stops the operation and returns
|
1079
1079
|
# the matching values up to that point, and a key in `LastEvaluatedKey`
|
1080
1080
|
# to apply in a subsequent operation, so that you can pick up where you
|
1081
|
-
# left off. Also, if the processed
|
1081
|
+
# left off. Also, if the processed dataset size exceeds 1 MB before
|
1082
1082
|
# DynamoDB reaches this limit, it stops the operation and returns the
|
1083
1083
|
# matching values up to the limit, and a key in `LastEvaluatedKey` to
|
1084
1084
|
# apply in a subsequent operation to continue the operation. For more
|
@@ -1141,7 +1141,7 @@ module Aws::DynamoDB
|
|
1141
1141
|
# Use the value that was returned for `LastEvaluatedKey` in the previous
|
1142
1142
|
# operation.
|
1143
1143
|
#
|
1144
|
-
# The data type for `ExclusiveStartKey` must be String, Number or
|
1144
|
+
# The data type for `ExclusiveStartKey` must be String, Number, or
|
1145
1145
|
# Binary. No set data types are allowed.
|
1146
1146
|
# @option options [String] :return_consumed_capacity
|
1147
1147
|
# Determines the level of detail about provisioned throughput
|
@@ -1196,8 +1196,8 @@ module Aws::DynamoDB
|
|
1196
1196
|
#
|
1197
1197
|
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/QueryAndScan.html#FilteringResults
|
1198
1198
|
# @option options [String] :key_condition_expression
|
1199
|
-
# The condition that specifies the key
|
1200
|
-
#
|
1199
|
+
# The condition that specifies the key values for items to be retrieved
|
1200
|
+
# by the `Query` action.
|
1201
1201
|
#
|
1202
1202
|
# The condition must perform an equality test on a single partition key
|
1203
1203
|
# value.
|
@@ -1321,7 +1321,7 @@ module Aws::DynamoDB
|
|
1321
1321
|
#
|
1322
1322
|
# </note>
|
1323
1323
|
#
|
1324
|
-
# For more information on expression attribute names, see [
|
1324
|
+
# For more information on expression attribute names, see [Specifying
|
1325
1325
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
1326
1326
|
#
|
1327
1327
|
#
|
@@ -1409,12 +1409,12 @@ module Aws::DynamoDB
|
|
1409
1409
|
# limit while processing the results, it stops the operation and returns
|
1410
1410
|
# the matching values up to that point, and a key in `LastEvaluatedKey`
|
1411
1411
|
# to apply in a subsequent operation, so that you can pick up where you
|
1412
|
-
# left off. Also, if the processed
|
1412
|
+
# left off. Also, if the processed dataset size exceeds 1 MB before
|
1413
1413
|
# DynamoDB reaches this limit, it stops the operation and returns the
|
1414
1414
|
# matching values up to the limit, and a key in `LastEvaluatedKey` to
|
1415
1415
|
# apply in a subsequent operation to continue the operation. For more
|
1416
|
-
# information, see [
|
1417
|
-
# Guide*.
|
1416
|
+
# information, see [Working with Queries][1] in the *Amazon DynamoDB
|
1417
|
+
# Developer Guide*.
|
1418
1418
|
#
|
1419
1419
|
#
|
1420
1420
|
#
|
@@ -1427,7 +1427,7 @@ module Aws::DynamoDB
|
|
1427
1427
|
#
|
1428
1428
|
# * `ALL_ATTRIBUTES` - Returns all of the item attributes from the
|
1429
1429
|
# specified table or index. If you query a local secondary index, then
|
1430
|
-
# for each matching item in the index DynamoDB
|
1430
|
+
# for each matching item in the index, DynamoDB fetches the entire
|
1431
1431
|
# item from the parent table. If the index is configured to project
|
1432
1432
|
# all item attributes, then all of the data can be obtained from the
|
1433
1433
|
# local secondary index, and no fetching is required.
|
@@ -1445,11 +1445,11 @@ module Aws::DynamoDB
|
|
1445
1445
|
# `AttributesToGet` without specifying any value for `Select`.
|
1446
1446
|
#
|
1447
1447
|
# If you query or scan a local secondary index and request only
|
1448
|
-
# attributes that are projected into that index, the operation
|
1449
|
-
#
|
1450
|
-
#
|
1451
|
-
#
|
1452
|
-
#
|
1448
|
+
# attributes that are projected into that index, the operation reads
|
1449
|
+
# only the index and not the table. If any of the requested attributes
|
1450
|
+
# are not projected into the local secondary index, DynamoDB fetches
|
1451
|
+
# each of these attributes from the parent table. This extra fetching
|
1452
|
+
# incurs additional throughput cost and latency.
|
1453
1453
|
#
|
1454
1454
|
# If you query or scan a global secondary index, you can only request
|
1455
1455
|
# attributes that are projected into the index. Global secondary index
|
@@ -1551,7 +1551,7 @@ module Aws::DynamoDB
|
|
1551
1551
|
# returned. If any of the requested attributes are not found, they will
|
1552
1552
|
# not appear in the result.
|
1553
1553
|
#
|
1554
|
-
# For more information, see [
|
1554
|
+
# For more information, see [Specifying Item Attributes][1] in the
|
1555
1555
|
# *Amazon DynamoDB Developer Guide*.
|
1556
1556
|
#
|
1557
1557
|
#
|
@@ -1617,7 +1617,7 @@ module Aws::DynamoDB
|
|
1617
1617
|
#
|
1618
1618
|
# </note>
|
1619
1619
|
#
|
1620
|
-
# For more information on expression attribute names, see [
|
1620
|
+
# For more information on expression attribute names, see [Specifying
|
1621
1621
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
1622
1622
|
#
|
1623
1623
|
#
|
@@ -1629,7 +1629,7 @@ module Aws::DynamoDB
|
|
1629
1629
|
#
|
1630
1630
|
# Use the **\:** (colon) character in an expression to dereference an
|
1631
1631
|
# attribute value. For example, suppose that you wanted to check whether
|
1632
|
-
# the value of the
|
1632
|
+
# the value of the `ProductStatus` attribute was one of the following:
|
1633
1633
|
#
|
1634
1634
|
# `Available | Backordered | Discontinued`
|
1635
1635
|
#
|
@@ -1643,8 +1643,8 @@ module Aws::DynamoDB
|
|
1643
1643
|
#
|
1644
1644
|
# `ProductStatus IN (:avail, :back, :disc)`
|
1645
1645
|
#
|
1646
|
-
# For more information on expression attribute values, see [
|
1647
|
-
#
|
1646
|
+
# For more information on expression attribute values, see [Condition
|
1647
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
1648
1648
|
#
|
1649
1649
|
#
|
1650
1650
|
#
|
@@ -1655,7 +1655,7 @@ module Aws::DynamoDB
|
|
1655
1655
|
#
|
1656
1656
|
# * If `ConsistentRead` is `false`, then the data returned from `Scan`
|
1657
1657
|
# might not contain the results from other recently completed write
|
1658
|
-
# operations (PutItem
|
1658
|
+
# operations (`PutItem`, `UpdateItem`, or `DeleteItem`).
|
1659
1659
|
#
|
1660
1660
|
# * If `ConsistentRead` is `true`, then all of the write operations that
|
1661
1661
|
# completed before the `Scan` began are guaranteed to be contained in
|
@@ -1770,9 +1770,9 @@ module Aws::DynamoDB
|
|
1770
1770
|
# @option options [Types::StreamSpecification] :stream_specification
|
1771
1771
|
# Represents the DynamoDB Streams configuration for the table.
|
1772
1772
|
#
|
1773
|
-
# <note markdown="1"> You
|
1774
|
-
#
|
1775
|
-
#
|
1773
|
+
# <note markdown="1"> You receive a `ResourceInUseException` if you try to enable a stream
|
1774
|
+
# on a table that already has a stream, or if you try to disable a
|
1775
|
+
# stream on a table that doesn't have a stream.
|
1776
1776
|
#
|
1777
1777
|
# </note>
|
1778
1778
|
# @option options [Types::SSESpecification] :sse_specification
|
@@ -1903,12 +1903,12 @@ module Aws::DynamoDB
|
|
1903
1903
|
# response. If set to `NONE` (the default), no statistics are returned.
|
1904
1904
|
# @option options [String] :update_expression
|
1905
1905
|
# An expression that defines one or more attributes to be updated, the
|
1906
|
-
# action to be performed on them, and new
|
1906
|
+
# action to be performed on them, and new values for them.
|
1907
1907
|
#
|
1908
1908
|
# The following action values are available for `UpdateExpression`.
|
1909
1909
|
#
|
1910
1910
|
# * `SET` - Adds one or more attributes and values to an item. If any of
|
1911
|
-
# these
|
1911
|
+
# these attributes already exist, they are replaced by the new values.
|
1912
1912
|
# You can also use `SET` to add or subtract from an attribute that is
|
1913
1913
|
# of type Number. For example: `SET myNum = myNum + :val`
|
1914
1914
|
#
|
@@ -1945,10 +1945,10 @@ module Aws::DynamoDB
|
|
1945
1945
|
# decrement an attribute value that doesn't exist before the
|
1946
1946
|
# update, DynamoDB uses `0` as the initial value. For example,
|
1947
1947
|
# suppose that the item you want to update doesn't have an
|
1948
|
-
# attribute named
|
1949
|
-
# `3` to this attribute anyway. DynamoDB will create the
|
1948
|
+
# attribute named `itemcount`, but you decide to `ADD` the number
|
1949
|
+
# `3` to this attribute anyway. DynamoDB will create the `itemcount`
|
1950
1950
|
# attribute, set its initial value to `0`, and finally add `3` to
|
1951
|
-
# it. The result will be a new
|
1951
|
+
# it. The result will be a new `itemcount` attribute in the item,
|
1952
1952
|
# with a value of `3`.
|
1953
1953
|
#
|
1954
1954
|
# </note>
|
@@ -2003,7 +2003,7 @@ module Aws::DynamoDB
|
|
2003
2003
|
#
|
2004
2004
|
# * Logical operators: `AND | OR | NOT`
|
2005
2005
|
#
|
2006
|
-
# For more information
|
2006
|
+
# For more information about condition expressions, see [Specifying
|
2007
2007
|
# Conditions][1] in the *Amazon DynamoDB Developer Guide*.
|
2008
2008
|
#
|
2009
2009
|
#
|
@@ -2033,7 +2033,7 @@ module Aws::DynamoDB
|
|
2033
2033
|
# The name of this attribute conflicts with a reserved word, so it
|
2034
2034
|
# cannot be used directly in an expression. (For the complete list of
|
2035
2035
|
# reserved words, see [Reserved Words][1] in the *Amazon DynamoDB
|
2036
|
-
# Developer Guide
|
2036
|
+
# Developer Guide*.) To work around this, you could specify the
|
2037
2037
|
# following for `ExpressionAttributeNames`\:
|
2038
2038
|
#
|
2039
2039
|
# * `\{"#P":"Percentile"\}`
|
@@ -2052,7 +2052,7 @@ module Aws::DynamoDB
|
|
2052
2052
|
#
|
2053
2053
|
# </note>
|
2054
2054
|
#
|
2055
|
-
# For more information
|
2055
|
+
# For more information about expression attribute names, see [Specifying
|
2056
2056
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
2057
2057
|
#
|
2058
2058
|
#
|
@@ -2064,7 +2064,7 @@ module Aws::DynamoDB
|
|
2064
2064
|
#
|
2065
2065
|
# Use the **\:** (colon) character in an expression to dereference an
|
2066
2066
|
# attribute value. For example, suppose that you wanted to check whether
|
2067
|
-
# the value of the
|
2067
|
+
# the value of the `ProductStatus` attribute was one of the following:
|
2068
2068
|
#
|
2069
2069
|
# `Available | Backordered | Discontinued`
|
2070
2070
|
#
|
@@ -2078,8 +2078,8 @@ module Aws::DynamoDB
|
|
2078
2078
|
#
|
2079
2079
|
# `ProductStatus IN (:avail, :back, :disc)`
|
2080
2080
|
#
|
2081
|
-
# For more information on expression attribute values, see [
|
2082
|
-
#
|
2081
|
+
# For more information on expression attribute values, see [Condition
|
2082
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
2083
2083
|
#
|
2084
2084
|
#
|
2085
2085
|
#
|
@@ -785,8 +785,9 @@ module Aws::DynamoDB
|
|
785
785
|
#
|
786
786
|
# </note>
|
787
787
|
#
|
788
|
-
# For more information
|
789
|
-
# Item Attributes][2] in the *Amazon DynamoDB Developer
|
788
|
+
# For more information about expression attribute names, see
|
789
|
+
# [Accessing Item Attributes][2] in the *Amazon DynamoDB Developer
|
790
|
+
# Guide*.
|
790
791
|
#
|
791
792
|
# * `Keys` - An array of primary key attribute values that define
|
792
793
|
# specific items in the table. For each primary key, you must
|
@@ -800,9 +801,9 @@ module Aws::DynamoDB
|
|
800
801
|
# include scalars, sets, or elements of a JSON document. The
|
801
802
|
# attributes in the expression must be separated by commas.
|
802
803
|
#
|
803
|
-
# If no attribute names are specified, then all attributes
|
804
|
+
# If no attribute names are specified, then all attributes are
|
804
805
|
# returned. If any of the requested attributes are not found, they
|
805
|
-
#
|
806
|
+
# do not appear in the result.
|
806
807
|
#
|
807
808
|
# For more information, see [Accessing Item Attributes][2] in the
|
808
809
|
# *Amazon DynamoDB Developer Guide*.
|
@@ -952,7 +953,7 @@ module Aws::DynamoDB
|
|
952
953
|
# Attribute values must not be null; string and binary type
|
953
954
|
# attributes must have lengths greater than zero; and set type
|
954
955
|
# attributes must not be empty. Requests that contain empty values
|
955
|
-
#
|
956
|
+
# are rejected with a `ValidationException` exception.
|
956
957
|
#
|
957
958
|
# If you specify any attributes that are part of an index key,
|
958
959
|
# then the data types for those attributes must match those of the
|
@@ -1663,7 +1664,7 @@ module Aws::DynamoDB
|
|
1663
1664
|
# @return [String]
|
1664
1665
|
#
|
1665
1666
|
# @!attribute [rw] replication_group
|
1666
|
-
# The
|
1667
|
+
# The Regions where the global table needs to be created.
|
1667
1668
|
# @return [Array<Types::Replica>]
|
1668
1669
|
#
|
1669
1670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/CreateGlobalTableInput AWS API Documentation
|
@@ -1806,7 +1807,7 @@ module Aws::DynamoDB
|
|
1806
1807
|
# * `RANGE` - sort key
|
1807
1808
|
#
|
1808
1809
|
# <note markdown="1"> The partition key of an item is also known as its *hash attribute*.
|
1809
|
-
# The term "hash attribute" derives from DynamoDB
|
1810
|
+
# The term "hash attribute" derives from the DynamoDB usage of an
|
1810
1811
|
# internal hash function to evenly distribute data items across
|
1811
1812
|
# partitions, based on their partition key values.
|
1812
1813
|
#
|
@@ -1825,8 +1826,8 @@ module Aws::DynamoDB
|
|
1825
1826
|
# have a `KeyType` of `HASH`, and the second element must have a
|
1826
1827
|
# `KeyType` of `RANGE`.
|
1827
1828
|
#
|
1828
|
-
# For more information, see [
|
1829
|
-
#
|
1829
|
+
# For more information, see [Working with Tables][2] in the *Amazon
|
1830
|
+
# DynamoDB Developer Guide*.
|
1830
1831
|
#
|
1831
1832
|
#
|
1832
1833
|
#
|
@@ -1863,7 +1864,7 @@ module Aws::DynamoDB
|
|
1863
1864
|
# into the index.
|
1864
1865
|
#
|
1865
1866
|
# * `INCLUDE` - Only the specified table attributes are projected
|
1866
|
-
# into the index. The list of projected attributes
|
1867
|
+
# into the index. The list of projected attributes is in
|
1867
1868
|
# `NonKeyAttributes`.
|
1868
1869
|
#
|
1869
1870
|
# * `ALL` - All of the table attributes are projected into the
|
@@ -1902,7 +1903,7 @@ module Aws::DynamoDB
|
|
1902
1903
|
# into the index.
|
1903
1904
|
#
|
1904
1905
|
# * `INCLUDE` - Only the specified table attributes are projected
|
1905
|
-
# into the index. The list of projected attributes
|
1906
|
+
# into the index. The list of projected attributes is in
|
1906
1907
|
# `NonKeyAttributes`.
|
1907
1908
|
#
|
1908
1909
|
# * `ALL` - All of the table attributes are projected into the
|
@@ -1952,8 +1953,8 @@ module Aws::DynamoDB
|
|
1952
1953
|
# The settings for DynamoDB Streams on the table. These settings
|
1953
1954
|
# consist of:
|
1954
1955
|
#
|
1955
|
-
# * `StreamEnabled` - Indicates whether Streams is to be
|
1956
|
-
# (true) or disabled (false).
|
1956
|
+
# * `StreamEnabled` - Indicates whether DynamoDB Streams is to be
|
1957
|
+
# enabled (true) or disabled (false).
|
1957
1958
|
#
|
1958
1959
|
# * `StreamViewType` - When an item in the table is modified,
|
1959
1960
|
# `StreamViewType` determines what information is written to the
|
@@ -2252,8 +2253,8 @@ module Aws::DynamoDB
|
|
2252
2253
|
#
|
2253
2254
|
# * Logical operators: `AND | OR | NOT`
|
2254
2255
|
#
|
2255
|
-
# For more information
|
2256
|
-
#
|
2256
|
+
# For more information about condition expressions, see [Condition
|
2257
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
2257
2258
|
#
|
2258
2259
|
#
|
2259
2260
|
#
|
@@ -2304,7 +2305,7 @@ module Aws::DynamoDB
|
|
2304
2305
|
#
|
2305
2306
|
# </note>
|
2306
2307
|
#
|
2307
|
-
# For more information on expression attribute names, see [
|
2308
|
+
# For more information on expression attribute names, see [Specifying
|
2308
2309
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
2309
2310
|
#
|
2310
2311
|
#
|
@@ -2333,8 +2334,8 @@ module Aws::DynamoDB
|
|
2333
2334
|
#
|
2334
2335
|
# `ProductStatus IN (:avail, :back, :disc)`
|
2335
2336
|
#
|
2336
|
-
# For more information on expression attribute values, see [
|
2337
|
-
#
|
2337
|
+
# For more information on expression attribute values, see [Condition
|
2338
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
2338
2339
|
#
|
2339
2340
|
#
|
2340
2341
|
#
|
@@ -2372,7 +2373,7 @@ module Aws::DynamoDB
|
|
2372
2373
|
# with statistics for the table and any indexes involved in the
|
2373
2374
|
# operation. `ConsumedCapacity` is only returned if the
|
2374
2375
|
# `ReturnConsumedCapacity` parameter was specified. For more
|
2375
|
-
# information, see [Provisioned
|
2376
|
+
# information, see [Provisioned Mode][1] in the *Amazon DynamoDB
|
2376
2377
|
# Developer Guide*.
|
2377
2378
|
#
|
2378
2379
|
#
|
@@ -2500,7 +2501,7 @@ module Aws::DynamoDB
|
|
2500
2501
|
# }
|
2501
2502
|
#
|
2502
2503
|
# @!attribute [rw] backup_arn
|
2503
|
-
# The ARN associated with the backup.
|
2504
|
+
# The Amazon Resource Name (ARN) associated with the backup.
|
2504
2505
|
# @return [String]
|
2505
2506
|
#
|
2506
2507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeBackupInput AWS API Documentation
|
@@ -2621,7 +2622,7 @@ module Aws::DynamoDB
|
|
2621
2622
|
# @return [String]
|
2622
2623
|
#
|
2623
2624
|
# @!attribute [rw] replica_settings
|
2624
|
-
# The
|
2625
|
+
# The Region-specific settings for the global table.
|
2625
2626
|
# @return [Array<Types::ReplicaSettingsDescription>]
|
2626
2627
|
#
|
2627
2628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/DescribeGlobalTableSettingsOutput AWS API Documentation
|
@@ -2644,24 +2645,24 @@ module Aws::DynamoDB
|
|
2644
2645
|
#
|
2645
2646
|
# @!attribute [rw] account_max_read_capacity_units
|
2646
2647
|
# The maximum total read capacity units that your account allows you
|
2647
|
-
# to provision across all of your tables in this
|
2648
|
+
# to provision across all of your tables in this Region.
|
2648
2649
|
# @return [Integer]
|
2649
2650
|
#
|
2650
2651
|
# @!attribute [rw] account_max_write_capacity_units
|
2651
2652
|
# The maximum total write capacity units that your account allows you
|
2652
|
-
# to provision across all of your tables in this
|
2653
|
+
# to provision across all of your tables in this Region.
|
2653
2654
|
# @return [Integer]
|
2654
2655
|
#
|
2655
2656
|
# @!attribute [rw] table_max_read_capacity_units
|
2656
2657
|
# The maximum read capacity units that your account allows you to
|
2657
|
-
# provision for a new table that you are creating in this
|
2658
|
+
# provision for a new table that you are creating in this Region,
|
2658
2659
|
# including the read capacity units provisioned for its global
|
2659
2660
|
# secondary indexes (GSIs).
|
2660
2661
|
# @return [Integer]
|
2661
2662
|
#
|
2662
2663
|
# @!attribute [rw] table_max_write_capacity_units
|
2663
2664
|
# The maximum write capacity units that your account allows you to
|
2664
|
-
# provision for a new table that you are creating in this
|
2665
|
+
# provision for a new table that you are creating in this Region,
|
2665
2666
|
# including the write capacity units provisioned for its global
|
2666
2667
|
# secondary indexes (GSIs).
|
2667
2668
|
# @return [Integer]
|
@@ -3157,11 +3158,11 @@ module Aws::DynamoDB
|
|
3157
3158
|
# JSON document. The attributes in the expression must be separated by
|
3158
3159
|
# commas.
|
3159
3160
|
#
|
3160
|
-
# If no attribute names are specified, then all attributes
|
3161
|
-
# returned. If any of the requested attributes are not found, they
|
3162
|
-
#
|
3161
|
+
# If no attribute names are specified, then all attributes are
|
3162
|
+
# returned. If any of the requested attributes are not found, they do
|
3163
|
+
# not appear in the result.
|
3163
3164
|
#
|
3164
|
-
# For more information, see [
|
3165
|
+
# For more information, see [Specifying Item Attributes][1] in the
|
3165
3166
|
# *Amazon DynamoDB Developer Guide*.
|
3166
3167
|
#
|
3167
3168
|
#
|
@@ -3213,7 +3214,7 @@ module Aws::DynamoDB
|
|
3213
3214
|
#
|
3214
3215
|
# </note>
|
3215
3216
|
#
|
3216
|
-
# For more information on expression attribute names, see [
|
3217
|
+
# For more information on expression attribute names, see [Specifying
|
3217
3218
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
3218
3219
|
#
|
3219
3220
|
#
|
@@ -3248,8 +3249,8 @@ module Aws::DynamoDB
|
|
3248
3249
|
# with statistics for the table and any indexes involved in the
|
3249
3250
|
# operation. `ConsumedCapacity` is only returned if the
|
3250
3251
|
# `ReturnConsumedCapacity` parameter was specified. For more
|
3251
|
-
# information, see [
|
3252
|
-
# Developer Guide*.
|
3252
|
+
# information, see [Read/Write Capacity Mode][1] in the *Amazon
|
3253
|
+
# DynamoDB Developer Guide*.
|
3253
3254
|
#
|
3254
3255
|
#
|
3255
3256
|
#
|
@@ -4056,11 +4057,11 @@ module Aws::DynamoDB
|
|
4056
4057
|
# @return [Time]
|
4057
4058
|
#
|
4058
4059
|
# @!attribute [rw] exclusive_start_backup_arn
|
4059
|
-
# `LastEvaluatedBackupArn` is the ARN of the
|
4060
|
-
# when the current page of results was returned,
|
4061
|
-
# current page of results. This value may be
|
4062
|
-
# `ExclusiveStartBackupArn` of a new `ListBackups`
|
4063
|
-
# to fetch the next page of results.
|
4060
|
+
# `LastEvaluatedBackupArn` is the Amazon Resource Name (ARN) of the
|
4061
|
+
# backup last evaluated when the current page of results was returned,
|
4062
|
+
# inclusive of the current page of results. This value may be
|
4063
|
+
# specified as the `ExclusiveStartBackupArn` of a new `ListBackups`
|
4064
|
+
# operation in order to fetch the next page of results.
|
4064
4065
|
# @return [String]
|
4065
4066
|
#
|
4066
4067
|
# @!attribute [rw] backup_type
|
@@ -4101,7 +4102,7 @@ module Aws::DynamoDB
|
|
4101
4102
|
# has been processed and there are no more results to be retrieved.
|
4102
4103
|
#
|
4103
4104
|
# If `LastEvaluatedBackupArn` is not empty, this may or may not
|
4104
|
-
# indicate there is more data to be returned. All results are
|
4105
|
+
# indicate that there is more data to be returned. All results are
|
4105
4106
|
# guaranteed to have been returned if and only if no value for
|
4106
4107
|
# `LastEvaluatedBackupArn` is returned.
|
4107
4108
|
# @return [String]
|
@@ -4132,7 +4133,7 @@ module Aws::DynamoDB
|
|
4132
4133
|
# @return [Integer]
|
4133
4134
|
#
|
4134
4135
|
# @!attribute [rw] region_name
|
4135
|
-
# Lists the global tables in a specific
|
4136
|
+
# Lists the global tables in a specific Region.
|
4136
4137
|
# @return [String]
|
4137
4138
|
#
|
4138
4139
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/ListGlobalTablesInput AWS API Documentation
|
@@ -4786,7 +4787,7 @@ module Aws::DynamoDB
|
|
4786
4787
|
#
|
4787
4788
|
#
|
4788
4789
|
#
|
4789
|
-
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/
|
4790
|
+
# [1]: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.CoreComponents.html#HowItWorks.CoreComponents.PrimaryKey
|
4790
4791
|
# @return [Hash<String,Types::AttributeValue>]
|
4791
4792
|
#
|
4792
4793
|
# @!attribute [rw] expected
|
@@ -4871,8 +4872,8 @@ module Aws::DynamoDB
|
|
4871
4872
|
#
|
4872
4873
|
# * Logical operators: `AND | OR | NOT`
|
4873
4874
|
#
|
4874
|
-
# For more information on condition expressions, see [
|
4875
|
-
#
|
4875
|
+
# For more information on condition expressions, see [Condition
|
4876
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
4876
4877
|
#
|
4877
4878
|
#
|
4878
4879
|
#
|
@@ -4923,7 +4924,7 @@ module Aws::DynamoDB
|
|
4923
4924
|
#
|
4924
4925
|
# </note>
|
4925
4926
|
#
|
4926
|
-
# For more information on expression attribute names, see [
|
4927
|
+
# For more information on expression attribute names, see [Specifying
|
4927
4928
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
4928
4929
|
#
|
4929
4930
|
#
|
@@ -4952,8 +4953,8 @@ module Aws::DynamoDB
|
|
4952
4953
|
#
|
4953
4954
|
# `ProductStatus IN (:avail, :back, :disc)`
|
4954
4955
|
#
|
4955
|
-
# For more information on expression attribute values, see [
|
4956
|
-
#
|
4956
|
+
# For more information on expression attribute values, see [Condition
|
4957
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
4957
4958
|
#
|
4958
4959
|
#
|
4959
4960
|
#
|
@@ -4991,8 +4992,8 @@ module Aws::DynamoDB
|
|
4991
4992
|
# with statistics for the table and any indexes involved in the
|
4992
4993
|
# operation. `ConsumedCapacity` is only returned if the
|
4993
4994
|
# `ReturnConsumedCapacity` parameter was specified. For more
|
4994
|
-
# information, see [
|
4995
|
-
# Developer Guide*.
|
4995
|
+
# information, see [Read/Write Capacity Mode][1] in the *Amazon
|
4996
|
+
# DynamoDB Developer Guide*.
|
4996
4997
|
#
|
4997
4998
|
#
|
4998
4999
|
#
|
@@ -5119,7 +5120,7 @@ module Aws::DynamoDB
|
|
5119
5120
|
#
|
5120
5121
|
# * `ALL_ATTRIBUTES` - Returns all of the item attributes from the
|
5121
5122
|
# specified table or index. If you query a local secondary index,
|
5122
|
-
# then for each matching item in the index DynamoDB
|
5123
|
+
# then for each matching item in the index, DynamoDB fetches the
|
5123
5124
|
# entire item from the parent table. If the index is configured to
|
5124
5125
|
# project all item attributes, then all of the data can be obtained
|
5125
5126
|
# from the local secondary index, and no fetching is required.
|
@@ -5140,9 +5141,8 @@ module Aws::DynamoDB
|
|
5140
5141
|
# attributes that are projected into that index, the operation will
|
5141
5142
|
# read only the index and not the table. If any of the requested
|
5142
5143
|
# attributes are not projected into the local secondary index,
|
5143
|
-
# DynamoDB
|
5144
|
-
#
|
5145
|
-
# latency.
|
5144
|
+
# DynamoDB fetches each of these attributes from the parent table.
|
5145
|
+
# This extra fetching incurs additional throughput cost and latency.
|
5146
5146
|
#
|
5147
5147
|
# If you query or scan a global secondary index, you can only
|
5148
5148
|
# request attributes that are projected into the index. Global
|
@@ -5180,7 +5180,7 @@ module Aws::DynamoDB
|
|
5180
5180
|
# the limit while processing the results, it stops the operation and
|
5181
5181
|
# returns the matching values up to that point, and a key in
|
5182
5182
|
# `LastEvaluatedKey` to apply in a subsequent operation, so that you
|
5183
|
-
# can pick up where you left off. Also, if the processed
|
5183
|
+
# can pick up where you left off. Also, if the processed dataset size
|
5184
5184
|
# exceeds 1 MB before DynamoDB reaches this limit, it stops the
|
5185
5185
|
# operation and returns the matching values up to the limit, and a key
|
5186
5186
|
# in `LastEvaluatedKey` to apply in a subsequent operation to continue
|
@@ -5255,7 +5255,7 @@ module Aws::DynamoDB
|
|
5255
5255
|
# Use the value that was returned for `LastEvaluatedKey` in the
|
5256
5256
|
# previous operation.
|
5257
5257
|
#
|
5258
|
-
# The data type for `ExclusiveStartKey` must be String, Number or
|
5258
|
+
# The data type for `ExclusiveStartKey` must be String, Number, or
|
5259
5259
|
# Binary. No set data types are allowed.
|
5260
5260
|
# @return [Hash<String,Types::AttributeValue>]
|
5261
5261
|
#
|
@@ -5321,7 +5321,7 @@ module Aws::DynamoDB
|
|
5321
5321
|
# @return [String]
|
5322
5322
|
#
|
5323
5323
|
# @!attribute [rw] key_condition_expression
|
5324
|
-
# The condition that specifies the key
|
5324
|
+
# The condition that specifies the key values for items to be
|
5325
5325
|
# retrieved by the `Query` action.
|
5326
5326
|
#
|
5327
5327
|
# The condition must perform an equality test on a single partition
|
@@ -5450,7 +5450,7 @@ module Aws::DynamoDB
|
|
5450
5450
|
#
|
5451
5451
|
# </note>
|
5452
5452
|
#
|
5453
|
-
# For more information on expression attribute names, see [
|
5453
|
+
# For more information on expression attribute names, see [Specifying
|
5454
5454
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
5455
5455
|
#
|
5456
5456
|
#
|
@@ -5564,7 +5564,7 @@ module Aws::DynamoDB
|
|
5564
5564
|
# returned includes the total provisioned throughput consumed, along
|
5565
5565
|
# with statistics for the table and any indexes involved in the
|
5566
5566
|
# operation. `ConsumedCapacity` is only returned if the
|
5567
|
-
# `ReturnConsumedCapacity` parameter was specified For more
|
5567
|
+
# `ReturnConsumedCapacity` parameter was specified. For more
|
5568
5568
|
# information, see [Provisioned Throughput][1] in the *Amazon DynamoDB
|
5569
5569
|
# Developer Guide*.
|
5570
5570
|
#
|
@@ -6022,7 +6022,7 @@ module Aws::DynamoDB
|
|
6022
6022
|
# @return [String]
|
6023
6023
|
#
|
6024
6024
|
# @!attribute [rw] backup_arn
|
6025
|
-
# The ARN associated with the backup.
|
6025
|
+
# The Amazon Resource Name (ARN) associated with the backup.
|
6026
6026
|
# @return [String]
|
6027
6027
|
#
|
6028
6028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/RestoreTableFromBackupInput AWS API Documentation
|
@@ -6237,12 +6237,12 @@ module Aws::DynamoDB
|
|
6237
6237
|
# the limit while processing the results, it stops the operation and
|
6238
6238
|
# returns the matching values up to that point, and a key in
|
6239
6239
|
# `LastEvaluatedKey` to apply in a subsequent operation, so that you
|
6240
|
-
# can pick up where you left off. Also, if the processed
|
6240
|
+
# can pick up where you left off. Also, if the processed dataset size
|
6241
6241
|
# exceeds 1 MB before DynamoDB reaches this limit, it stops the
|
6242
6242
|
# operation and returns the matching values up to the limit, and a key
|
6243
6243
|
# in `LastEvaluatedKey` to apply in a subsequent operation to continue
|
6244
|
-
# the operation. For more information, see [
|
6245
|
-
# *Amazon DynamoDB Developer Guide*.
|
6244
|
+
# the operation. For more information, see [Working with Queries][1]
|
6245
|
+
# in the *Amazon DynamoDB Developer Guide*.
|
6246
6246
|
#
|
6247
6247
|
#
|
6248
6248
|
#
|
@@ -6257,7 +6257,7 @@ module Aws::DynamoDB
|
|
6257
6257
|
#
|
6258
6258
|
# * `ALL_ATTRIBUTES` - Returns all of the item attributes from the
|
6259
6259
|
# specified table or index. If you query a local secondary index,
|
6260
|
-
# then for each matching item in the index DynamoDB
|
6260
|
+
# then for each matching item in the index, DynamoDB fetches the
|
6261
6261
|
# entire item from the parent table. If the index is configured to
|
6262
6262
|
# project all item attributes, then all of the data can be obtained
|
6263
6263
|
# from the local secondary index, and no fetching is required.
|
@@ -6275,12 +6275,11 @@ module Aws::DynamoDB
|
|
6275
6275
|
# `AttributesToGet` without specifying any value for `Select`.
|
6276
6276
|
#
|
6277
6277
|
# If you query or scan a local secondary index and request only
|
6278
|
-
# attributes that are projected into that index, the operation
|
6279
|
-
#
|
6278
|
+
# attributes that are projected into that index, the operation reads
|
6279
|
+
# only the index and not the table. If any of the requested
|
6280
6280
|
# attributes are not projected into the local secondary index,
|
6281
|
-
# DynamoDB
|
6282
|
-
#
|
6283
|
-
# latency.
|
6281
|
+
# DynamoDB fetches each of these attributes from the parent table.
|
6282
|
+
# This extra fetching incurs additional throughput cost and latency.
|
6284
6283
|
#
|
6285
6284
|
# If you query or scan a global secondary index, you can only
|
6286
6285
|
# request attributes that are projected into the index. Global
|
@@ -6400,7 +6399,7 @@ module Aws::DynamoDB
|
|
6400
6399
|
# returned. If any of the requested attributes are not found, they
|
6401
6400
|
# will not appear in the result.
|
6402
6401
|
#
|
6403
|
-
# For more information, see [
|
6402
|
+
# For more information, see [Specifying Item Attributes][1] in the
|
6404
6403
|
# *Amazon DynamoDB Developer Guide*.
|
6405
6404
|
#
|
6406
6405
|
#
|
@@ -6471,7 +6470,7 @@ module Aws::DynamoDB
|
|
6471
6470
|
#
|
6472
6471
|
# </note>
|
6473
6472
|
#
|
6474
|
-
# For more information on expression attribute names, see [
|
6473
|
+
# For more information on expression attribute names, see [Specifying
|
6475
6474
|
# Item Attributes][2] in the *Amazon DynamoDB Developer Guide*.
|
6476
6475
|
#
|
6477
6476
|
#
|
@@ -6485,7 +6484,7 @@ module Aws::DynamoDB
|
|
6485
6484
|
#
|
6486
6485
|
# Use the **\:** (colon) character in an expression to dereference an
|
6487
6486
|
# attribute value. For example, suppose that you wanted to check
|
6488
|
-
# whether the value of the
|
6487
|
+
# whether the value of the `ProductStatus` attribute was one of the
|
6489
6488
|
# following:
|
6490
6489
|
#
|
6491
6490
|
# `Available | Backordered | Discontinued`
|
@@ -6500,8 +6499,8 @@ module Aws::DynamoDB
|
|
6500
6499
|
#
|
6501
6500
|
# `ProductStatus IN (:avail, :back, :disc)`
|
6502
6501
|
#
|
6503
|
-
# For more information on expression attribute values, see [
|
6504
|
-
#
|
6502
|
+
# For more information on expression attribute values, see [Condition
|
6503
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
6505
6504
|
#
|
6506
6505
|
#
|
6507
6506
|
#
|
@@ -6514,7 +6513,7 @@ module Aws::DynamoDB
|
|
6514
6513
|
#
|
6515
6514
|
# * If `ConsistentRead` is `false`, then the data returned from `Scan`
|
6516
6515
|
# might not contain the results from other recently completed write
|
6517
|
-
# operations (PutItem
|
6516
|
+
# operations (`PutItem`, `UpdateItem`, or `DeleteItem`).
|
6518
6517
|
#
|
6519
6518
|
# * If `ConsistentRead` is `true`, then all of the write operations
|
6520
6519
|
# that completed before the `Scan` began are guaranteed to be
|
@@ -6808,7 +6807,7 @@ module Aws::DynamoDB
|
|
6808
6807
|
# * `RANGE` - sort key
|
6809
6808
|
#
|
6810
6809
|
# <note markdown="1"> The partition key of an item is also known as its *hash
|
6811
|
-
# attribute*. The term "hash attribute" derives from DynamoDB'
|
6810
|
+
# attribute*. The term "hash attribute" derives from DynamoDB's
|
6812
6811
|
# usage of an internal hash function to evenly distribute data items
|
6813
6812
|
# across partitions, based on their partition key values.
|
6814
6813
|
#
|
@@ -7084,11 +7083,11 @@ module Aws::DynamoDB
|
|
7084
7083
|
# Describes a tag. A tag is a key-value pair. You can add up to 50 tags
|
7085
7084
|
# to a single DynamoDB table.
|
7086
7085
|
#
|
7087
|
-
# AWS-assigned tag names and values are automatically assigned the
|
7088
|
-
# prefix, which the user cannot assign. AWS-assigned tag names do
|
7089
|
-
# count towards the tag limit of 50. User-assigned tag names have
|
7090
|
-
# prefix user
|
7091
|
-
# application of a tag.
|
7086
|
+
# AWS-assigned tag names and values are automatically assigned the
|
7087
|
+
# `aws:` prefix, which the user cannot assign. AWS-assigned tag names do
|
7088
|
+
# not count towards the tag limit of 50. User-assigned tag names have
|
7089
|
+
# the prefix `user:` in the Cost Allocation Report. You cannot backdate
|
7090
|
+
# the application of a tag.
|
7092
7091
|
#
|
7093
7092
|
# For an overview on tagging DynamoDB resources, see [Tagging for
|
7094
7093
|
# DynamoDB][1] in the *Amazon DynamoDB Developer Guide*.
|
@@ -7106,7 +7105,7 @@ module Aws::DynamoDB
|
|
7106
7105
|
# }
|
7107
7106
|
#
|
7108
7107
|
# @!attribute [rw] key
|
7109
|
-
# The key of the tag.Tag keys are case sensitive. Each DynamoDB table
|
7108
|
+
# The key of the tag. Tag keys are case sensitive. Each DynamoDB table
|
7110
7109
|
# can only have up to one tag with the same key. If you try to add an
|
7111
7110
|
# existing tag (same key), the existing tag value will be updated to
|
7112
7111
|
# the new value.
|
@@ -7158,11 +7157,11 @@ module Aws::DynamoDB
|
|
7158
7157
|
# table.
|
7159
7158
|
#
|
7160
7159
|
# @!attribute [rw] time_to_live_status
|
7161
|
-
# The
|
7160
|
+
# The TTL status for the table.
|
7162
7161
|
# @return [String]
|
7163
7162
|
#
|
7164
7163
|
# @!attribute [rw] attribute_name
|
7165
|
-
# The name of the
|
7164
|
+
# The name of the TTL attribute for items in the table.
|
7166
7165
|
# @return [String]
|
7167
7166
|
#
|
7168
7167
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TimeToLiveDescription AWS API Documentation
|
@@ -7173,8 +7172,8 @@ module Aws::DynamoDB
|
|
7173
7172
|
include Aws::Structure
|
7174
7173
|
end
|
7175
7174
|
|
7176
|
-
# Represents the settings used to enable or disable Time to Live
|
7177
|
-
# specified table.
|
7175
|
+
# Represents the settings used to enable or disable Time to Live (TTL)
|
7176
|
+
# for the specified table.
|
7178
7177
|
#
|
7179
7178
|
# @note When making an API call, you may pass TimeToLiveSpecification
|
7180
7179
|
# data as a hash:
|
@@ -7185,13 +7184,13 @@ module Aws::DynamoDB
|
|
7185
7184
|
# }
|
7186
7185
|
#
|
7187
7186
|
# @!attribute [rw] enabled
|
7188
|
-
# Indicates whether
|
7189
|
-
#
|
7187
|
+
# Indicates whether TTL is to be enabled (true) or disabled (false) on
|
7188
|
+
# the table.
|
7190
7189
|
# @return [Boolean]
|
7191
7190
|
#
|
7192
7191
|
# @!attribute [rw] attribute_name
|
7193
|
-
# The name of the
|
7194
|
-
#
|
7192
|
+
# The name of the TTL attribute used to store the expiration time for
|
7193
|
+
# items in the table.
|
7195
7194
|
# @return [String]
|
7196
7195
|
#
|
7197
7196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/TimeToLiveSpecification AWS API Documentation
|
@@ -7255,7 +7254,7 @@ module Aws::DynamoDB
|
|
7255
7254
|
# }
|
7256
7255
|
#
|
7257
7256
|
# @!attribute [rw] transact_items
|
7258
|
-
# An ordered array of up to
|
7257
|
+
# An ordered array of up to 25 `TransactGetItem` objects, each of
|
7259
7258
|
# which contains a `Get` structure.
|
7260
7259
|
# @return [Array<Types::TransactGetItem>]
|
7261
7260
|
#
|
@@ -7282,7 +7281,7 @@ module Aws::DynamoDB
|
|
7282
7281
|
# @return [Array<Types::ConsumedCapacity>]
|
7283
7282
|
#
|
7284
7283
|
# @!attribute [rw] responses
|
7285
|
-
# An ordered array of up to
|
7284
|
+
# An ordered array of up to 25 `ItemResponse` objects, each of which
|
7286
7285
|
# corresponds to the `TransactGetItem` object in the same position in
|
7287
7286
|
# the *TransactItems* array. Each `ItemResponse` object contains a Map
|
7288
7287
|
# of the name-value pairs that are the projected attributes of the
|
@@ -7465,10 +7464,10 @@ module Aws::DynamoDB
|
|
7465
7464
|
# }
|
7466
7465
|
#
|
7467
7466
|
# @!attribute [rw] transact_items
|
7468
|
-
# An ordered array of up to
|
7467
|
+
# An ordered array of up to 25 `TransactWriteItem` objects, each of
|
7469
7468
|
# which contains a `ConditionCheck`, `Put`, `Update`, or `Delete`
|
7470
7469
|
# object. These can operate on items in different tables, but the
|
7471
|
-
# tables must reside in the same AWS account and
|
7470
|
+
# tables must reside in the same AWS account and Region, and no two of
|
7472
7471
|
# them can operate on the same item.
|
7473
7472
|
# @return [Array<Types::TransactWriteItem>]
|
7474
7473
|
#
|
@@ -7507,21 +7506,21 @@ module Aws::DynamoDB
|
|
7507
7506
|
#
|
7508
7507
|
# Although multiple identical calls using the same client request
|
7509
7508
|
# token produce the same result on the server (no side effects), the
|
7510
|
-
# responses to the calls
|
7509
|
+
# responses to the calls might not be the same. If the
|
7511
7510
|
# `ReturnConsumedCapacity>` parameter is set, then the initial
|
7512
7511
|
# `TransactWriteItems` call returns the amount of write capacity units
|
7513
|
-
# consumed in making the changes
|
7514
|
-
# calls with the same client token return the
|
7512
|
+
# consumed in making the changes. Subsequent `TransactWriteItems`
|
7513
|
+
# calls with the same client token return the number of read capacity
|
7515
7514
|
# units consumed in reading the item.
|
7516
7515
|
#
|
7517
7516
|
# A client request token is valid for 10 minutes after the first
|
7518
|
-
# request that uses it
|
7519
|
-
# the same client token is treated as a new request. Do not
|
7520
|
-
# the same request with the same client token for more than
|
7521
|
-
# or the result
|
7517
|
+
# request that uses it is completed. After 10 minutes, any request
|
7518
|
+
# with the same client token is treated as a new request. Do not
|
7519
|
+
# resubmit the same request with the same client token for more than
|
7520
|
+
# 10 minutes, or the result might not be idempotent.
|
7522
7521
|
#
|
7523
7522
|
# If you submit a request with the same client token but a change in
|
7524
|
-
# other parameters within the 10
|
7523
|
+
# other parameters within the 10-minute idempotency window, DynamoDB
|
7525
7524
|
# returns an `IdempotentParameterMismatch` exception.
|
7526
7525
|
#
|
7527
7526
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -7547,7 +7546,7 @@ module Aws::DynamoDB
|
|
7547
7546
|
# @!attribute [rw] item_collection_metrics
|
7548
7547
|
# A list of tables that were processed by `TransactWriteItems` and,
|
7549
7548
|
# for each table, information about any item collections that were
|
7550
|
-
# affected by individual `UpdateItem`, `PutItem
|
7549
|
+
# affected by individual `UpdateItem`, `PutItem`, or `DeleteItem`
|
7551
7550
|
# operations.
|
7552
7551
|
# @return [Hash<String,Array<Types::ItemCollectionMetrics>>]
|
7553
7552
|
#
|
@@ -7579,6 +7578,8 @@ module Aws::DynamoDB
|
|
7579
7578
|
# secondary index (LSI) becomes too large, or a similar validation
|
7580
7579
|
# error occurs because of changes made by the transaction.
|
7581
7580
|
#
|
7581
|
+
# * The aggregate size of the items in the transaction exceeds 4 MBs.
|
7582
|
+
#
|
7582
7583
|
# * There is a user error, such as an invalid data format.
|
7583
7584
|
#
|
7584
7585
|
# DynamoDB cancels a `TransactGetItems` request under the following
|
@@ -7595,6 +7596,8 @@ module Aws::DynamoDB
|
|
7595
7596
|
# * There is insufficient provisioned capacity for the transaction to be
|
7596
7597
|
# completed.
|
7597
7598
|
#
|
7599
|
+
# * The aggregate size of the items in the transaction exceeds 4 MBs.
|
7600
|
+
#
|
7598
7601
|
# * There is a user error, such as an invalid data format.
|
7599
7602
|
#
|
7600
7603
|
# <note markdown="1"> If using Java, DynamoDB lists the cancellation reasons on the
|
@@ -7762,14 +7765,13 @@ module Aws::DynamoDB
|
|
7762
7765
|
# }
|
7763
7766
|
#
|
7764
7767
|
# @!attribute [rw] resource_arn
|
7765
|
-
# The
|
7766
|
-
#
|
7768
|
+
# The DynamoDB resource that the tags will be removed from. This value
|
7769
|
+
# is an Amazon Resource Name (ARN).
|
7767
7770
|
# @return [String]
|
7768
7771
|
#
|
7769
7772
|
# @!attribute [rw] tag_keys
|
7770
7773
|
# A list of tag keys. Existing tags of the resource whose keys are
|
7771
|
-
# members of this list will be removed from the
|
7772
|
-
# resource.
|
7774
|
+
# members of this list will be removed from the DynamoDB resource.
|
7773
7775
|
# @return [Array<String>]
|
7774
7776
|
#
|
7775
7777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UntagResourceInput AWS API Documentation
|
@@ -7947,7 +7949,7 @@ module Aws::DynamoDB
|
|
7947
7949
|
# @return [String]
|
7948
7950
|
#
|
7949
7951
|
# @!attribute [rw] replica_updates
|
7950
|
-
# A list of
|
7952
|
+
# A list of Regions that should be added or removed from the global
|
7951
7953
|
# table.
|
7952
7954
|
# @return [Array<Types::ReplicaUpdate>]
|
7953
7955
|
#
|
@@ -8073,8 +8075,8 @@ module Aws::DynamoDB
|
|
8073
8075
|
# @return [Integer]
|
8074
8076
|
#
|
8075
8077
|
# @!attribute [rw] global_table_provisioned_write_capacity_auto_scaling_settings_update
|
8076
|
-
#
|
8077
|
-
# global table.
|
8078
|
+
# Auto scaling settings for managing provisioned write capacity for
|
8079
|
+
# the global table.
|
8078
8080
|
# @return [Types::AutoScalingSettingsUpdate]
|
8079
8081
|
#
|
8080
8082
|
# @!attribute [rw] global_table_global_secondary_index_settings_update
|
@@ -8083,7 +8085,7 @@ module Aws::DynamoDB
|
|
8083
8085
|
# @return [Array<Types::GlobalTableGlobalSecondaryIndexSettingsUpdate>]
|
8084
8086
|
#
|
8085
8087
|
# @!attribute [rw] replica_settings_update
|
8086
|
-
# Represents the settings for a global table in a
|
8088
|
+
# Represents the settings for a global table in a Region that will be
|
8087
8089
|
# modified.
|
8088
8090
|
# @return [Array<Types::ReplicaSettingsUpdate>]
|
8089
8091
|
#
|
@@ -8104,7 +8106,7 @@ module Aws::DynamoDB
|
|
8104
8106
|
# @return [String]
|
8105
8107
|
#
|
8106
8108
|
# @!attribute [rw] replica_settings
|
8107
|
-
# The
|
8109
|
+
# The Region-specific settings for the global table.
|
8108
8110
|
# @return [Array<Types::ReplicaSettingsDescription>]
|
8109
8111
|
#
|
8110
8112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dynamodb-2012-08-10/UpdateGlobalTableSettingsOutput AWS API Documentation
|
@@ -8255,12 +8257,12 @@ module Aws::DynamoDB
|
|
8255
8257
|
#
|
8256
8258
|
# @!attribute [rw] update_expression
|
8257
8259
|
# An expression that defines one or more attributes to be updated, the
|
8258
|
-
# action to be performed on them, and new
|
8260
|
+
# action to be performed on them, and new values for them.
|
8259
8261
|
#
|
8260
8262
|
# The following action values are available for `UpdateExpression`.
|
8261
8263
|
#
|
8262
8264
|
# * `SET` - Adds one or more attributes and values to an item. If any
|
8263
|
-
# of these
|
8265
|
+
# of these attributes already exist, they are replaced by the new
|
8264
8266
|
# values. You can also use `SET` to add or subtract from an
|
8265
8267
|
# attribute that is of type Number. For example: `SET myNum = myNum
|
8266
8268
|
# + :val`
|
@@ -8299,10 +8301,10 @@ module Aws::DynamoDB
|
|
8299
8301
|
# decrement an attribute value that doesn't exist before the
|
8300
8302
|
# update, DynamoDB uses `0` as the initial value. For example,
|
8301
8303
|
# suppose that the item you want to update doesn't have an
|
8302
|
-
# attribute named
|
8304
|
+
# attribute named `itemcount`, but you decide to `ADD` the number
|
8303
8305
|
# `3` to this attribute anyway. DynamoDB will create the
|
8304
|
-
#
|
8305
|
-
# add `3` to it. The result will be a new
|
8306
|
+
# `itemcount` attribute, set its initial value to `0`, and finally
|
8307
|
+
# add `3` to it. The result will be a new `itemcount` attribute in
|
8306
8308
|
# the item, with a value of `3`.
|
8307
8309
|
#
|
8308
8310
|
# </note>
|
@@ -8362,7 +8364,7 @@ module Aws::DynamoDB
|
|
8362
8364
|
#
|
8363
8365
|
# * Logical operators: `AND | OR | NOT`
|
8364
8366
|
#
|
8365
|
-
# For more information
|
8367
|
+
# For more information about condition expressions, see [Specifying
|
8366
8368
|
# Conditions][1] in the *Amazon DynamoDB Developer Guide*.
|
8367
8369
|
#
|
8368
8370
|
#
|
@@ -8394,7 +8396,7 @@ module Aws::DynamoDB
|
|
8394
8396
|
# The name of this attribute conflicts with a reserved word, so it
|
8395
8397
|
# cannot be used directly in an expression. (For the complete list of
|
8396
8398
|
# reserved words, see [Reserved Words][1] in the *Amazon DynamoDB
|
8397
|
-
# Developer Guide
|
8399
|
+
# Developer Guide*.) To work around this, you could specify the
|
8398
8400
|
# following for `ExpressionAttributeNames`\:
|
8399
8401
|
#
|
8400
8402
|
# * `\{"#P":"Percentile"\}`
|
@@ -8414,8 +8416,9 @@ module Aws::DynamoDB
|
|
8414
8416
|
#
|
8415
8417
|
# </note>
|
8416
8418
|
#
|
8417
|
-
# For more information
|
8418
|
-
# Item Attributes][2] in the *Amazon DynamoDB Developer
|
8419
|
+
# For more information about expression attribute names, see
|
8420
|
+
# [Specifying Item Attributes][2] in the *Amazon DynamoDB Developer
|
8421
|
+
# Guide*.
|
8419
8422
|
#
|
8420
8423
|
#
|
8421
8424
|
#
|
@@ -8428,7 +8431,7 @@ module Aws::DynamoDB
|
|
8428
8431
|
#
|
8429
8432
|
# Use the **\:** (colon) character in an expression to dereference an
|
8430
8433
|
# attribute value. For example, suppose that you wanted to check
|
8431
|
-
# whether the value of the
|
8434
|
+
# whether the value of the `ProductStatus` attribute was one of the
|
8432
8435
|
# following:
|
8433
8436
|
#
|
8434
8437
|
# `Available | Backordered | Discontinued`
|
@@ -8443,8 +8446,8 @@ module Aws::DynamoDB
|
|
8443
8446
|
#
|
8444
8447
|
# `ProductStatus IN (:avail, :back, :disc)`
|
8445
8448
|
#
|
8446
|
-
# For more information on expression attribute values, see [
|
8447
|
-
#
|
8449
|
+
# For more information on expression attribute values, see [Condition
|
8450
|
+
# Expressions][1] in the *Amazon DynamoDB Developer Guide*.
|
8448
8451
|
#
|
8449
8452
|
#
|
8450
8453
|
#
|
@@ -8642,9 +8645,9 @@ module Aws::DynamoDB
|
|
8642
8645
|
# @!attribute [rw] stream_specification
|
8643
8646
|
# Represents the DynamoDB Streams configuration for the table.
|
8644
8647
|
#
|
8645
|
-
# <note markdown="1"> You
|
8646
|
-
#
|
8647
|
-
#
|
8648
|
+
# <note markdown="1"> You receive a `ResourceInUseException` if you try to enable a stream
|
8649
|
+
# on a table that already has a stream, or if you try to disable a
|
8650
|
+
# stream on a table that doesn't have a stream.
|
8648
8651
|
#
|
8649
8652
|
# </note>
|
8650
8653
|
# @return [Types::StreamSpecification]
|