Container for the parameters to the UpdateItem operation.

Edits an existing item's attributes.

You can 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).

Namespace: Amazon.DynamoDB.Model
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)

Syntax

         
 C#  Visual Basic  Visual C++ 
public class UpdateItemRequest : AmazonWebServiceRequest
Public Class UpdateItemRequest _
	Inherits AmazonWebServiceRequest
public ref class UpdateItemRequest : public AmazonWebServiceRequest

Members

            
 All Members  Constructors   Properties   Methods  
 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

 MemberDescription
UpdateItemRequest()()()()
Initializes a new instance of the UpdateItemRequest class
AttributeUpdates
Map of attribute name to the new value and action for the update. The attribute names specify the attributes to modify, and cannot contain any primary key attributes.
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Expected
Designates an attribute for a conditional modification. The Expected parameter allows you to provide an attribute name, and whether or not Amazon DynamoDB should check to see if the attribute has a particular value before modifying it.
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 uniquely identifies each item in a table. A primary key can be a one attribute (hash) primary key or a two attribute (hash-and-range) primary key.
ReturnValues
Use this parameter if you want to get the attribute name-value pairs before or after they are modified. For PUT operations, the possible parameter values are NONE (default) or ALL_OLD. For update operations, the possible parameter values are NONE (default) or ALL_OLD, UPDATED_OLD, ALL_NEW or UPDATED_NEW.
  • NONE: Nothing is returned.
  • ALL_OLD: Returns the attributes of the item as they were before the operation.
  • UPDATED_OLD: Returns the values of the updated attributes, only, as they were before the operation.
  • ALL_NEW: Returns all the attributes and their new values after the operation.
  • UPDATED_NEW: Returns the values of the updated attributes, only, as they are after the operation.

Constraints:

Allowed Values
NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW

TableName
The name of the table in which you want to update an item. Allowed characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and . (period).

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>)>>)>[]()[][])
Adds the KeyValuePairs to the AttributeUpdates dictionary.
WithExpected(array<KeyValuePair<(Of <<'(String, ExpectedAttributeValue>)>>)>[]()[][])
Adds the KeyValuePairs to the Expected dictionary.
WithKey(Key)
Sets the Key property
WithReturnValues(String)
Sets the ReturnValues property
WithTableName(String)
Sets the TableName property

Inheritance Hierarchy

System..::..Object
  Amazon.Runtime..::..AmazonWebServiceRequest
    Amazon.DynamoDB.Model..::..UpdateItemRequest

See Also