Skip to main content

ReturnValues

All write operations (put, update, delete) accept return_values= to get the previous or updated item back.

Get Overwritten Item​

old = orders.put(
    user_id="usr_1", order_id="ord_1", status="NEW",
    return_values="ALL_OLD"
)

Get Updated Item​

updated = orders.update(
    user_id="usr_1", order_id="ord_1",
    set={"status": "SHIPPED"},
    return_values="ALL_NEW"
)

Get Deleted Item​

deleted = orders.delete(
    user_id="usr_1", order_id="ord_1",
    return_values="ALL_OLD"
)

Valid Values​

ValueDescription
"NONE"No item returned (default)
"ALL_OLD"Entire item before operation
"ALL_NEW"Entire item after operation
"UPDATED_OLD"Only updated attributes before
"UPDATED_NEW"Only updated attributes after

See DynamoDB docs for which values apply to each operation.