@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateItemRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the input of an UpdateItem
operation.
NOOP
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.
|
Modifier and Type | Method and Description |
---|---|
UpdateItemRequest |
addAttributeUpdatesEntry(String key,
AttributeValueUpdate value)
Add a single AttributeUpdates entry
|
UpdateItemRequest |
addExpectedEntry(String key,
ExpectedAttributeValue value)
Add a single Expected entry
|
UpdateItemRequest |
addExpressionAttributeNamesEntry(String key,
String value)
Add a single ExpressionAttributeNames entry
|
UpdateItemRequest |
addExpressionAttributeValuesEntry(String key,
AttributeValue value)
Add a single ExpressionAttributeValues entry
|
UpdateItemRequest |
addKeyEntry(String key,
AttributeValue value)
Add a single Key entry
|
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() |
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 appear before or after they are
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
values 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 appear before or after they are
updated. |
void |
setReturnValues(String returnValues)
Use
ReturnValues if you want to get the item attributes as they appear before or after they are
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
values for them.
|
String |
toString()
Returns a string representation of this object.
|
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 appear before or after they are
updated. |
UpdateItemRequest |
withReturnValues(String returnValues)
Use
ReturnValues if you want to get the item attributes as they appear before or after they are
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
values for them.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public UpdateItemRequest()
public UpdateItemRequest(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates)
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.public UpdateItemRequest(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates, String returnValues)
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 appear before or after they
are 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.
The values returned are strongly consistent.
public UpdateItemRequest(String tableName, Map<String,AttributeValue> key, Map<String,AttributeValueUpdate> attributeUpdates, ReturnValue returnValues)
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 appear before or after they
are 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.
The values returned are strongly consistent.
public void setTableName(String tableName)
The name of the table containing the item to update.
tableName
- The name of the table containing the item to update.public String getTableName()
The name of the table containing the item to update.
public UpdateItemRequest withTableName(String tableName)
The name of the table containing the item to update.
tableName
- The name of the table containing the item to update.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.
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.
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.
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.
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.
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.
public UpdateItemRequest addKeyEntry(String key, AttributeValue value)
public UpdateItemRequest clearKeyEntries()
public Map<String,AttributeValueUpdate> getAttributeUpdates()
This is a legacy parameter. Use UpdateExpression
instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
UpdateExpression
instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.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.
attributeUpdates
- This is a legacy parameter. Use UpdateExpression
instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.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.
attributeUpdates
- This is a legacy parameter. Use UpdateExpression
instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.public UpdateItemRequest addAttributeUpdatesEntry(String key, AttributeValueUpdate value)
public UpdateItemRequest clearAttributeUpdatesEntries()
public Map<String,ExpectedAttributeValue> getExpected()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public void setExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public UpdateItemRequest withExpected(Map<String,ExpectedAttributeValue> expected)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.
expected
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.public UpdateItemRequest addExpectedEntry(String key, ExpectedAttributeValue value)
public UpdateItemRequest clearExpectedEntries()
public void setConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public String getConditionalOperator()
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public UpdateItemRequest withConditionalOperator(String conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public void setConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public UpdateItemRequest withConditionalOperator(ConditionalOperator conditionalOperator)
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
conditionalOperator
- This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.ConditionalOperator
public void setReturnValues(String returnValues)
Use ReturnValues
if you want to get the item attributes as they appear before or after they are
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.
The values returned are strongly consistent.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appear before or after they
are 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.
The values returned are strongly consistent.
ReturnValue
public String getReturnValues()
Use ReturnValues
if you want to get the item attributes as they appear before or after they are
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.
The values returned are strongly consistent.
ReturnValues
if you want to get the item attributes as they appear before or after they
are 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.
The values returned are strongly consistent.
ReturnValue
public UpdateItemRequest withReturnValues(String returnValues)
Use ReturnValues
if you want to get the item attributes as they appear before or after they are
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.
The values returned are strongly consistent.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appear before or after they
are 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.
The values returned are strongly consistent.
ReturnValue
public void setReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as they appear before or after they are
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.
The values returned are strongly consistent.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appear before or after they
are 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.
The values returned are strongly consistent.
ReturnValue
public UpdateItemRequest withReturnValues(ReturnValue returnValues)
Use ReturnValues
if you want to get the item attributes as they appear before or after they are
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.
The values returned are strongly consistent.
returnValues
- Use ReturnValues
if you want to get the item attributes as they appear before or after they
are 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.
The values returned are strongly consistent.
ReturnValue
public void setReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public String getReturnConsumedCapacity()
ReturnConsumedCapacity
public UpdateItemRequest withReturnConsumedCapacity(String returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public void setReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
public UpdateItemRequest withReturnConsumedCapacity(ReturnConsumedCapacity returnConsumedCapacity)
returnConsumedCapacity
- ReturnConsumedCapacity
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.
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.ReturnItemCollectionMetrics
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.
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.ReturnItemCollectionMetrics
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.
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.ReturnItemCollectionMetrics
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.
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.ReturnItemCollectionMetrics
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.
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.ReturnItemCollectionMetrics
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 values 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 attributes 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.
updateExpression
- An expression that defines one or more attributes to be updated, the action to be performed on them, and
new values 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 attributes 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.
public String getUpdateExpression()
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values 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 attributes 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.
The following action values are available for UpdateExpression
.
SET
- Adds one or more attributes and values to an item. If any of these attributes 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.
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 values 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 attributes 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.
updateExpression
- An expression that defines one or more attributes to be updated, the action to be performed on them, and
new values 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 attributes 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.
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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.
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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
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 about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.
public UpdateItemRequest addExpressionAttributeNamesEntry(String key, String value)
public UpdateItemRequest clearExpressionAttributeNamesEntries()
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 Condition Expressions in the Amazon DynamoDB Developer Guide.
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 Condition Expressions in the Amazon DynamoDB Developer Guide.
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 Condition Expressions in the Amazon DynamoDB Developer Guide.
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 Condition Expressions in the Amazon DynamoDB Developer Guide.
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 Condition Expressions in the Amazon DynamoDB Developer Guide.
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 Condition Expressions in the Amazon DynamoDB Developer Guide.
public UpdateItemRequest addExpressionAttributeValuesEntry(String key, AttributeValue value)
public UpdateItemRequest clearExpressionAttributeValuesEntries()
public void setKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
For a hash-only table, you only need to provide the hash attribute. For a hash-and-range table, you must provide both.
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.IllegalArgumentException
public UpdateItemRequest withKey(Map.Entry<String,AttributeValue> hashKey, Map.Entry<String,AttributeValue> rangeKey) throws IllegalArgumentException
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.
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.IllegalArgumentException
public String toString()
toString
in class Object
Object.toString()
public UpdateItemRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2020. All rights reserved.