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.

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

Inheritance Hierarchy

System.Object
  Amazon.DynamoDBv2.DocumentModel.DocumentTransactWrite

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

Syntax

C# 
public class DocumentTransactWrite

The DocumentTransactWrite type exposes the following members

Constructors

NameDescription
Public Method DocumentTransactWrite(Table)

Constructs a DocumentTransactWrite instance for a specific table.

Properties

NameTypeDescription
Public Property ConditionCheckFailedItems System.Collections.Generic.List<Amazon.DynamoDBv2.DocumentModel.Document>

List of items retrieved from DynamoDB for which a condition check failure happened. Populated after Execute is called and a TransactionCanceledException happened due to a condition check failure. A document is only added to this list if ReturnValuesOnConditionCheckFailure has been set to AllOldAttributes for the corresponding item in the request.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AddDocumentToPut(Document, TransactWriteItemOperationConfig)

Add a single Document to put, using the specified config.

Public Method AddDocumentToUpdate(Document, Primitive, TransactWriteItemOperationConfig)

Add a single Document to update, identified by its hash primary key, using the specified config.

Public Method AddDocumentToUpdate(Document, Primitive, Primitive, TransactWriteItemOperationConfig)

Add a single Document to update, identified by its hash-and-range primary key, using the specified config.

Public Method AddDocumentToUpdate(Document, IDictionary<String, DynamoDBEntry>, TransactWriteItemOperationConfig)

Add a single Document to update, identified by its key, using the specified config.

Public Method AddDocumentToUpdate(Document, TransactWriteItemOperationConfig)

Add a single Document to update, using the specified config.

Public Method AddDocumentToUpdate(Primitive, Expression, TransactWriteItemOperationConfig)

Add a single item to update, identified by its hash primary key, using the specified update expression and config.

Public Method AddDocumentToUpdate(Primitive, Primitive, Expression, TransactWriteItemOperationConfig)

Add a single item to update, identified by its hash-and-range primary key, using the specified update expression and config.

Public Method AddDocumentToUpdate(IDictionary<String, DynamoDBEntry>, Expression, TransactWriteItemOperationConfig)

Add a single item to update, identified by its key, using the specified update expression and config.

Public Method AddItemToConditionCheck(Document, Expression)

Add a single item to condition check, identified by a Document object, using the specified condition expression.

Public Method AddItemToConditionCheck(Document, TransactWriteItemOperationConfig)

Add a single item to condition check, identified by a Document object, using the specified config.

Public Method AddItemToDelete(Document, TransactWriteItemOperationConfig)

Add a single item to delete, identified by a Document object, using the specified config.

Public Method AddKeyToConditionCheck(Primitive, Expression)

Add a single item to condition check, identified by its hash primary key, using the specified condition expression.

Public Method AddKeyToConditionCheck(Primitive, TransactWriteItemOperationConfig)

Add a single item to condition check, identified by its hash primary key, using the specified config.

Public Method AddKeyToConditionCheck(Primitive, Primitive, Expression)

Add a single item to condition check, identified by its hash-and-range primary key, using the specified condition expression.

Public Method AddKeyToConditionCheck(Primitive, Primitive, TransactWriteItemOperationConfig)

Add a single item to condition check, identified by its hash-and-range primary key, using the specified config.

Public Method AddKeyToConditionCheck(IDictionary<String, DynamoDBEntry>, Expression)

Add a single item to condition check, identified by its key, using the specified condition expression.

Public Method AddKeyToConditionCheck(IDictionary<String, DynamoDBEntry>, TransactWriteItemOperationConfig)

Add a single item to condition check, identified by its key, using the specified config.

Public Method AddKeyToDelete(Primitive, TransactWriteItemOperationConfig)

Add a single item to delete, identified by its hash primary key, using the specified config.

Public Method AddKeyToDelete(Primitive, Primitive, TransactWriteItemOperationConfig)

Add a single item to delete, identified by its hash-and-range primary key, using the specified config.

Public Method AddKeyToDelete(IDictionary<String, DynamoDBEntry>, TransactWriteItemOperationConfig)

Add a single item to delete, identified by its key, using the specified config.

Public Method Combine(DocumentTransactWrite)

Creates a MultiTableDocumentTransactWrite object that is a combination of the current DocumentTransactWrite and the specified DocumentTransactWrite.

Public Method Execute()

Executes a server call to condition-check/put/update/delete the items specified in a transaction.

Public Method ExecuteAsync(CancellationToken)

Executes a server call to condition-check/put/update/delete the items specified in a transaction.

Version Information

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

.NET Standard:
Supported in: 2.0

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