Table of Contents

Class Table

Namespace
Amazon.DynamoDBv2.DocumentModel
Assembly
AWSSDK.DynamoDBv2.dll

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

public class Table
Inheritance
Table
Inherited Members

Properties

Attributes

List of key attributes on the table.

public List<AttributeDefinition> Attributes { get; set; }

Property Value

List<AttributeDefinition>

GlobalSecondaryIndexNames

Names of the global secondary indexes of the table.

public List<string> GlobalSecondaryIndexNames { get; }

Property Value

List<string>

GlobalSecondaryIndexes

Global secondary indexes of the table.

public Dictionary<string, GlobalSecondaryIndexDescription> GlobalSecondaryIndexes { get; }

Property Value

Dictionary<string, GlobalSecondaryIndexDescription>

HashKeys

List of keys on the table marked HASH

public List<string> HashKeys { get; }

Property Value

List<string>

Keys

Keys of the table.

public Dictionary<string, KeyDescription> Keys { get; }

Property Value

Dictionary<string, KeyDescription>

LocalSecondaryIndexNames

Names of the local secondary indexes of the table.

public List<string> LocalSecondaryIndexNames { get; }

Property Value

List<string>

LocalSecondaryIndexes

Local secondary indexes of the table.

public Dictionary<string, LocalSecondaryIndexDescription> LocalSecondaryIndexes { get; }

Property Value

Dictionary<string, LocalSecondaryIndexDescription>

RangeKeys

List of keys on the table marked RANGE

public List<string> RangeKeys { get; }

Property Value

List<string>

TableName

Name of the table.

public string TableName { get; }

Property Value

string

Methods

ClearTableCache()

Clears current table cache. Next time a Table is created, its information will be loaded from DynamoDB.

public static void ClearTableCache()

CreateBatchGet()

Creates a DocumentBatchGet object for the current table, allowing a batch-get operation against DynamoDB.

public DocumentBatchGet CreateBatchGet()

Returns

DocumentBatchGet

Empty DocumentBatchGet object.

CreateBatchWrite()

Creates a DocumentBatchWrite object for the current table, allowing a batch-put/delete operation against DynamoDB.

public DocumentBatchWrite CreateBatchWrite()

Returns

DocumentBatchWrite

Empty DocumentBatchWrite object.

