AmazonDynamoDBClient.UpdateItem Method (UpdateItemRequest)

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (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).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateItemAsync.

Namespace: Amazon.DynamoDBv2
Assembly: AWSSDK.DynamoDBv2.dll
Version: 3.x.y.z

Syntax

public virtual UpdateItemResponse UpdateItem(
         UpdateItemRequest request
)

Parameters

request: Type: Amazon.DynamoDBv2.Model.UpdateItemRequest

Container for the necessary parameters to execute the UpdateItem service method.

Return Value

Type: UpdateItemResponse

The response from the UpdateItem service method, as returned by DynamoDB.

Exceptions

Exception	Condition
ConditionalCheckFailedException	A condition specified in the operation could not be evaluated.
InternalServerErrorException	An error occurred on the server side.
ItemCollectionSizeLimitExceededException	An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.
ProvisionedThroughputExceededException	Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.
RequestLimitExceededException	Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.
ResourceNotFoundException	The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
TransactionConflictException	Operation was rejected because there is an ongoing transaction for the item.

Examples

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

UpdateItem 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()
{
    Action = AttributeAction.PUT,
    Value = new AttributeValue { S = "St. Petersburg, Missouri" }
};
// Remove item's Bibliography attribute
updates["Bibliography"] = new AttributeValueUpdate()
{
    Action = AttributeAction.DELETE
};   
// Add a new string to the item's Genres SS attribute
updates["Genres"] = new AttributeValueUpdate()
{
    Action = AttributeAction.ADD,
    Value = 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);

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonDynamoDBClient.UpdateItem (UpdateItemRequest)

Method