UpdateItemRequest
Represents the input of an UpdateItem
operation.
Types
Properties
This is a legacy parameter. Use UpdateExpression
instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.
This is a legacy parameter. Use ConditionExpression
instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.
A condition that must be satisfied in order for a conditional update to succeed.
One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames
:
One or more values that can be substituted in an expression.
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:
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.
Use ReturnValues
if you want to get the item attributes as they appear before or after they are successfully updated. For UpdateItem
, the valid values are:
An optional parameter that returns the item attributes for an UpdateItem
operation that failed a condition check.
An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.