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.

Classes

NameDescription
Class ConditionExpressionBuilder

Class for building conditions used in DynamoDB expressions. Supports comparison, logical, and function-based conditions.

Class DeleteItemOperationConfig

Configuration for the Table.DeleteItem operation

Class Document

A collection of attribute key-value pairs that defines an item in DynamoDB.

Class DocumentBatchGet

Class for retrieving a batch of Documents from a single DynamoDB table.

Class DocumentBatchWrite

Class for putting and/or deleting a batch of items in a single DynamoDB table.

Class DocumentExtensions

Extensions methods Document type.

Class DocumentTransactGet

Class for retrieving multiple Documents from a single DynamoDB table in a transaction.

Class DocumentTransactWrite

Class for condition checking, putting, updating and/or deleting multiple items in a single DynamoDB table in a transaction.

Class DynamoDBAttributeType

Constants used for properties of type DynamoDB AttributeType.

Class DynamoDBBool

A DynamoDBEntry that represents a DynamoDB bool (BOOL) type.

Class DynamoDBEntry

Abstract class representing an arbitrary DynamoDB attribute value

Class DynamoDBList

A DynamoDBEntry that represents a DynamoDB list (L) type.

Class DynamoDBNull

A DynamoDBEntry that represents a DynamoDB null (NULL) type.

Class ExpectedState

Expected state of an item in DynamoDB.

Class ExpectedValue

Expected state of an attribute in DynamoDB. Exists cannot be set at the same time as Comparison and Values.

Class Expression

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

Class ExpressionBuilder

Abstract base class for building expressions used in DynamoDB operations. Provides a structure for managing conditions and operands that form the basis of an expression.

Class Filter

Filter for use with scan and query operations

Class GetItemOperationConfig

Configuration for the Table.GetItem operation

Class KeyDescription
Class MultiTableDocumentBatchGet

Class for retrieving a batch of Documents from multiple DynamoDB tables.

Class MultiTableDocumentBatchWrite

Class for putting and/or deleting a batch of items in multiple DynamoDB tables.

Class MultiTableDocumentTransactGet

Class for retrieving multiple Documents from multiple DynamoDB tables in a transaction.

Class MultiTableDocumentTransactWrite

Class for condition checking, putting, updating and/or deleting multiple items in multiple DynamoDB tables in a transaction.

Class NameBuilder

The Amazon.DynamoDBv2.DocumentModel.NameBuilder class is responsible for building attribute names for DynamoDB expressions. It allows the creation of conditions based on attribute names and supports various comparison, logical, and function-based operations.

Class OperandBuilder

Abstract base class for building operands used in DynamoDB expressions. Operands represent attribute names or values in an expression.

Class Primitive

A DynamoDBEntry that represents a scalar DynamoDB type

Class PrimitiveList

A DynamoDBEntry that represents a primitive list DynamoDB type

Class PutItemOperationConfig

Configuration for the Table.PutItem operation

Class QueryFilter

Query filter.

Class QueryOperationConfig

Configuration for the Table.Query operation

Class ScanFilter

Scan filter.

Class ScanOperationConfig

Configuration for the Table.Scan operation

Class Search

Search response object

Class SetValueBuilder

Class for building set value expressions used in DynamoDB.

Class Table

The Table class is the starting object when using the Document API. It is used to Get documents from the DynamoDB table and write documents back to the DynamoDB table.

Class TableBuilder

Builder that constructs a Amazon.DynamoDBv2.DocumentModel.Table
Class TableConfig

Configuration for the Table.PutItem operation

Class TransactGetItemOperationConfig

Configuration for a request item of the Table.DocumentTransactGet operation.

Class TransactWriteItemOperationConfig

Configuration for a request item of the Table.DocumentTransactWrite operation.

Class UpdateExpressionBuilder

The Amazon.DynamoDBv2.DocumentModel.UpdateExpressionBuilder class is used to construct update expressions for DynamoDB operations. An update expression consists of one or more clauses. Each clause begins with a SET, REMOVE, ADD, or DELETE keyword. You can include any of these clauses in an update expression, in any order.

Class UpdateItemOperationConfig

Configuration for the Table.UpdateItem operation

Class ValueBuilder

ValueBuilder is used to build attribute values for expressions.

Interfaces

NameDescription
Interface IDocumentBatchGet

Interface for retrieving a batch of Documents from a single DynamoDB table.

Interface IDocumentBatchWrite

Interface for putting and/or deleting a batch of items in a single DynamoDB table.

Interface IDocumentTransactGet

Class for retrieving multiple Documents from a single DynamoDB table in a transaction.

Interface IDocumentTransactWrite

Interface for condition checking, putting, updating and/or deleting multiple items in a single DynamoDB table in a transaction.

Interface IExpressionBuilder

Interface for building expressions used in DynamoDB operations.

Interface IMultiTableDocumentBatchGet

Interface for retrieving a batch of Documents from multiple DynamoDB tables.

Interface IMultiTableDocumentBatchWrite

Interface for putting and/or deleting a batch of items in multiple DynamoDB tables.

Interface IMultiTableDocumentTransactGet

Interface for retrieving multiple Documents from multiple DynamoDB tables in a transaction.

Interface IMultiTableDocumentTransactWrite

Interface for condition checking, putting, updating and/or deleting multiple items in multiple DynamoDB tables in a transaction.

Interface ISearch

Represents the interface for a search response

Interface ITable

This represents the table interface when using the Document API. It is used to Get documents from the DynamoDB table and write documents back to the DynamoDB table.

Interface ITableBuilder

Interface for a builder that constructs a Amazon.DynamoDBv2.DocumentModel.Table

Enums

NameDescription
Enum ConditionalOperatorValues

An enumeration of all supported ConditionalOperator values. Value of And for an operation will require that all conditions match. Value of Or for an operation will require that at least one of the conditons match.

Enum DynamoDBEntryType

Enumerator describing type of DynamoDB data in a Primitive or PrimitiveList

Enum QueryOperator

An enumeration of all supported query operator directives

Enum ReturnValues

An enumeration of all supported return value directives

Enum ReturnValuesOnConditionCheckFailure

An enumeration of supported return value directives for scenarios where attributes are returned when the condition check fails.

Enum ScanOperator

An enumeration of all supported scan operator directives

Enum SelectValues

An enumeration of all supported Select values for Query and Scan. Value of Count will force service to return the number of items, not the items themselves.