String s
String n
ByteBuffer b
com.amazonaws.internal.ListWithAutoConstructFlag<T> sS
com.amazonaws.internal.ListWithAutoConstructFlag<T> nS
com.amazonaws.internal.ListWithAutoConstructFlag<T> bS
Map<K,V> m
com.amazonaws.internal.ListWithAutoConstructFlag<T> l
Boolean nULL
Boolean bOOL
AttributeValue value
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
String action
PUT
(default), DELETE, and ADD. The behavior
depends on whether the specified primary key already exists in the
table. If an item with the specified Key is found in the table:
PUT - Adds the specified
attribute to the item. If the attribute already exists, it is replaced
by the new value.
DELETE - If no value is
specified, the attribute and its value are removed from the item. The
data type of the specified value must match the existing value's data
type.
If a set of values is specified, then those values are
subtracted from the old set. For example, if the attribute value was
the set [a,b,c] and the DELETE action specified
[a,c], then the final attribute value would be
[b]. Specifying an empty set is an error.
ADD - If the attribute does not already exist, then
the attribute and its values are added to the item. If the attribute
does exist, then the behavior of ADD depends on the data
type of the attribute:
If the existing attribute is a
number, and if Value is also a number, then the Value is
mathematically added to the existing attribute. If Value is a
negative number, then it is subtracted from the existing attribute.
If you use In addition, if you use
ADD to increment or decrement a
number value for an item that doesn't exist before the update,
DynamoDB uses 0 as the initial value. ADD to update an existing item, and intend to increment
or decrement an attribute value which does not yet exist, DynamoDB
uses 0 as the initial value. For example, suppose that
the item you want to update does not yet have an attribute named
itemcount, but you decide to ADD the number
3 to this attribute anyway, even though it currently does
not exist. DynamoDB will create the itemcount attribute, set
its initial value to 0, and finally add 3 to
it. The result will be a new itemcount attribute in the item,
with a value of 3.
If the existing
data type is a set, and if the Value is also a set, then the
Value is added to the existing set. (This is a set
operation, not mathematical addition.) For example, if the attribute
value was the set [1,2], and the ADD action
specified [3], then the final attribute value would be
[1,2,3]. An error occurs if an Add action is specified
for a set attribute and the attribute type specified does not match
the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings. The same holds true for number sets and binary sets.
This action is only valid
for an existing attribute whose data type is number or is a set. Do
not use ADD for any other data types.
If no item with the specified Key is found:
PUT - DynamoDB creates a new item with the specified
primary key, and then adds the attribute.
DELETE - Nothing happens; there is no attribute to
delete.
ADD - DynamoDB creates an item with
the supplied primary key and number (or set of numbers) for the
attribute value. The only data types allowed are number and number
set; no other data types can be specified.
Constraints:
Allowed Values: ADD, PUT, DELETE
Map<K,V> requestItems
Each element in the map consists of the following:
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 hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
AttributesToGet - One or more attributes to be retrieved from the table. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
ConsistentRead - If
true, a strongly consistent read is used; if
false (the default), an eventually consistent read is
used.
Constraints:
Length: 1 - 100
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Map<K,V> responses
Map<K,V> unprocessedKeys
Each element consists of:
Keys - An array of primary key attribute values that define specific items in the table.
AttributesToGet - One or more attributes to be retrieved from the table or index. By default, all attributes are returned. If a specified attribute is not found, it does not appear in the result.
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.
If there are no unprocessed keys remaining, the response contains an empty UnprocessedKeys map.
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Map<K,V> requestItems
DeleteRequest - Perform a DeleteItem operation on the specified item. The item to be deleted is identified by a Key subelement:
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 hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
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.
Constraints:
Length: 1 - 25
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
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.
Constraints:
Allowed Values: SIZE, NONE
Map<K,V> unprocessedItems
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:
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.
PutRequest - Perform a PutItem operation on the specified item. The item to be put is identified by an Item subelement:
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.
If there are no unprocessed items remaining, the response contains an empty UnprocessedItems map.
Constraints:
Length: 1 - 25
Map<K,V> itemCollectionMetrics
Each entry consists of the following subelements:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> consumedCapacity
Each element consists of:
TableName - The table that consumed the provisioned throughput.
CapacityUnits - The total number of capacity units consumed.
Double capacityUnits
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a is
greater than A, and a is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
String comparisonOperator
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL |
CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is supported for all
datatypes, including lists and maps.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
Binary, String Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Double capacityUnits
Capacity table
Map<K,V> localSecondaryIndexes
Map<K,V> globalSecondaryIndexes
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
Constraints:
Length: 1 - 2
Projection projection
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
Each KeySchemaElement in the array is composed of:
AttributeName - The name of this key attribute.
KeyType - Determines whether the key attribute is
HASH or RANGE.
For a primary
key that consists of a hash attribute, you must specify exactly one
element with a KeyType of HASH.
For a primary
key that consists of hash and range attributes, you must specify
exactly two elements, in this order: The first element must have a
KeyType of HASH, and the second element must have
a KeyType of RANGE.
For more information, see Specifying the Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
Each local secondary index in the array includes the following:
IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same hash key attribute as the table.
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:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are
projected into the index.
INCLUDE - Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified 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.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
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:
ProjectionType - One of the following:
KEYS_ONLY - Only the index
and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are
projected into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the
table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified 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.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
TableDescription tableDescription
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
Map<K,V> expected
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the DeleteItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The
Value and Exists parameters are incompatible with
AttributeValueList and ComparisonOperator. Note that if
you use both sets of parameters at once, DynamoDB will return a
ValidationException exception. This parameter does not
support attributes of type List or Map.
String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
String returnValues
NONE - If ReturnValues is
not specified, or if its value is NONE, then nothing is
returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is
returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
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.
Constraints:
Allowed Values: SIZE, NONE
String conditionExpression
An expression can contain any of the following:
Boolean functions: attribute_exists |
attribute_not_exists | contains | begins_with
These function names are case-sensitive.
Comparison operators: =
| <> | < | > | <= | >= | BETWEEN | IN
Logical
operators: AND | OR | NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"},
":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
ALL_OLD in the
request.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value 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 that 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.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription tableDescription
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
TableDescription table
AttributeValue value
Each attribute in an item is a name-value pair. An attribute can be single-valued or multi-valued set. For example, a book item can have title and authors attributes. Each book has one title but can have many authors. The multi-valued attribute is a set; duplicate values are not allowed.
Boolean exists
If Exists is true,
DynamoDB will check to see if that attribute value already exists in
the table. If it is found, then the operation succeeds. If it is not
found, the operation fails with a
ConditionalCheckFailedException.
If Exists
is false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist, then the
assumption is valid and the operation succeeds. If the value is found,
despite the assumption that it does not exist, the operation fails
with a ConditionalCheckFailedException.
The
default setting for Exists is true. If you supply
a Value all by itself, DynamoDB assumes the attribute exists:
You don't have to set Exists to true, because it
is implied.
DynamoDB returns a ValidationException if:
Exists is true but there is no
Value to check. (You expect a value to exist, but don't specify
what that value is.)
Exists is false
but you also specify a Value. (You cannot expect an attribute
to have a value, while also expecting it not to exist.)
String comparisonOperator
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT | NOT_NULL | NULL | CONTAINS |
NOT_CONTAINS | BEGINS_WITH | IN | BETWEEN
The following are descriptions of each comparison operator.
EQ
: Equal. EQ is supported for all datatypes, including
lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
Constraints:
Allowed Values: EQ, NE, IN, LE, LT, GE, GT, BETWEEN, NOT_NULL, NULL, CONTAINS, NOT_CONTAINS, BEGINS_WITH
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeValueList
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less than are
based on ASCII character code values. For example, a is
greater than A, and a is greater than
B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
Boolean consistentRead
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used.String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> item
ConsumedCapacity consumedCapacity
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH or RANGE).
Constraints:
Length: 1 - 2
Projection projection
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE).
Constraints:
Length: 1 - 2
Projection projection
String indexStatus
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
Boolean backfilling
For indexes that were created during a CreateTable operation, the Backfilling attribute does not appear in the DescribeTable output.
ProvisionedThroughputDescription provisionedThroughput
Long indexSizeBytes
Long itemCount
UpdateGlobalSecondaryIndexAction update
CreateGlobalSecondaryIndexAction create
IndexName
KeySchema
AttributeDefinitions
Projection
ProvisionedThroughput
DeleteGlobalSecondaryIndexAction delete
Map<K,V> itemCollectionKey
com.amazonaws.internal.ListWithAutoConstructFlag<T> sizeEstimateRangeGB
The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.
com.amazonaws.internal.ListWithAutoConstructFlag<T> keys
Constraints:
Length: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
Constraints:
Length: 1 -
Boolean consistentRead
true, then
a strongly consistent read is used; otherwise, an eventually
consistent read is used.String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String exclusiveStartTableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Integer limit
Constraints:
Range: 1 - 100
com.amazonaws.internal.ListWithAutoConstructFlag<T> tableNames
If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.
String lastEvaluatedTableName
If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH
or RANGE).
Constraints:
Length: 1 - 2
Projection projection
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
HASH or
RANGE).
Constraints:
Length: 1 - 2
Projection projection
Long indexSizeBytes
Long itemCount
String projectionType
KEYS_ONLY - Only the index and primary keys are
projected into the index.
INCLUDE - Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into
the index.
Constraints:
Allowed Values: ALL, KEYS_ONLY, INCLUDE
com.amazonaws.internal.ListWithAutoConstructFlag<T> nonKeyAttributes
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.
Constraints:
Length: 1 - 20
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
Date lastIncreaseDateTime
Date lastDecreaseDateTime
Long numberOfDecreasesToday
Constraints:
Range: 1 -
Long readCapacityUnits
Constraints:
Range: 1 -
Long writeCapacityUnits
Constraints:
Range: 1 -
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> item
You must provide all of the attributes for the primary key. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
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.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Each element in the Item map is an AttributeValue object.
Map<K,V> expected
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected
provides a conditional block for the PutItem operation.
This parameter does not support attributes of type List or
Map.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The Value and Exists parameters are incompatible with AttributeValueList and ComparisonOperator. Note that if you use both sets of parameters at once, DynamoDB will return a ValidationException exception.
String returnValues
NONE -
If ReturnValues is not specified, or if its value is
NONE, then nothing is returned. (This setting is the
default for ReturnValues.)
ALL_OLD -
If PutItem overwrote an attribute name-value pair, then the
content of the old item is returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
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.
Constraints:
Allowed Values: SIZE, NONE
String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
String conditionExpression
An expression can contain any of the following:
Boolean functions:
attribute_exists | attribute_not_exists | contains |
begins_with
These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= |
BETWEEN | IN
Logical operators: AND | OR |
NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"},
":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
ALL_OLD in the request. Each element consists of an
attribute name and an attribute value.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
Each ItemCollectionMetrics element consists of:
ItemCollectionKey - The hash key value of the item collection. This is the same as the hash key of the item.
SizeEstimateRange - An estimate of item collection size, in gigabytes. This value 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 that 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.
Map<K,V> item
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
String select
ALL_ATTRIBUTES - Returns all of
the item attributes from the specified table or index. If you query a
local secondary index, then for each matching item in the index
DynamoDB will fetch the entire item from the parent table. If the
index is configured to project all item attributes, then all of the
data can be obtained from the local secondary index, and no fetching
is required.
ALL_PROJECTED_ATTRIBUTES -
Allowed only when querying an index. Retrieves all attributes that
have been projected into the index. If the index is configured to
project all attributes, this return value is equivalent to specifying
ALL_ATTRIBUTES.
COUNT -
Returns the number of matching items, rather than the matching items
themselves.
SPECIFIC_ATTRIBUTES - Returns
only the attributes listed in AttributesToGet. This return
value is equivalent to specifying AttributesToGet without
specifying any value for Select.
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
If neither Select nor AttributesToGet are
specified, DynamoDB defaults to ALL_ATTRIBUTES when
accessing a table, and ALL_PROJECTED_ATTRIBUTES when
accessing an index. You cannot use both Select and
AttributesToGet together in a single request, unless the value
for Select is SPECIFIC_ATTRIBUTES. (This usage is
equivalent to specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
You cannot use both
AttributesToGet and Select together in a Query
request, unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
If you query a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB will fetch each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.
If you query a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
Boolean consistentRead
true, then the operation uses
strongly consistent reads; otherwise, eventually consistent reads are
used. Strongly consistent reads are not supported on global
secondary indexes. If you query a global secondary index with
ConsistentRead set to true, you will receive an
error message.
Map<K,V> keyConditions
EQ
condition. You can optionally specify a second condition, referring to
the range key attribute. If you do not specify a range key condition, all of the items that match the hash key will be retrieved. If a FilterExpression or QueryFilter is present, it will be applied after the items are retrieved.
For a query on an index, you can have conditions only on the index key attributes. You must specify the index hash attribute name and value as an EQ condition. You can optionally specify a second condition, referring to the index key range attribute.
Each KeyConditions element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value comparisons for
greater than, equals, or less than are based on ASCII character code
values. For example, a is greater than A,
and a is greater than B. For a list of code
values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes, for example, equals, greater than, less than, and so on.
For KeyConditions, only the following comparison operators are supported:
EQ | LE | LT | GE | GT | BEGINS_WITH |
BETWEEN
The following are descriptions of these comparison operators.
EQ : Equal.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not equal
{"NS":["6", "2", "1"]}.
LE : Less than or equal.
AttributeValueList
can contain only one AttributeValue element of type String,
Number, or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
LT : Less than.
AttributeValueList can contain only one
AttributeValue of type String, Number, or Binary (not a set
type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
BEGINS_WITH : Checks for
a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
BETWEEN : Greater than or equal to the first value,
and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
Map<K,V> queryFilter
There is a newer parameter available. Use FilterExpression instead. Note that if you use QueryFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
A condition that evaluates the query results after the items are read and returns only the desired values.
This parameter
does not support attributes of type List or Map. A
QueryFilter is applied after the items have already been read;
the process of filtering does not consume any additional read capacity
units.
If you specify more than one condition in the QueryFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Note that QueryFilter does not allow key attributes. You cannot define a filter condition on a hash key or range key.
Each QueryFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator.
For type Number, value comparisons are numeric.
String value comparisons for greater than, equals, or less
than are based on ASCII character code values. For example,
a is greater than A, and a is
greater than B. For a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see the Condition data type.
String conditionalOperator
AND - If all of the conditions evaluate
to true, then the entire map evaluates to true.
OR - If at least one of the conditions evaluate to
true, then the entire map evaluates to true.
If you omit
ConditionalOperator, then AND is the default.
The operation will succeed only if the entire map evaluates to
true. This parameter does not support attributes of type List
or Map.
Constraints:
Allowed Values: AND, OR
Boolean scanIndexForward
If ScanIndexForward is not specified, the results are returned in ascending order.
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String filterExpression
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, go to Filter Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"},
":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before> the filter was applied.
If you did not use a filter in the request, then Count and ScannedCount are the same.
Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributesToGet
There is a newer parameter available. Use ProjectionExpression instead. Note that if you use AttributesToGet and ProjectionExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.
The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.
Constraints:
Length: 1 -
Integer limit
Constraints:
Range: 1 -
String select
ALL_ATTRIBUTES - Returns all of the item
attributes.
COUNT - Returns the number of
matching items, rather than the matching items themselves.
SPECIFIC_ATTRIBUTES - Returns only the attributes
listed in AttributesToGet. This return value is equivalent to
specifying AttributesToGet without specifying any value for
Select.
If neither Select nor
AttributesToGet are specified, DynamoDB defaults to
ALL_ATTRIBUTES. You cannot use both
AttributesToGet and Select together in a single request,
unless the value for Select is
SPECIFIC_ATTRIBUTES. (This usage is equivalent to
specifying AttributesToGet without any value for
Select.)
Constraints:
Allowed Values: ALL_ATTRIBUTES, ALL_PROJECTED_ATTRIBUTES, SPECIFIC_ATTRIBUTES, COUNT
Map<K,V> scanFilter
There is a newer parameter available. Use FilterExpression instead. Note that if you use ScanFilter and FilterExpression at the same time, DynamoDB will return a ValidationException exception.
A condition that evaluates the scan results and
returns only the desired values. This parameter does not
support attributes of type List or Map.
If you specify more than one condition in the ScanFilter map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
Each ScanFilter element consists of an attribute name to compare, along with the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the operator specified in ComparisonOperator .
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
For information on specifying data types in JSON, see JSON Data Format in the Amazon DynamoDB Developer Guide.
ComparisonOperator - A comparator for evaluating attributes. For example, equals, greater than, less than, etc.
The following comparison operators are available:
EQ | NE | LE |
LT | GE | GT | NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH
| IN | BETWEEN
For complete descriptions of all comparison operators, see Condition.
String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in a ScanFilter map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
Map<K,V> exclusiveStartKey
The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.
In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
Integer totalSegments
The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.
If you specify TotalSegments, you must also specify Segment.
Constraints:
Range: 1 - 1000000
Integer segment
Segment IDs are zero-based, so the first segment is always 0. For example, if you want to scan a table using four application threads, the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.
The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.
The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.
If you specify Segment, you must also specify TotalSegments.
Constraints:
Range: 0 - 999999
String projectionExpression
If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.
For more information, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
String filterExpression
A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.
For more information, go to Filter Expressions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"},
":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> items
Integer count
If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.
If you did not use a filter in the request, then Count is the same as ScannedCount.
Integer scannedCount
If you did not use a filter in the request, then ScannedCount is the same as Count.
Map<K,V> lastEvaluatedKey
If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.
If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.
ConsumedCapacity consumedCapacity
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
Each AttributeDefinition object in this array is composed of:
AttributeName - The name of the attribute.
AttributeType - The data type for the attribute.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
com.amazonaws.internal.ListWithAutoConstructFlag<T> keySchema
AttributeName - The name of the attribute.
KeyType - The key type for the
attribute. Can be either HASH or RANGE.
For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.
Constraints:
Length: 1 - 2
String tableStatus
CREATING - The table is being created.
UPDATING - The table is being updated.
DELETING - The table is being deleted.
ACTIVE - The table is ready for use.
Constraints:
Allowed Values: CREATING, UPDATING, DELETING, ACTIVE
Date creationDateTime
ProvisionedThroughputDescription provisionedThroughput
Long tableSizeBytes
Long itemCount
com.amazonaws.internal.ListWithAutoConstructFlag<T> localSecondaryIndexes
IndexName - The name of the local secondary index.
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 hash key attribute as the table.
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:
ProjectionType - One of the following:
KEYS_ONLY - Only the index and primary keys are
projected into the index.
INCLUDE - Only
the specified table attributes are projected into the index. The list
of projected attributes are in NonKeyAttributes.
ALL - All of the table attributes are projected into
the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified 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.
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.
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.
If the table is in the
DELETING state, no information about indexes will be
returned.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexes
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.)
IndexName - The name of the global secondary index.
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.
IndexStatus - The current status of the global secondary index:
CREATING - The index is being created.
UPDATING - The index is being updated.
DELETING - The index is being deleted.
ACTIVE - The index is ready for use.
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.
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 hash key attribute as the table.
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:
ProjectionType - One of the following:
KEYS_ONLY - Only the index
and primary keys are projected into the index.
INCLUDE - Only the specified table attributes are
projected into the index. The list of projected attributes are in
NonKeyAttributes.
ALL - All of the
table attributes are projected into the index.
NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes specified 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.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units, along with data about increases and decreases.
If the table is in the DELETING state, no information
about indexes will be returned.
String indexName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
Map<K,V> key
For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to specify the hash attribute. For a hash-and-range type primary key, you must specify both the hash attribute and the range attribute.
Map<K,V> attributeUpdates
There is a newer parameter available. Use UpdateExpression instead. Note that if you use AttributeUpdates and UpdateExpression at the same time, DynamoDB will return a ValidationException exception.
This parameter can be used for modifying top-level attributes; however, it does not support individual list or map elements.
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any nonkey attributes.
Attribute values cannot be null. String and Binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException exception.
Each AttributeUpdates element consists of an attribute name to modify, along with the following:
Value - The new value, if applicable, for this attribute.
Action - A value that specifies how to perform
the update. This action is only valid for an existing attribute whose
data type is Number or is a set; do not use ADD for other
data types.
If an item with the specified primary key is found in the table, the following values perform the following actions:
PUT - Adds the specified attribute to the item.
If the attribute already exists, it is replaced by the new value.
DELETE - Removes the attribute and its
value, if no value is specified for DELETE. The data type
of the specified value must match the existing value's data type.
If a set of values is specified, then those values are subtracted
from the old set. For example, if the attribute value was the set
[a,b,c] and the DELETE action specifies
[a,c], then the final attribute value is
[b]. Specifying an empty set is an error.
ADD - Adds the specified value to the item, if the
attribute does not already exist. If the attribute does exist, then
the behavior of ADD depends on the data type of the
attribute:
If the existing attribute is a number, and if
Value is also a number, then Value is mathematically
added to the existing attribute. If Value is a negative number,
then it is subtracted from the existing attribute. If you
use Similarly, if you use ADD to increment or decrement a number value for an
item that doesn't exist before the update, DynamoDB uses 0 as the
initial value. ADD for an
existing item to increment or decrement an attribute value that
doesn't exist before the update, DynamoDB uses 0 as the
initial value. For example, suppose that the item you want to update
doesn't have an attribute named itemcount, but you decide to
ADD the number 3 to this attribute anyway.
DynamoDB will create the itemcount attribute, set its initial
value to 0, and finally add 3 to it. The
result will be a new itemcount attribute, with a value of
3.
If the existing data type is a
set, and if Value is also a set, then Value is appended
to the existing set. For example, if the attribute value is the set
[1,2], and the ADD action specified
[3], then the final attribute value is
[1,2,3]. An error occurs if an ADD action is
specified for a set attribute and the attribute type specified does
not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, Value must also be a set of strings.
If no item with the specified key is found in the table, the following values perform the following actions:
PUT - Causes DynamoDB to create a new item with the
specified primary key, and then adds the attribute.
DELETE - Nothing happens, because attributes cannot be
deleted from a nonexistent item. The operation succeeds, but DynamoDB
does not create a new item.
ADD - Causes
DynamoDB to create an item with the supplied primary key and number
(or set of numbers) for the attribute value. The only data types
allowed are Number and Number Set.
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.
Map<K,V> expected
There is a newer parameter available. Use ConditionExpression instead. Note that if you use Expected and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A map of attribute/condition pairs. Expected provides a conditional block for the UpdateItem operation.
Each element of Expected consists of an attribute name, a comparison operator, and one or more values. DynamoDB compares the attribute with the value(s) you supplied, using the comparison operator. For each Expected element, the result of the evaluation is either true or false.
If you specify more than one element in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.)
If the Expected map evaluates to true, then the conditional operation succeeds; otherwise, it fails.
Expected contains the following:
AttributeValueList - One or more values to evaluate against the supplied attribute. The number of values in the list depends on the ComparisonOperator being used.
For type Number, value comparisons are numeric.
String value
comparisons for greater than, equals, or less than are based on ASCII
character code values. For example, a is greater than
A, and a is greater than B. For
a list of code values, see http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters.
For type Binary, DynamoDB treats each byte of the binary data as unsigned when it compares binary values.
ComparisonOperator - A comparator for evaluating attributes in the AttributeValueList. When performing the comparison, DynamoDB uses strongly consistent reads.
The following comparison operators are available:
EQ | NE | LE | LT | GE | GT |
NOT_NULL | NULL | CONTAINS | NOT_CONTAINS | BEGINS_WITH | IN |
BETWEEN
The following are descriptions of each comparison operator.
EQ : Equal. EQ is
supported for all datatypes, including lists and maps.
AttributeValueList can contain only one
AttributeValue element of type String, Number, Binary, String
Set, Number Set, or Binary Set. If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
NE : Not equal.
NE is supported for all datatypes, including lists and
maps.
AttributeValueList can contain only one
AttributeValue of type String, Number, Binary, String Set,
Number Set, or Binary Set. If an item contains an
AttributeValue of a different type than the one specified in
the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not equal {"NS":["6", "2",
"1"]}.
LE : Less than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
LT : Less than.
AttributeValueList can
contain only one AttributeValue of type String, Number, or
Binary (not a set type). If an item contains an AttributeValue
element of a different type than the one specified in the request, the
value does not match. For example, {"S":"6"} does not
equal {"N":"6"}. Also, {"N":"6"} does not
compare to {"NS":["6", "2", "1"]}.
GE : Greater than or equal.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not equal
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}.
GT : Greater than.
AttributeValueList can
contain only one AttributeValue element of type String, Number,
or Binary (not a set type). If an item contains an
AttributeValue element of a different type than the one
specified in the request, the value does not match. For example,
{"S":"6"} does not equal {"N":"6"}. Also,
{"N":"6"} does not compare to {"NS":["6", "2",
"1"]}.
This operator tests for the
existence of an attribute, not its data type. If the data type of
attribute "NOT_NULL : The attribute
exists. NOT_NULL is supported for all datatypes,
including lists and maps. a" is null, and you evaluate it using
NOT_NULL, the result is a Boolean true. This
result is because the attribute "a" exists; its data type
is not relevant to the NOT_NULL comparison operator.
This operator tests for the nonexistence of
an attribute, not its data type. If the data type of attribute
"NULL : The attribute does not
exist. NULL is supported for all datatypes, including
lists and maps. a" is null, and you evaluate it using NULL,
the result is a Boolean false. This is because the attribute
"a" exists; its data type is not relevant to the
NULL comparison operator.
CONTAINS : Checks for a subsequence, or value in a
set.
AttributeValueList can contain only one
AttributeValue element of type String, Number, or Binary (not a
set type). If the target attribute of the comparison is of type
String, then the operator checks for a substring match. If the target
attribute of the comparison is of type Binary, then the operator looks
for a subsequence of the target that matches the input. If the target
attribute of the comparison is a set ("SS",
"NS", or "BS"), then the operator evaluates
to true if it finds an exact match with any member of the set.
CONTAINS is supported for lists: When evaluating "a CONTAINS
b", "a" can be a list; however, "b"
cannot be a set, a map, or a list.
NOT_CONTAINS : Checks for absence of a subsequence, or
absence of a value in a set.
AttributeValueList can contain
only one AttributeValue element of type String, Number, or
Binary (not a set type). If the target attribute of the comparison is
a String, then the operator checks for the absence of a substring
match. If the target attribute of the comparison is Binary, then the
operator checks for the absence of a subsequence of the target that
matches the input. If the target attribute of the comparison is a set
("SS", "NS", or "BS"), then the
operator evaluates to true if it does not find an exact match
with any member of the set.
NOT_CONTAINS is supported for lists:
When evaluating "a NOT CONTAINS b", "a" can
be a list; however, "b" cannot be a set, a map, or a
list.
BEGINS_WITH : Checks for a prefix.
AttributeValueList can contain only one AttributeValue of type String or Binary (not a Number or a set type). The target attribute of the comparison must be of type String or Binary (not a Number or a set type).
IN : Checks for matching elements within two sets.
AttributeValueList can contain one or more AttributeValue elements of type String, Number, or Binary (not a set type). These attributes are compared against an existing set type attribute of an item. If any elements of the input set are present in the item attribute, the expression evaluates to true.
BETWEEN : Greater than or equal to the first
value, and less than or equal to the second value.
AttributeValueList must contain two AttributeValue
elements of the same type, either String, Number, or Binary (not a set
type). A target attribute matches if the target value is greater than,
or equal to, the first element and less than, or equal to, the second
element. If an item contains an AttributeValue element of a
different type than the one specified in the request, the value does
not match. For example, {"S":"6"} does not compare to
{"N":"6"}. Also, {"N":"6"} does not compare
to {"NS":["6", "2", "1"]}
For usage examples of AttributeValueList and ComparisonOperator, see Legacy Conditional Parameters in the Amazon DynamoDB Developer Guide.
For backward compatibility with previous DynamoDB releases, the following parameters can be used instead of AttributeValueList and ComparisonOperator:
Value - A value for DynamoDB to compare with an attribute.
Exists - A Boolean value that causes DynamoDB to evaluate the value before attempting the conditional operation:
If Exists is true, DynamoDB will check to
see if that attribute value already exists in the table. If it is
found, then the condition evaluates to true; otherwise the condition
evaluate to false.
If Exists is
false, DynamoDB assumes that the attribute value does
not exist in the table. If in fact the value does not exist,
then the assumption is valid and the condition evaluates to true. If
the value is found, despite the assumption that it does not exist, the
condition evaluates to false.
Note that the default
value for Exists is true.
The
Value and Exists parameters are incompatible with
AttributeValueList and ComparisonOperator. Note that if
you use both sets of parameters at once, DynamoDB will return a
ValidationException exception. This parameter does not
support attributes of type List or Map.
String conditionalOperator
There is a newer parameter available. Use ConditionExpression instead. Note that if you use ConditionalOperator and ConditionExpression at the same time, DynamoDB will return a ValidationException exception.
A logical operator to apply to the conditions in the Expected map:
AND -
If all of the conditions evaluate to true, then the entire map
evaluates to true.
OR - If at least one of
the conditions evaluate to true, then the entire map evaluates to
true.
If you omit ConditionalOperator, then
AND is the default.
The operation will succeed only if
the entire map evaluates to true. This parameter does not
support attributes of type List or Map.
Constraints:
Allowed Values: AND, OR
String returnValues
NONE - If ReturnValues is not specified, or if
its value is NONE, then nothing is returned. (This
setting is the default for ReturnValues.)
ALL_OLD - If UpdateItem overwrote an attribute
name-value pair, then the content of the old item is returned.
UPDATED_OLD - The old versions of only the
updated attributes are returned.
ALL_NEW -
All of the attributes of the new version of the item are returned.
UPDATED_NEW - The new versions of only the
updated attributes are returned.
Constraints:
Allowed Values: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW
String returnConsumedCapacity
TOTAL, the response includes
ConsumedCapacity data for tables and indexes. If set to
INDEXES, the response includes ConsumedCapacity
for indexes. If set to NONE (the default),
ConsumedCapacity is not included in the response.
Constraints:
Allowed Values: INDEXES, TOTAL, NONE
String returnItemCollectionMetrics
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.
Constraints:
Allowed Values: SIZE, NONE
String updateExpression
The following action values are available for UpdateExpression.
SET - Adds one or more attributes and values
to an item. If any of these attribute already exist, they are replaced
by the new values. You can also use SET to add or
subtract from an attribute that is of type Number.
SET
supports the following functions:
if_not_exists
(path, operand) - if the item does not contain an attribute at
the specified path, then if_not_exists evaluates to
operand; otherwise, it evaluates to path. You can use this function to
avoid overwriting an attribute that may already be present in the
item.
list_append (operand, operand) -
evaluates to a list with a new element added to it. You can append the
new element to the start or the end of the list by reversing the order
of the operands.
These function names are case-sensitive.
REMOVE - Removes one or
more attributes from an item.
ADD - Adds
the specified value to the item, if the attribute does not already
exist. If the attribute does exist, then the behavior of
ADD depends on the data type of the attribute:
If the existing attribute is a number, and if Value is also
a number, then Value is mathematically added to the existing
attribute. If Value is a negative number, then it is subtracted
from the existing attribute. If you use Similarly, if you use ADD to
increment or decrement a number value for an item that doesn't exist
before the update, DynamoDB uses 0 as the initial value.
ADD for an existing item to
increment or decrement an attribute value that doesn't exist before
the update, DynamoDB uses 0 as the initial value. For
example, suppose that the item you want to update doesn't have an
attribute named itemcount, but you decide to ADD
the number 3 to this attribute anyway. DynamoDB will
create the itemcount attribute, set its initial value to
0, and finally add 3 to it. The result will
be a new itemcount attribute in the item, with a value of
3.
If the existing data type is a
set and if Value is also a set, then Value is added to
the existing set. For example, if the attribute value is the set
[1,2], and the ADD action specified
[3], then the final attribute value is
[1,2,3]. An error occurs if an ADD action is
specified for a set attribute and the attribute type specified does
not match the existing set type.
Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number
and set data types. In addition, ADD can only be used on
top-level attributes, not nested attributes.
DELETE - Deletes an element from a set.
If a set of
values is specified, then those values are subtracted from the old
set. For example, if the attribute value was the set
The [a,b,c] and the DELETE action specifies
[a,c], then the final attribute value is
[b]. Specifying an empty set is an error.
DELETE action only supports Number and
set data types. In addition, DELETE can only be used on
top-level attributes, not nested attributes.
You can have many actions in a single expression, such as the
following: SET a=:value1, b=:value2 DELETE :value3, :value4,
:value5
For more information on update expressions, go to Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
String conditionExpression
An expression can contain any of the following:
Boolean functions: attribute_exists |
attribute_not_exists | contains | begins_with
These function names are case-sensitive.
Comparison operators: =
| <> | < | > | <= | >= | BETWEEN | IN
Logical
operators: AND | OR | NOT
For more information on condition expressions, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeNames
To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
Percentile
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, go to Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:
{"#P":"Percentile"}
You could then use this substitution in an expression, as in this example:
#P = :val
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information on expression attribute names, go to Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
Map<K,V> expressionAttributeValues
Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:
Available | Backordered | Discontinued
You would first need to specify ExpressionAttributeValues as follows:
{ ":avail":{"S":"Available"},
":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }
You could then use these values in an expression, such as this:
ProductStatus IN (:avail, :back, :disc)
For more information on expression attribute values, go to Specifying Conditions in the Amazon DynamoDB Developer Guide.
Map<K,V> attributes
NONE in the request. Each element represents one
attribute.ConsumedCapacity consumedCapacity
ItemCollectionMetrics itemCollectionMetrics
com.amazonaws.internal.ListWithAutoConstructFlag<T> attributeDefinitions
String tableName
Constraints:
Length: 3 - 255
Pattern: [a-zA-Z0-9_.-]+
ProvisionedThroughput provisionedThroughput
For current minimum and maximum provisioned throughput values, see Limits in the Amazon DynamoDB Developer Guide.
com.amazonaws.internal.ListWithAutoConstructFlag<T> globalSecondaryIndexUpdates
Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.
TableDescription tableDescription
PutRequest putRequest
DeleteRequest deleteRequest
Copyright © 2015. All rights reserved.