AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Represents a request to perform an UpdateItem operation.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.Model.Update

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

Syntax

C#
public class Update

The Update type exposes the following members

Constructors

NameDescription
Public Method Update()

Properties

NameTypeDescription
Public Property ConditionExpression System.String

Gets and sets the property ConditionExpression.

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

Public Property ExpressionAttributeNames System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property ExpressionAttributeNames.

One or more substitution tokens for attribute names in an expression.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ExpressionAttributeValues System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue>

Gets and sets the property ExpressionAttributeValues.

One or more values that can be substituted in an expression.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property Key System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.Model.AttributeValue>

Gets and sets the property Key.

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property ReturnValuesOnConditionCheckFailure Amazon.DynamoDBv2.ReturnValuesOnConditionCheckFailure

Gets and sets the property ReturnValuesOnConditionCheckFailure.

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Update condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

Public Property TableName System.String

Gets and sets the property TableName.

Name of the table for the UpdateItem request. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Public Property UpdateExpression System.String

Gets and sets the property UpdateExpression.

An expression that defines one or more attributes to be updated, the action to be performed on them, and new value(s) for them.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer