Skip to content

Update item

async_boto.validation.dynamodb.update_item

UpdateItemRequest

Bases: BaseModel

Request model for the UpdateItem operation.

ATTRIBUTE DESCRIPTION
Key

The primary key of the item to be updated.

TYPE: Dict[str, AttributeValue]

TableName

The name of the table containing the item to update.

TYPE: constr(min_length=1, max_length=1024)

AttributeUpdates

Legacy parameter for attribute updates.

TYPE: Optional[Dict[str, AttributeValueUpdate]]

ConditionalOperator

Legacy parameter for conditional operator.

TYPE: Optional[Literal['AND', 'OR']]

ConditionExpression

A condition that must be satisfied for a conditional update to succeed.

TYPE: Optional[str]

Expected

Legacy parameter for expected attribute values.

TYPE: Optional[Dict[str, ExpectedAttributeValue]]

ExpressionAttributeNames

Substitution tokens for attribute names in an expression.

TYPE: Optional[Dict[str, str]]

ExpressionAttributeValues

Values that can be substituted in an expression.

TYPE: Optional[Dict[str, AttributeValue]]

ReturnConsumedCapacity

Level of detail about throughput consumption to be returned.

TYPE: Optional[Literal['INDEXES', 'TOTAL', 'NONE']]

ReturnItemCollectionMetrics

Whether item collection metrics are returned.

TYPE: Optional[Literal['SIZE', 'NONE']]

ReturnValues

TYPE: Optional[Literal["NONE", "ALL_OLD", "UPDATED_OLD", "ALL_NEW",

"UPDATED_NEW"]]

The item attributes to return as they appear before or after the update.

ReturnValuesOnConditionCheckFailure

The item attributes to return if the update fails a condition check.

TYPE: Optional[Literal['ALL_OLD', 'NONE']]

UpdateExpression

An expression that defines one or more attributes to be updated.

TYPE: Optional[str]

Key instance-attribute

Key

TableName instance-attribute

TableName

AttributeUpdates class-attribute instance-attribute

AttributeUpdates = None

ConditionalOperator class-attribute instance-attribute

ConditionalOperator = None

ConditionExpression class-attribute instance-attribute

ConditionExpression = None

Expected class-attribute instance-attribute

Expected = None

ExpressionAttributeNames class-attribute instance-attribute

ExpressionAttributeNames = None

ExpressionAttributeValues class-attribute instance-attribute

ExpressionAttributeValues = None

ReturnConsumedCapacity class-attribute instance-attribute

ReturnConsumedCapacity = None

ReturnItemCollectionMetrics class-attribute instance-attribute

ReturnItemCollectionMetrics = None

ReturnValues class-attribute instance-attribute

ReturnValues = None

ReturnValuesOnConditionCheckFailure class-attribute instance-attribute

ReturnValuesOnConditionCheckFailure = None

UpdateExpression class-attribute instance-attribute

UpdateExpression = None

UpdateItemResponse

Bases: BaseModel

Response model for the UpdateItem operation.

ATTRIBUTE DESCRIPTION
Attributes

A map of attribute values as they appear before or after the UpdateItem operation.

TYPE: Optional[Dict[str, AttributeValue]]

ConsumedCapacity

The capacity units consumed by the UpdateItem operation.

TYPE: Optional[ConsumedCapacity]

ItemCollectionMetrics

Information about item collections affected by the UpdateItem operation.

TYPE: Optional[ItemCollectionMetrics]

Attributes class-attribute instance-attribute

Attributes = None

ConsumedCapacity class-attribute instance-attribute

ConsumedCapacity = None

ItemCollectionMetrics class-attribute instance-attribute

ItemCollectionMetrics = None