AWS SDK for .NET Documentation
UpdateItemRequest Class
Amazon ► Amazon.DynamoDBv2.Model ► UpdateItemRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the UpdateItem operation.

Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

In addition to updating an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Declaration Syntax
C#
public class UpdateItemRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
UpdateItemRequest()()()()
Initializes a new instance of the UpdateItemRequest class

AttributeUpdates
The names of attributes to be modified, the action to perform on each, and the new value for each. If you are updating an attribute that is an index key attribute for any indexes on that table, the attribute type must match the index key type defined in the AttributesDefinition of the table description. You can use UpdateItem to update any non-key attributes. Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes must not be empty. Requests with empty values will be rejected with a ValidationException. Each AttributeUpdates element consists of an attribute name to modify, along with the following:
  • Value - The new value, if applicable, for this attribute.
  • Action - Specifies how to perform the update. Valid values for Action are PUT, DELETE, and ADD. The behavior depends on whether the specified primary key already exists in the table. If an item with the specified Key is found in the table:
    • PUT - Adds the specified attribute to the item. If the attribute already exists, it is replaced by the new value.
    • DELETE - If no value is specified, the attribute and its value are removed from the item. The data type of the specified value must match the existing value's data type. 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 specified [a,c], then the final attribute value would be [b]. Specifying an empty set is an error.
    • ADD - If the attribute does not already exist, then the attribute and its values are added to the item. 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 the Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
        Note:
        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. In addition, if you use ADD to update an existing item, and intend to increment or decrement an attribute value which does not yet exist, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update does not yet have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway, even though it currently does not exist. 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 the Value is also a set, then the Value is added to the existing set. (This is a set operation, not mathematical addition.) For example, if the attribute value was the set [1,2], and the ADD action specified [3], then the final attribute value would be [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 same holds true for number sets and binary sets.
      This action is only valid for an existing attribute whose data type is number or is a set. Do not use ADD for any other data types.
    If no item with the specified Key is found:
    • PUT - DynamoDB creates a new item with the specified primary key, and then adds the attribute.
    • DELETE - Nothing happens; there is no attribute to delete.
    • ADD - DynamoDB creates an item with the supplied primary key and number (or set of numbers) for the attribute value. The only data types allowed are number and number set; no other data types can be specified.
If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

ConditionalOperator
A logical operator to apply to the conditions in the Expected map:
  • AND - If all of the conditions evaluate to true, then the entire map evaluates to true.
  • OR - If at least one of the conditions evaluate to true, then the entire map evaluates to true.
If you omit ConditionalOperator, then AND is used as the default. The operation will succeed only if the entire map evaluates to true.

Constraints:

Allowed Values
AND, OR


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Expected
A map of attribute/condition pairs. This is the conditional block for the UpdateItem operation. All the conditions must evaluate to true for the operation to succeed. Expected allows you to provide an attribute name, and whether or not DynamoDB should check to see if the attribute value already exists; or if the attribute value exists and has a particular value before changing it. Each item in Expected represents an attribute name for DynamoDB to check, along with the following:
  • Value - A value for DynamoDB to compare with an attribute. When performing the comparison, strongly consistent reads are used.
  • Exists - Causes DynamoDB to evaluate the value before attempting a conditional operation:
    • If Exists is true, DynamoDB will check to see if that attribute value already exists in the table. If it is found, then the operation succeeds. If it is not found, the operation fails with a ConditionalCheckFailedException.
    • If Exists is false, DynamoDB assumes that the attribute value does not exist in the table. If in fact the value does not exist, then the assumption is valid and the operation succeeds. If the value is found, despite the assumption that it does not exist, the operation fails with a ConditionalCheckFailedException.
    The default setting for Exists is true. If you supply a Value all by itself, DynamoDB assumes the attribute exists: You don't have to set Exists to true, because it is implied. DynamoDB returns a ValidationException if:
    • Exists is true but there is no Value to check. (You expect a value to exist, but don't specify what that value is.)
    • Exists is false but you also specify a Value. (You cannot expect an attribute to have a value, while also expecting it not to exist.)
If you specify more than one condition in the Expected map, then by default all of the conditions must evaluate to true. In other words, the conditions are ANDed together. (You can use the ConditionalOperator parameter to OR the conditions instead. If you do this, then at least one of the conditions must evaluate to true, rather than all of them.) If Expected evaluates to true, then the conditional operation succeeds; otherwise, it fails.

GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Key
The primary key that defines the item. Each element consists of an attribute name and a value for that attribute.

ReturnConsumedCapacity
If set to TOTAL, the response includes ConsumedCapacity data for tables and indexes. If set to INDEXES, the response includes ConsumedCapacity for indexes. If set to NONE (the default), ConsumedCapacity is not included in the response.

Constraints:

Allowed Values
INDEXES, TOTAL, NONE


ReturnItemCollectionMetrics
If set to SIZE, 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.

Constraints:

Allowed Values
SIZE, NONE


ReturnValues
Use ReturnValues if you want to get the item attributes as they appeared either before or after they were updated. For UpdateItem, the valid values are:
  • NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This is the default for ReturnValues.)
  • ALL_OLD - If UpdateItem overwrote an attribute name-value pair, then the content of the old item is returned.
  • UPDATED_OLD - The old versions of only the updated attributes are returned.
  • ALL_NEW - All of the attributes of the new version of the item are returned.
  • UPDATED_NEW - The new versions of only the updated attributes are returned.

Constraints:

Allowed Values
NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW


TableName
The name of the table containing the item to update.

Constraints:

Length
3 - 255
Pattern
[a-zA-Z0-9_.-]+


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
WithAttributeUpdates(array<KeyValuePair<(Of <<'(String, AttributeValueUpdate>)>>)>[]()[][]) Obsolete.
Adds the KeyValuePairs to the AttributeUpdates dictionary.

WithConditionalOperator(String) Obsolete.
Sets the ConditionalOperator property

WithExpected(array<KeyValuePair<(Of <<'(String, ExpectedAttributeValue>)>>)>[]()[][]) Obsolete.
Adds the KeyValuePairs to the Expected dictionary.

WithKey(array<KeyValuePair<(Of <<'(String, AttributeValue>)>>)>[]()[][]) Obsolete.
Adds the KeyValuePairs to the Key dictionary.

WithReturnConsumedCapacity(String) Obsolete.
Sets the ReturnConsumedCapacity property

WithReturnItemCollectionMetrics(String) Obsolete.
Sets the ReturnItemCollectionMetrics property

WithReturnValues(String) Obsolete.
Sets the ReturnValues property

WithTableName(String) Obsolete.
Sets the TableName property

Examples

This example shows how to update an item in a table.

CopyUpdateItem sample
// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define item key
//  Hash-key of the target item is string value "Mark Twain"
//  Range-key of the target item is string value "The Adventures of Tom Sawyer"
Dictionary<string, AttributeValue> key = new Dictionary<string, AttributeValue>
{
    { "Author", new AttributeValue { S = "Mark Twain" } },
    { "Title", new AttributeValue { S = "The Adventures of Tom Sawyer" } }
};

// Define attribute updates
Dictionary<string, AttributeValueUpdate> updates = new Dictionary<string, AttributeValueUpdate>();
// Update item's Setting attribute
updates["Setting"] = new AttributeValueUpdate()
    .WithAction("PUT")
    .WithValue(new AttributeValue { S = "St. Petersburg, Missouri" });
// Remove item's Bibliography attribute
updates["Bibliography"] = new AttributeValueUpdate()
    .WithAction("DELETE");
// Add a new string to the item's Genres SS attribute
updates["Genres"] = new AttributeValueUpdate()
    .WithAction("ADD")
    .WithValue(new AttributeValue { SS = new List<string> { "Bildungsroman" } });

// Create UpdateItem request
UpdateItemRequest request = new UpdateItemRequest
{
    TableName = "SampleTable",
    Key = key,
    AttributeUpdates = updates
};

// Issue request
client.UpdateItem(request);
Inheritance Hierarchy
Object
AmazonWebServiceRequest
 UpdateItemRequest
See Also
UpdateItem(UpdateItemRequest)

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)