AWS SDK Version 3 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.

Expressions are used for conditional deletes and filtering for query and scan operations.

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.Expression

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

Syntax

C#
public class Expression

The Expression type exposes the following members

Constructors

NameDescription
Public Method Expression()

Properties

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

Gets and sets the property ExpressionAttributeNames. This collection contains attribute names from the item that should be substituted in the expression when it is evaluated. For example the expression "#C < #U" will expect the attribute names to be added to this collection.

expression.ExpressionAttributeNames["#C"] = "CriticRating"
expression.ExpressionAttributeNames["#U"] = "UserRating"
            

Public Property ExpressionAttributeValues System.Collections.Generic.Dictionary<System.String, Amazon.DynamoDBv2.DocumentModel.DynamoDBEntry>

Gets and sets the property ExpressionAttributeValues. This collection contains the values to be substituted in the expression. For example the expression "Price > :price" will contain one entry in this collection a key of ":price".

DynamoDBEntry contains many common implicit cast operations so assignment can be done with the basic .NET types. In the price example shown above the value to be used for the expression can be provided using the following code snippet:

expression.ExpressionAttributeValues[":price"] = 3.99;
            

Public Property ExpressionStatement System.String

Gets and sets the property ExpressionStatement. "Price > :price" is an example expression statement. :price is a variable which gets its value from the ExpressionAttributeValues collection. If this is used for deletes then it prevents the delete from happening if the Price attribute on the item is less then the passed in price. For query and scan it will only return back items where the Price attribute is greater then passed in price.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

Unity:
Supported Versions: 4.6 and above
Supported Platforms: Android, iOS, Standalone