DeleteItemAsync(Document, DeleteItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(Document document, DeleteItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

document Document

Document to delete.

config DeleteItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(Document, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(Document document, CancellationToken cancellationToken = default)

Parameters

document Document

Document to delete.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(Primitive, DeleteItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(Primitive hashKey, DeleteItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

config DeleteItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(Primitive, Primitive, DeleteItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(Primitive hashKey, Primitive rangeKey, DeleteItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

rangeKey Primitive

Range key element of the document.

config DeleteItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(Primitive, Primitive, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(Primitive hashKey, Primitive rangeKey, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

rangeKey Primitive

Range key element of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(Primitive, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(Primitive hashKey, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(IDictionary<string, DynamoDBEntry>, DeleteItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(IDictionary<string, DynamoDBEntry> key, DeleteItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

key IDictionary<string, DynamoDBEntry>

Key of the document.

config DeleteItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

DeleteItemAsync(IDictionary<string, DynamoDBEntry>, CancellationToken)

Initiates the asynchronous execution of the DeleteItem operation. Amazon.DynamoDBv2.DocumentModel.Table.DeleteItem

public Task<Document> DeleteItemAsync(IDictionary<string, DynamoDBEntry> key, CancellationToken cancellationToken = default)

Parameters

key IDictionary<string, DynamoDBEntry>

Key of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

FromAttributeMap(Dictionary<string, AttributeValue>)

Creates a Document from an attribute map.

public Document FromAttributeMap(Dictionary<string, AttributeValue> data)

Parameters

data Dictionary<string, AttributeValue>

Map of attribute names to attribute values.

Returns

Document

Document representing the data.

GetItemAsync(Primitive, GetItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the GetItem operation. Amazon.DynamoDBv2.DocumentModel.Table.GetItem

public Task<Document> GetItemAsync(Primitive hashKey, GetItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

config GetItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

GetItemAsync(Primitive, Primitive, GetItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the GetItem operation. Amazon.DynamoDBv2.DocumentModel.Table.GetItem

public Task<Document> GetItemAsync(Primitive hashKey, Primitive rangeKey, GetItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

rangeKey Primitive

Range key element of the document.

config GetItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

GetItemAsync(Primitive, Primitive, CancellationToken)

Initiates the asynchronous execution of the GetItem operation. Amazon.DynamoDBv2.DocumentModel.Table.GetItem

public Task<Document> GetItemAsync(Primitive hashKey, Primitive rangeKey, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

rangeKey Primitive

Range key element of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

GetItemAsync(Primitive, CancellationToken)

Initiates the asynchronous execution of the GetItem operation. Amazon.DynamoDBv2.DocumentModel.Table.GetItem

public Task<Document> GetItemAsync(Primitive hashKey, CancellationToken cancellationToken = default)

Parameters

hashKey Primitive

Hash key element of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

GetItemAsync(IDictionary<string, DynamoDBEntry>, GetItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the GetItem operation. Amazon.DynamoDBv2.DocumentModel.Table.GetItem

public Task<Document> GetItemAsync(IDictionary<string, DynamoDBEntry> key, GetItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

key IDictionary<string, DynamoDBEntry>

Ley of the document.

config GetItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

GetItemAsync(IDictionary<string, DynamoDBEntry>, CancellationToken)

Initiates the asynchronous execution of the GetItem operation. Amazon.DynamoDBv2.DocumentModel.Table.GetItem

public Task<Document> GetItemAsync(IDictionary<string, DynamoDBEntry> key, CancellationToken cancellationToken = default)

Parameters

key IDictionary<string, DynamoDBEntry>

Ley of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

LoadTable(IAmazonDynamoDB, TableConfig)

Creates a Table object with the specified configuration, using the passed-in client to load the table definition.

This method will throw an exception if the table does not exist.

public static Table LoadTable(IAmazonDynamoDB ddbClient, TableConfig config)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

config TableConfig

Configuration to use for the table.

Returns

Table

Table object representing the specified table.

LoadTable(IAmazonDynamoDB, string)

Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema

This method will throw an exception if the table does not exist.

public static Table LoadTable(IAmazonDynamoDB ddbClient, string tableName)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

Returns

Table

Table object representing the specified table.

LoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion)

Creates a Table object with the specified name, using the passed-in client to load the table definition.

This method will throw an exception if the table does not exist.

public static Table LoadTable(IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

conversion DynamoDBEntryConversion

Conversion to use for converting .NET values to DynamoDB values.

Returns

Table

Table object representing the specified table.

LoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, bool)

Creates a Table object with the specified name, using the passed-in client to load the table definition.

This method will throw an exception if the table does not exist.

public static Table LoadTable(IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, bool isEmptyStringValueEnabled)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

conversion DynamoDBEntryConversion

Conversion to use for converting .NET values to DynamoDB values.

isEmptyStringValueEnabled bool

If the property is false, empty string values will be interpreted as null values.

Returns

Table

Table object representing the specified table.

LoadTable(IAmazonDynamoDB, string, bool)

Creates a Table object with the specified name, using the passed-in client to load the table definition.

This method will throw an exception if the table does not exist.

public static Table LoadTable(IAmazonDynamoDB ddbClient, string tableName, bool isEmptyStringValueEnabled)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

isEmptyStringValueEnabled bool

If the property is false, empty string values will be interpreted as null values.

Returns

Table

Table object representing the specified table.

PutItemAsync(Document, PutItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the PutItem operation. Amazon.DynamoDBv2.DocumentModel.Table.PutItem

public Task<Document> PutItemAsync(Document doc, PutItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

doc Document

Document to save.

config PutItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

PutItemAsync(Document, CancellationToken)

Initiates the asynchronous execution of the PutItem operation. Amazon.DynamoDBv2.DocumentModel.Table.PutItem

public Task<Document> PutItemAsync(Document doc, CancellationToken cancellationToken = default)

Parameters

doc Document

Document to save.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

Query(Primitive, Expression)

Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and expression.

No calls are made until the Search object is used.

public Search Query(Primitive hashKey, Expression filterExpression)

Parameters

hashKey Primitive

Value of the hash key for the query operation.

filterExpression Expression

Expression to use.

Returns

Search

Resultant Search container.

Query(Primitive, QueryFilter)

Initiates a Search object to Query a DynamoDB table, with the specified hash primary key and filter.

No calls are made until the Search object is used.

public Search Query(Primitive hashKey, QueryFilter filter)

Parameters

hashKey Primitive

Value of the hash key for the query operation.

filter QueryFilter

Filter to use.

Returns

Search

Resultant Search container.

Query(QueryFilter)

Initiates a Search object to Query a DynamoDB table, with the specified filter.

No calls are made until the Search object is used.

public Search Query(QueryFilter filter)

Parameters

filter QueryFilter

Filter to use.

Returns

Search

Resultant Search container.

Query(QueryOperationConfig)

Initiates a Search object to Query a DynamoDB table, with the specified config.

No calls are made until the Search object is used.

public Search Query(QueryOperationConfig config)

Parameters

config QueryOperationConfig

Configuration to use.

Returns

Search

Resultant Search container.

Scan(Expression)

Initiates a Search object to Scan a DynamoDB table, with the specified expression.

No calls are made until the Search object is used.

public Search Scan(Expression filterExpression)

Parameters

filterExpression Expression

Expression to apply to the scan.

Returns

Search

Resultant Search container.

Scan(ScanFilter)

Initiates a Search object to Scan a DynamoDB table, with the specified filter.

No calls are made until the Search object is used.

public Search Scan(ScanFilter filter)

Parameters

filter ScanFilter

Filter to apply to the scan.

Returns

Search

Resultant Search container.

Scan(ScanOperationConfig)

Initiates a Search object to Scan a DynamoDB table, with the specified config.

No calls are made until the Search object is used.

public Search Scan(ScanOperationConfig config)

Parameters

config ScanOperationConfig

Configuration to use.

Returns

Search

Resultant Search container.

ToAttributeMap(Document)

Creates a map of attribute names mapped to AttributeValue objects. Converts .NET types using the conversion specified in this Table.

public Dictionary<string, AttributeValue> ToAttributeMap(Document doc)

Parameters

doc Document

Returns

Dictionary<string, AttributeValue>

ToAttributeUpdateMap(Document, bool)

Creates a map of attribute names mapped to AttributeValueUpdate objects.

public Dictionary<string, AttributeValueUpdate> ToAttributeUpdateMap(Document doc, bool changedAttributesOnly)

Parameters

doc Document
changedAttributesOnly bool

If true, only attributes that have been changed will be in the map.

Returns

Dictionary<string, AttributeValueUpdate>

ToExpectedAttributeMap(Document)

Creates a map of attribute names mapped to ExpectedAttributeValue objects.

public Dictionary<string, ExpectedAttributeValue> ToExpectedAttributeMap(Document doc)

Parameters

doc Document

Returns

Dictionary<string, ExpectedAttributeValue>

TryLoadTable(IAmazonDynamoDB, TableConfig, out Table)

Creates a Table object with the specified configuration, using the passed-in client to load the table definition.

This method will return false if the table does not exist.

public static bool TryLoadTable(IAmazonDynamoDB ddbClient, TableConfig config, out Table table)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

config TableConfig

Configuration to use for the table.

table Table

Loaded table.

Returns

bool

True if table was successfully loaded; otherwise false.

TryLoadTable(IAmazonDynamoDB, string, out Table)

Creates a Table object with the specified name, using the passed-in client to load the table definition. The returned table will use the conversion specified by AWSConfigs.DynamoDBConfig.ConversionSchema

This method will return false if the table does not exist.

public static bool TryLoadTable(IAmazonDynamoDB ddbClient, string tableName, out Table table)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

table Table

Loaded table.

Returns

bool

True if table was successfully loaded; otherwise false.

TryLoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, out Table)

Creates a Table object with the specified name, using the passed-in client to load the table definition.

This method will return false if the table does not exist.

public static bool TryLoadTable(IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, out Table table)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

conversion DynamoDBEntryConversion

Conversion to use for converting .NET values to DynamoDB values.

table Table

Loaded table.

Returns

bool

True if table was successfully loaded; otherwise false.

TryLoadTable(IAmazonDynamoDB, string, DynamoDBEntryConversion, bool, out Table)

Creates a Table object with the specified name, using the passed-in client to load the table definition.

This method will return false if the table does not exist.

public static bool TryLoadTable(IAmazonDynamoDB ddbClient, string tableName, DynamoDBEntryConversion conversion, bool isEmptyStringValueEnabled, out Table table)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

conversion DynamoDBEntryConversion

Conversion to use for converting .NET values to DynamoDB values.

isEmptyStringValueEnabled bool

If the property is false, empty string values will be interpreted as null values.

table Table

Loaded table.

Returns

bool

True if table was successfully loaded; otherwise false.

TryLoadTable(IAmazonDynamoDB, string, bool, out Table)

Creates a Table object with the specified name, using the passed-in client to load the table definition.

This method will return false if the table does not exist.

public static bool TryLoadTable(IAmazonDynamoDB ddbClient, string tableName, bool isEmptyStringValueEnabled, out Table table)

Parameters

ddbClient IAmazonDynamoDB

Client to use to access DynamoDB.

tableName string

Name of the table.

isEmptyStringValueEnabled bool

If the property is false, empty string values will be interpreted as null values.

table Table

Loaded table.

Returns

bool

True if table was successfully loaded; otherwise false.

UpdateItemAsync(Document, Primitive, Primitive, UpdateItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, Primitive hashKey, Primitive rangeKey, UpdateItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

hashKey Primitive

Hash key element of the document.

rangeKey Primitive

Range key element of the document.

config UpdateItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, Primitive, Primitive, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, Primitive hashKey, Primitive rangeKey, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

hashKey Primitive

Hash key element of the document.

rangeKey Primitive

Range key element of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, Primitive, UpdateItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, Primitive hashKey, UpdateItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

hashKey Primitive

Hash key element of the document.

config UpdateItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, Primitive, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, Primitive hashKey, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

hashKey Primitive

Hash key element of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, UpdateItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, UpdateItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

config UpdateItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, IDictionary<string, DynamoDBEntry>, UpdateItemOperationConfig, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, IDictionary<string, DynamoDBEntry> key, UpdateItemOperationConfig config, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

key IDictionary<string, DynamoDBEntry>

Key of the document.

config UpdateItemOperationConfig

Configuration to use.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, IDictionary<string, DynamoDBEntry>, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, IDictionary<string, DynamoDBEntry> key, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

key IDictionary<string, DynamoDBEntry>

Key of the document.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.

UpdateItemAsync(Document, CancellationToken)

Initiates the asynchronous execution of the UpdateItem operation. Amazon.DynamoDBv2.DocumentModel.Table.UpdateItem

public Task<Document> UpdateItemAsync(Document doc, CancellationToken cancellationToken = default)

Parameters

doc Document

Attributes to update.

cancellationToken CancellationToken

Token which can be used to cancel the task.

Returns

Task<Document>

A Task that can be used to poll or wait for results, or both.