UpdateItemRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.dynamodbv2.model.UpdateItemRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateItemRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the input of an UpdateItem operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description
`UpdateItemRequest()` Default 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateItemRequest`	`addAttributeUpdatesEntry(String key, AttributeValueUpdate value)`
`UpdateItemRequest`	`addExpectedEntry(String key, ExpectedAttributeValue value)`
`UpdateItemRequest`	`addExpressionAttributeNamesEntry(String key, String value)`
`UpdateItemRequest`	`addExpressionAttributeValuesEntry(String key, AttributeValue value)`
`UpdateItemRequest`	`addKeyEntry(String key, AttributeValue value)`
`UpdateItemRequest`	`clearAttributeUpdatesEntries()` Removes all the entries added into AttributeUpdates.
`UpdateItemRequest`	`clearExpectedEntries()` Removes all the entries added into Expected.
`UpdateItemRequest`	`clearExpressionAttributeNamesEntries()` Removes all the entries added into ExpressionAttributeNames.
`UpdateItemRequest`	`clearExpressionAttributeValuesEntries()` Removes all the entries added into ExpressionAttributeValues.
`UpdateItemRequest`	`clearKeyEntries()` Removes all the entries added into Key.
`UpdateItemRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Map<String,AttributeValueUpdate>`	`getAttributeUpdates()` This is a legacy parameter.
`String`	`getConditionalOperator()` This is a legacy parameter.
`String`	`getConditionExpression()` A condition that must be satisfied in order for a conditional update to succeed.
`Map<String,ExpectedAttributeValue>`	`getExpected()` This is a legacy parameter.
`Map<String,String>`	`getExpressionAttributeNames()` One or more substitution tokens for attribute names in an expression.
`Map<String,AttributeValue>`	`getExpressionAttributeValues()` One or more values that can be substituted in an expression.
`Map<String,AttributeValue>`	`getKey()` The primary key of the item to be updated.
`String`	`getReturnConsumedCapacity()`
`String`	`getReturnItemCollectionMetrics()` Determines whether item collection metrics are returned.
`String`	`getReturnValues()` Use `ReturnValues` if you want to get the item attributes as they appeared either before or after they were updated.
`String`	`getTableName()` The name of the table containing the item to update.
`String`	`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.
`int`	`hashCode()`
`void`	`setAttributeUpdates(Map<String,AttributeValueUpdate> attributeUpdates)` This is a legacy parameter.
`void`	`setConditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`void`	`setConditionalOperator(String conditionalOperator)` This is a legacy parameter.
`void`	`setConditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional update to succeed.
`void`	`setExpected(Map<String,ExpectedAttributeValue> expected)` This is a legacy parameter.
`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.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateItemRequest`	`withAttributeUpdates(Map<String,AttributeValueUpdate> attributeUpdates)` This is a legacy parameter.
`UpdateItemRequest`	`withConditionalOperator(ConditionalOperator conditionalOperator)` This is a legacy parameter.
`UpdateItemRequest`	`withConditionalOperator(String conditionalOperator)` This is a legacy parameter.
`UpdateItemRequest`	`withConditionExpression(String conditionExpression)` A condition that must be satisfied in order for a conditional update to succeed.
`UpdateItemRequest`	`withExpected(Map<String,ExpectedAttributeValue> expected)` This is a legacy parameter.
`UpdateItemRequest`	`withExpressionAttributeNames(Map<String,String> expressionAttributeNames)` One or more substitution tokens for attribute names in an expression.
`UpdateItemRequest`	`withExpressionAttributeValues(Map<String,AttributeValue> expressionAttributeValues)` One or more values that can be substituted in an expression.
`UpdateItemRequest`	`withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey)` Set the hash and range key attributes of the item.
`UpdateItemRequest`	`withKey(Map<String,AttributeValue> key)` The primary key of the item to be updated.
`UpdateItemRequest`	`withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)`
`UpdateItemRequest`	`withReturnConsumedCapacity(String returnConsumedCapacity)`
`UpdateItemRequest`	`withReturnItemCollectionMetrics(ReturnItemCollectionMetrics returnItemCollectionMetrics)` Determines whether item collection metrics are returned.
`UpdateItemRequest`	`withReturnItemCollectionMetrics(String returnItemCollectionMetrics)` Determines whether item collection metrics are returned.
`UpdateItemRequest`	`withReturnValues(ReturnValue returnValues)` Use `ReturnValues` if you want to get the item attributes as they appeared either before or after they were updated.
`UpdateItemRequest`	`withReturnValues(String returnValues)` Use `ReturnValues` if you want to get the item attributes as they appeared either before or after they were updated.
`UpdateItemRequest`	`withTableName(String tableName)` The name of the table containing the item to update.
`UpdateItemRequest`	`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 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - 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. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
  - 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. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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 Detail
  - setTableName
```
public void setTableName(String tableName)
```
    The name of the table containing the item to update.
    
    Parameters:
    
    tableName - The name of the table containing the item to update.
  - getTableName
```
public String getTableName()
```
    The name of the table containing the item to update.
    
    Returns:
    
    The name of the table containing the item to update.
  - withTableName
```
public UpdateItemRequest withTableName(String tableName)
```
    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
```
public Map<String,AttributeValue> 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
```
public void setKey(Map<String,AttributeValue> 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.
    
    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
```
public UpdateItemRequest withKey(Map<String,AttributeValue> 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.
    
    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
```
public UpdateItemRequest addKeyEntry(String key,
                                     AttributeValue value)
```
  - clearKeyEntries
```
public UpdateItemRequest clearKeyEntries()
```
    Removes all the entries added into Key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAttributeUpdates
```
public Map<String,AttributeValueUpdate> getAttributeUpdates()
```
    This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
  - setAttributeUpdates
```
public void setAttributeUpdates(Map<String,AttributeValueUpdate> attributeUpdates)
```
    This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    attributeUpdates - This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
  - withAttributeUpdates
```
public UpdateItemRequest withAttributeUpdates(Map<String,AttributeValueUpdate> attributeUpdates)
```
    This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    attributeUpdates - This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAttributeUpdatesEntry
```
public UpdateItemRequest addAttributeUpdatesEntry(String key,
                                                  AttributeValueUpdate value)
```
  - clearAttributeUpdatesEntries
```
public UpdateItemRequest clearAttributeUpdatesEntries()
```
    Removes all the entries added into AttributeUpdates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpected
```
public Map<String,ExpectedAttributeValue> getExpected()
```
    This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
  - setExpected
```
public void setExpected(Map<String,ExpectedAttributeValue> expected)
```
    This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expected - This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
  - withExpected
```
public UpdateItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
```
    This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    expected - This is a legacy parameter. Use ConditionExpresssion instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExpectedEntry
```
public UpdateItemRequest addExpectedEntry(String key,
                                          ExpectedAttributeValue value)
```
  - clearExpectedEntries
```
public UpdateItemRequest clearExpectedEntries()
```
    Removes all the entries added into Expected.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConditionalOperator
```
public void setConditionalOperator(String conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - getConditionalOperator
```
public String getConditionalOperator()
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - withConditionalOperator
```
public UpdateItemRequest withConditionalOperator(String conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator
  - setConditionalOperator
```
public void setConditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    See Also:
    
    ConditionalOperator
  - withConditionalOperator
```
public UpdateItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
```
    This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Parameters:
    
    conditionalOperator - This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ConditionalOperator
  - setReturnValues
```
public void setReturnValues(String 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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    - UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    - ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    - UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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:
    
    ReturnValue
  - getReturnValues
```
public String 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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    - UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    - ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    - UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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:
    
    ReturnValue
  - withReturnValues
```
public UpdateItemRequest withReturnValues(String 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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    - UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    - ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    - UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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:
    
    ReturnValue
  - setReturnValues
```
public void setReturnValues(ReturnValue 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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    - UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    - ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    - UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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:
    
    ReturnValue
  - withReturnValues
```
public UpdateItemRequest withReturnValues(ReturnValue 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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    - ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    - UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    - ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    - UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    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 is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
    
    ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
    
    UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
    
    ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
    
    UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.
    
    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:
    
    ReturnValue
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(String returnConsumedCapacity)
```
    Parameters:
    
    returnConsumedCapacity -
    
    See Also:
    
    ReturnConsumedCapacity
  - getReturnConsumedCapacity
```
public String getReturnConsumedCapacity()
```
    Returns:
    
    See Also:
    
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public UpdateItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
```
    Parameters:
    
    returnConsumedCapacity -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnConsumedCapacity
  - setReturnConsumedCapacity
```
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    Parameters:
    
    returnConsumedCapacity -
    
    See Also:
    
    ReturnConsumedCapacity
  - withReturnConsumedCapacity
```
public UpdateItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
```
    Parameters:
    
    returnConsumedCapacity -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnConsumedCapacity
  - setReturnItemCollectionMetrics
```
public void setReturnItemCollectionMetrics(String 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 to NONE (the default), no statistics are returned.
    
    Parameters:
    
    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 to NONE (the default), no statistics are returned.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - getReturnItemCollectionMetrics
```
public String 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 to NONE (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 to NONE (the default), no statistics are returned.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - withReturnItemCollectionMetrics
```
public UpdateItemRequest withReturnItemCollectionMetrics(String 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 to NONE (the default), no statistics are returned.
    
    Parameters:
    
    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 to NONE (the default), no statistics are returned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - setReturnItemCollectionMetrics
```
public void setReturnItemCollectionMetrics(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 to NONE (the default), no statistics are returned.
    
    Parameters:
    
    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 to NONE (the default), no statistics are returned.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - 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 to NONE (the default), no statistics are returned.
    
    Parameters:
    
    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 to NONE (the default), no statistics are returned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ReturnItemCollectionMetrics
  - setUpdateExpression
```
public 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.
    
    The following action values are available for UpdateExpression.
    - SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. 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, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
      
      list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
      
      These function names are case-sensitive.
    - REMOVE - Removes one or more attributes from an item.
    - ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
      
      If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
      
      If you use 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 uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
      
      If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
      
      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
      
      The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
    - DELETE - Deletes an element from a set.
      
      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE 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.
    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 use SET 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, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
    
    list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
    
    These function names are case-sensitive.
    
    REMOVE - Removes one or more attributes from an item.
    
    ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    
    If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
    
    If you use 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 uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
    
    If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3] . An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
    
    Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
    
    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
    
    DELETE - Deletes an element from a set.
    
    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE 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.
  - getUpdateExpression
```
public String 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 use SET 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, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
      
      list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
      
      These function names are case-sensitive.
    - REMOVE - Removes one or more attributes from an item.
    - ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
      
      If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
      
      If you use 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 uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
      
      If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
      
      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
      
      The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
    - DELETE - Deletes an element from a set.
      
      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE 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.
    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 use SET 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, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
    
    list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
    
    These function names are case-sensitive.
    
    REMOVE - Removes one or more attributes from an item.
    
    ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    
    If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
    
    If you use 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 uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
    
    If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
    
    Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
    
    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
    
    DELETE - Deletes an element from a set.
    
    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE 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.
  - withUpdateExpression
```
public UpdateItemRequest 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.
    
    The following action values are available for UpdateExpression.
    - SET - Adds one or more attributes and values to an item. If any of these attribute already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. 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, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
      
      list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
      
      These function names are case-sensitive.
    - REMOVE - Removes one or more attributes from an item.
    - ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
      
      If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
      
      If you use 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 uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
      
      If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
      
      Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
      
      The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
    - DELETE - Deletes an element from a set.
      
      If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE 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.
    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 use SET 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, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
    
    list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
    
    These function names are case-sensitive.
    
    REMOVE - Removes one or more attributes from an item.
    
    ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
    
    If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
    
    If you use 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 uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
    
    If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3] . An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
    
    Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
    
    The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
    
    DELETE - Deletes an element from a set.
    
    If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setConditionExpression
```
public void setConditionExpression(String 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.
    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.
  - getConditionExpression
```
public String 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.
    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.
  - withConditionExpression
```
public UpdateItemRequest withConditionExpression(String 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.
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeNames
```
public Map<String,String> 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
```
public void setExpressionAttributeNames(Map<String,String> 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.
    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
```
public UpdateItemRequest withExpressionAttributeNames(Map<String,String> 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.
    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
```
public UpdateItemRequest addExpressionAttributeNamesEntry(String key,
                                                          String value)
```
  - clearExpressionAttributeNamesEntries
```
public UpdateItemRequest clearExpressionAttributeNamesEntries()
```
    Removes all the entries added into ExpressionAttributeNames.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExpressionAttributeValues
```
public Map<String,AttributeValue> 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
```
public void setExpressionAttributeValues(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.
  - 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
```
public UpdateItemRequest addExpressionAttributeValuesEntry(String key,
                                                           AttributeValue value)
```
  - clearExpressionAttributeValuesEntries
```
public UpdateItemRequest clearExpressionAttributeValuesEntries()
```
    Removes all the entries added into ExpressionAttributeValues.
    
    Returns:
    
    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,AttributeValue> rangeKey)
            throws IllegalArgumentException
```
    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,AttributeValue> rangeKey)
                          throws IllegalArgumentException
```
    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
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public UpdateItemRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class UpdateItemRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateItemRequest

UpdateItemRequest

UpdateItemRequest

UpdateItemRequest

Method Detail

setTableName

getTableName

withTableName

getKey

setKey

withKey

addKeyEntry

clearKeyEntries

getAttributeUpdates

setAttributeUpdates

withAttributeUpdates

addAttributeUpdatesEntry

clearAttributeUpdatesEntries

getExpected

setExpected

withExpected

addExpectedEntry

clearExpectedEntries

setConditionalOperator

getConditionalOperator

withConditionalOperator

setConditionalOperator

withConditionalOperator

setReturnValues

getReturnValues

withReturnValues

setReturnValues

withReturnValues

setReturnConsumedCapacity

getReturnConsumedCapacity

withReturnConsumedCapacity

setReturnConsumedCapacity

withReturnConsumedCapacity

setReturnItemCollectionMetrics

getReturnItemCollectionMetrics

withReturnItemCollectionMetrics

setReturnItemCollectionMetrics

withReturnItemCollectionMetrics

setUpdateExpression

getUpdateExpression

withUpdateExpression

setConditionExpression

getConditionExpression

withConditionExpression

getExpressionAttributeNames

setExpressionAttributeNames

withExpressionAttributeNames

addExpressionAttributeNamesEntry

clearExpressionAttributeNamesEntries

getExpressionAttributeValues

setExpressionAttributeValues

withExpressionAttributeValues

addExpressionAttributeValuesEntry

clearExpressionAttributeValuesEntries

setKey

withKey

toString

equals

hashCode

clone