Class UpdateItemRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the input of an UpdateItem operation.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for UpdateItemRequest object.UpdateItemRequest
(String tableName, Map<String, AttributeValue> key, Map<String, AttributeValueUpdate> attributeUpdates) Constructs a new UpdateItemRequest object.UpdateItemRequest
(String tableName, Map<String, AttributeValue> key, Map<String, AttributeValueUpdate> attributeUpdates, ReturnValue returnValues) Constructs a new UpdateItemRequest object.UpdateItemRequest
(String tableName, Map<String, AttributeValue> key, Map<String, AttributeValueUpdate> attributeUpdates, String returnValues) Constructs a new UpdateItemRequest object. -
Method Summary
Modifier and TypeMethodDescriptionaddAttributeUpdatesEntry
(String key, AttributeValueUpdate value) addExpectedEntry
(String key, ExpectedAttributeValue value) addExpressionAttributeNamesEntry
(String key, String value) addExpressionAttributeValuesEntry
(String key, AttributeValue value) addKeyEntry
(String key, AttributeValue value) Removes all the entries added into AttributeUpdates.Removes all the entries added into Expected.Removes all the entries added into ExpressionAttributeNames.Removes all the entries added into ExpressionAttributeValues.Removes all the entries added into Key.clone()
Creates a shallow clone of this request.boolean
A condition that must be satisfied in order for a conditional update to succeed.One or more substitution tokens for attribute names in an expression.One or more values that can be substituted in an expression.getKey()
The primary key of the item to be updated.Determines whether item collection metrics are returned.Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.The name of the table containing the item to update.An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.int
hashCode()
void
setAttributeUpdates
(Map<String, AttributeValueUpdate> attributeUpdates) void
setConditionalOperator
(ConditionalOperator conditionalOperator) void
setConditionalOperator
(String conditionalOperator) void
setConditionExpression
(String conditionExpression) A condition that must be satisfied in order for a conditional update to succeed.void
setExpected
(Map<String, ExpectedAttributeValue> expected) void
setExpressionAttributeNames
(Map<String, String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.void
setExpressionAttributeValues
(Map<String, AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.void
setKey
(Map.Entry<String, AttributeValue> hashKey, Map.Entry<String, AttributeValue> rangeKey) Set the hash and range key attributes of the item.void
setKey
(Map<String, AttributeValue> key) The primary key of the item to be updated.void
setReturnConsumedCapacity
(ReturnConsumedCapacity returnConsumedCapacity) void
setReturnConsumedCapacity
(String returnConsumedCapacity) void
setReturnItemCollectionMetrics
(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned.void
setReturnItemCollectionMetrics
(String returnItemCollectionMetrics) Determines whether item collection metrics are returned.void
setReturnValues
(ReturnValue returnValues) Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.void
setReturnValues
(String returnValues) Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.void
setTableName
(String tableName) The name of the table containing the item to update.void
setUpdateExpression
(String updateExpression) An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.toString()
Returns a string representation of this object; useful for testing and debugging.withAttributeUpdates
(Map<String, AttributeValueUpdate> attributeUpdates) withConditionalOperator
(ConditionalOperator conditionalOperator) withConditionalOperator
(String conditionalOperator) withConditionExpression
(String conditionExpression) A condition that must be satisfied in order for a conditional update to succeed.withExpected
(Map<String, ExpectedAttributeValue> expected) withExpressionAttributeNames
(Map<String, String> expressionAttributeNames) One or more substitution tokens for attribute names in an expression.withExpressionAttributeValues
(Map<String, AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.withKey
(Map.Entry<String, AttributeValue> hashKey, Map.Entry<String, AttributeValue> rangeKey) Set the hash and range key attributes of the item.withKey
(Map<String, AttributeValue> key) The primary key of the item to be updated.withReturnConsumedCapacity
(ReturnConsumedCapacity returnConsumedCapacity) withReturnConsumedCapacity
(String returnConsumedCapacity) withReturnItemCollectionMetrics
(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned.withReturnItemCollectionMetrics
(String returnItemCollectionMetrics) Determines whether item collection metrics are returned.withReturnValues
(ReturnValue returnValues) Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.withReturnValues
(String returnValues) Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated.withTableName
(String tableName) The name of the table containing the item to update.withUpdateExpression
(String updateExpression) An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
UpdateItemRequest
public UpdateItemRequest()Default constructor for UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it. -
UpdateItemRequest
public UpdateItemRequest(String tableName, Map<String, AttributeValue> key, Map<String, AttributeValueUpdate> attributeUpdates) Constructs a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
tableName
- The name of the table containing the item to update.key
- The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
attributeUpdates
-This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
-
-
UpdateItemRequest
public UpdateItemRequest(String tableName, Map<String, AttributeValue> key, Map<String, AttributeValueUpdate> attributeUpdates, String returnValues) Constructs a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
tableName
- The name of the table containing the item to update.key
- The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
attributeUpdates
-This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
-
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
-
UpdateItemRequest
public UpdateItemRequest(String tableName, Map<String, AttributeValue> key, Map<String, AttributeValueUpdate> attributeUpdates, ReturnValue returnValues) Constructs a new UpdateItemRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
tableName
- The name of the table containing the item to update.key
- The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
attributeUpdates
-This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
-
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
-
-
Method Details
-
setTableName
The name of the table containing the item to update.
- Parameters:
tableName
- The name of the table containing the item to update.
-
getTableName
The name of the table containing the item to update.
- Returns:
- The name of the table containing the item to update.
-
withTableName
The name of the table containing the item to update.
- Parameters:
tableName
- The name of the table containing the item to update.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getKey
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
- Returns:
- The primary key of the item to be updated. Each element consists
of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
-
setKey
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
- Parameters:
key
- The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
-
withKey
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
- Parameters:
key
- The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addKeyEntry
-
clearKeyEntries
Removes all the entries added into Key. <p> Returns a reference to this object so that method calls can be chained together. -
getAttributeUpdates
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
- Returns:
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
-
-
-
setAttributeUpdates
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
- Parameters:
attributeUpdates
-This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
-
-
-
withAttributeUpdates
This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
- Parameters:
attributeUpdates
-This is a legacy parameter, for backward compatibility. New applications should use UpdateExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 non-key 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 forDELETE
. 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 theDELETE
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 ofADD
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
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.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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 provide 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addAttributeUpdatesEntry
-
clearAttributeUpdatesEntries
Removes all the entries added into AttributeUpdates. <p> Returns a reference to this object so that method calls can be chained together. -
getExpected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 thanA
, anda
is greater thanB
. 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 provided 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 provided 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 provided 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 provided 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 provided 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 provided 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"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is supported for all datatypes, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Boolean true. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is supported for all datatypes, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Boolean false. This is because the attribute "a
" exists; its data type is not relevant to theNULL
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 provided 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.
- Returns:
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 thanA
, anda
is greater thanB
. 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 provided 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 provided 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 provided 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 provided 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 provided 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 provided 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"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is supported for all datatypes, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Boolean true. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is supported for all datatypes, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Boolean false. This is because the attribute "a
" exists; its data type is not relevant to theNULL
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 provided 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.
-
-
-
setExpected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 thanA
, anda
is greater thanB
. 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 provided 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 provided 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 provided 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 provided 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 provided 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 provided 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"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is supported for all datatypes, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Boolean true. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is supported for all datatypes, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Boolean false. This is because the attribute "a
" exists; its data type is not relevant to theNULL
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 provided 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.
- Parameters:
expected
-This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 thanA
, anda
is greater thanB
. 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 provided 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 provided 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 provided 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 provided 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 provided 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 provided 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"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is supported for all datatypes, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Boolean true. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is supported for all datatypes, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Boolean false. This is because the attribute "a
" exists; its data type is not relevant to theNULL
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 provided 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.
-
-
-
withExpected
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 thanA
, anda
is greater thanB
. 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 provided 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 provided 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 provided 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 provided 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 provided 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 provided 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"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is supported for all datatypes, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Boolean true. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is supported for all datatypes, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Boolean false. This is because the attribute "a
" exists; its data type is not relevant to theNULL
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 provided 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.
- Parameters:
expected
-This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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 thanA
, anda
is greater thanB
. 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 provided 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 provided 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 provided 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 provided 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 provided 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 provided 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"]}
. -
NOT_NULL
: The attribute exists.NOT_NULL
is supported for all datatypes, including lists and maps.This operator tests for the existence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNOT_NULL
, the result is a Boolean true. This result is because the attribute "a
" exists; its data type is not relevant to theNOT_NULL
comparison operator. -
NULL
: The attribute does not exist.NULL
is supported for all datatypes, including lists and maps.This operator tests for the nonexistence of an attribute, not its data type. If the data type of attribute "
a
" is null, and you evaluate it usingNULL
, the result is a Boolean false. This is because the attribute "a
" exists; its data type is not relevant to theNULL
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 provided 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addExpectedEntry
-
clearExpectedEntries
Removes all the entries added into Expected. <p> Returns a reference to this object so that method calls can be chained together. -
setConditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
-
- See Also:
-
-
getConditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
- Returns:
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
-
- See Also:
-
-
withConditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setConditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
-
- See Also:
-
-
withConditionalOperator
This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
- Parameters:
conditionalOperator
-This is a legacy parameter, for backward compatibility. New applications should use ConditionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setReturnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
- Parameters:
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
- See Also:
-
-
getReturnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
- Returns:
- Use ReturnValues if you want to get the item attributes as
they appeared either before or after they were updated. For
UpdateItem, the valid values are:
-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
- See Also:
-
-
withReturnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
- Parameters:
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setReturnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
- Parameters:
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
- See Also:
-
-
withReturnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
- Parameters:
returnValues
- Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:-
NONE
- If ReturnValues is not specified, or if its value isNONE
, 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.
There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.
Values returned are strongly consistent
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
setReturnConsumedCapacity
- Parameters:
returnConsumedCapacity
-- See Also:
-
getReturnConsumedCapacity
- Returns:
- See Also:
-
withReturnConsumedCapacity
- Parameters:
returnConsumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setReturnConsumedCapacity
- Parameters:
returnConsumedCapacity
-- See Also:
-
withReturnConsumedCapacity
- Parameters:
returnConsumedCapacity
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setReturnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Parameters:
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set toSIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- See Also:
-
getReturnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Returns:
- Determines whether item collection metrics are returned. If set
to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned. - See Also:
-
withReturnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Parameters:
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set toSIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setReturnItemCollectionMetrics
Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Parameters:
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set toSIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- See Also:
-
withReturnItemCollectionMetrics
public UpdateItemRequest withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics) Determines whether item collection metrics are returned. If set to
SIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Parameters:
returnItemCollectionMetrics
- Determines whether item collection metrics are returned. If set toSIZE
, the response includes statistics about item collections, if any, that were modified during the operation are returned in the response. If set toNONE
(the default), no statistics are returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
setUpdateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
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 useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:-
if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_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 ofADD
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
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
[a,b,c]
and theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports 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, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
- Parameters:
updateExpression
- An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.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 useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:-
if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_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 ofADD
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
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
[a,b,c]
and theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports 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, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
-
-
-
getUpdateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
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 useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:-
if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_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 ofADD
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
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
[a,b,c]
and theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports 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, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
- Returns:
- An expression that defines one or more attributes to be updated,
the action to be performed on them, and new value(s) for
them.
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 useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:-
if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_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 ofADD
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
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
[a,b,c]
and theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports 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, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
-
-
-
withUpdateExpression
An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.
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 useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:-
if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_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 ofADD
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
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
[a,b,c]
and theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports 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, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
- Parameters:
updateExpression
- An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.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 useSET
to add or subtract from an attribute that is of type Number. For example:SET myNum = myNum + :val
SET
supports the following functions:-
if_not_exists (path, operand)
- if the item does not contain an attribute at the specified path, thenif_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 ofADD
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
ADD
to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses0
as the initial value.Similarly, if you use
ADD
for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses0
as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide toADD
the number3
to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to0
, and finally add3
to it. The result will be a new itemcount attribute in the item, with a value of3
. -
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 theADD
action specified[3]
, then the final attribute value is[1,2,3]
. An error occurs if anADD
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
[a,b,c]
and theDELETE
action specifies[a,c]
, then the final attribute value is[b]
. Specifying an empty set is an error.The
DELETE
action only supports 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, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.
UpdateExpression replaces the legacy AttributeUpdates parameter.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setConditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators:
AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
- Parameters:
conditionExpression
- A condition that must be satisfied in order for a conditional update to succeed.An expression can contain any of the following:
-
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators:
AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
-
-
-
getConditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators:
AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
- Returns:
- A condition that must be satisfied in order for a conditional
update to succeed.
An expression can contain any of the following:
-
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators:
AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
-
-
-
withConditionExpression
A condition that must be satisfied in order for a conditional update to succeed.
An expression can contain any of the following:
-
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators:
AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
- Parameters:
conditionExpression
- A condition that must be satisfied in order for a conditional update to succeed.An expression can contain any of the following:
-
Functions:
attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size
These function names are case-sensitive.
-
Comparison operators:
= | <> | < | > | <= | >= | BETWEEN | IN
-
Logical operators:
AND | OR | NOT
For more information on condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
ConditionExpression replaces the legacy ConditionalOperator and Expected parameters.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
getExpressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using 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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
- Returns:
- One or more substitution tokens for attribute names in an
expression. The following are some use cases for using
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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
-
-
-
setExpressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using 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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for using 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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
-
-
-
withExpressionAttributeNames
One or more substitution tokens for attribute names in an expression. The following are some use cases for using 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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeNames
- One or more substitution tokens for attribute names in an expression. The following are some use cases for using 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, see 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, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
addExpressionAttributeNamesEntry
-
clearExpressionAttributeNamesEntries
Removes all the entries added into ExpressionAttributeNames. <p> Returns a reference to this object so that method calls can be chained together. -
getExpressionAttributeValues
One or more values that can be substituted in an expression.
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, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Returns:
- One or more values that can be substituted in an expression.
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, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
-
setExpressionAttributeValues
One or more values that can be substituted in an expression.
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, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeValues
- One or more values that can be substituted in an expression.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, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
-
withExpressionAttributeValues
public UpdateItemRequest withExpressionAttributeValues(Map<String, AttributeValue> expressionAttributeValues) One or more values that can be substituted in an expression.
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, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Parameters:
expressionAttributeValues
- One or more values that can be substituted in an expression.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, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
addExpressionAttributeValuesEntry
-
clearExpressionAttributeValuesEntries
Removes all the entries added into ExpressionAttributeValues. <p> Returns a reference to this object so that method calls can be chained together. -
setKey
public void setKey(Map.Entry<String, AttributeValue> hashKey, Map.Entry<String, throws IllegalArgumentExceptionAttributeValue> rangeKey) Set the hash and range key attributes of the item.For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
- Parameters:
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.- Throws:
IllegalArgumentException
-
withKey
public UpdateItemRequest withKey(Map.Entry<String, AttributeValue> hashKey, Map.Entry<String, throws IllegalArgumentExceptionAttributeValue> rangeKey) Set the hash and range key attributes of the item.For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
Returns a reference to this object so that method calls can be chained together.
- Parameters:
hashKey
- a map entry including the name and value of the primary hash key.rangeKey
- a map entry including the name and value of the primary range key, or null if it is a hash-only table.- Throws:
IllegalArgumentException
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-