Update
¶
Source code in docs_src/capo_dynamodb/types/update.py
condition_expression
instance-attribute
¶
condition_expression: NotRequired[ConditionExpression]
A condition that must be satisfied in order for a conditional update to succeed.
expression_attribute_names
instance-attribute
¶
expression_attribute_names: NotRequired[ExpressionAttributeNameMap]
One or more substitution tokens for attribute names in an expression.
expression_attribute_values
instance-attribute
¶
expression_attribute_values: NotRequired[ExpressionAttributeValueMap]
One or more values that can be substituted in an expression.
key
instance-attribute
¶
key: Key
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.
return_values_on_condition_check_failure
instance-attribute
¶
return_values_on_condition_check_failure: NotRequired[
ReturnValuesOnConditionCheckFailure
]
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
table_name
instance-attribute
¶
table_name: TableArn
Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.
update_expression
instance-attribute
¶
update_expression: 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.