Interface IAmazonDynamoDB

An error occurred on the server side.

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for BatchGetItem Operation

BatchGetItemAsync(Dictionary<string, KeysAndAttributes>, ReturnConsumedCapacity, CancellationToken)

The

BatchGetItem

operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items.

BatchGetItem

UnprocessedKeys

. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items,

BatchGetItem

returns a

ValidationException

with the message "Too many items requested for the BatchGetItem call."

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate

UnprocessedKeys

value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then

BatchGetItem

returns a

ProvisionedThroughputExceededException

. If at least one of the items is successfully processed, then

BatchGetItem

completes successfully, while returning the keys of the unread items in

UnprocessedKeys

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default,

BatchGetItem

performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set

ConsistentRead

true

for any or all tables.

In order to minimize response latency,

BatchGetItem

retrieves items in parallel.

ProjectionExpression

parameter.

Task<BatchGetItemResponse> BatchGetItemAsync(Dictionary<string, KeysAndAttributes> requestItems, ReturnConsumedCapacity returnConsumedCapacity, CancellationToken cancellationToken = default)

Parameters

requestItems Dictionary<string, KeysAndAttributes>

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per

BatchGetItem

request. Each element in the map of items to retrieve consists of the following:

```
ConsistentRead
```
- If
```
true
```
, a strongly consistent read is used; if
```
false
```
(the default), an eventually consistent read is used.
```
ExpressionAttributeNames
```
- One or more substitution tokens for attribute names in the
```
ProjectionExpression
```
parameter. The following are some use cases for using
```
ExpressionAttributeNames
```
:
- To access an attribute whose name conflicts with a DynamoDB reserved word.
- To create a placeholder for repeating occurrences of an attribute name in an expression.
- To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
- ```
Percentile
```
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
```
ExpressionAttributeNames
```
:
- ```
{"#P":"Percentile"}
```
You could then use this substitution in an expression, as in this example:
- ```
#P = :val
```
note
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
```
Keys
```
- An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.
```
ProjectionExpression
```
- A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
```
AttributesToGet
```
- This is a legacy parameter. Use
```
ProjectionExpression
```
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

returnConsumedCapacity ReturnConsumedCapacity

A property of BatchGetItemRequest used to execute the BatchGetItem service method.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BatchGetItemResponse>: The response from the BatchGetItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for BatchGetItem Operation

BatchGetItemAsync(Dictionary<string, KeysAndAttributes>, CancellationToken)

The

BatchGetItem

operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items.

BatchGetItem

UnprocessedKeys

. You can use this value to retry the operation starting with the next item to get.

If you request more than 100 items,

BatchGetItem

returns a

ValidationException

with the message "Too many items requested for the BatchGetItem call."

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate

UnprocessedKeys

value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then

BatchGetItem

returns a

ProvisionedThroughputExceededException

. If at least one of the items is successfully processed, then

BatchGetItem

completes successfully, while returning the keys of the unread items in

UnprocessedKeys

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

By default,

BatchGetItem

performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set

ConsistentRead

true

for any or all tables.

In order to minimize response latency,

BatchGetItem

retrieves items in parallel.

ProjectionExpression

parameter.

Task<BatchGetItemResponse> BatchGetItemAsync(Dictionary<string, KeysAndAttributes> requestItems, CancellationToken cancellationToken = default)

Parameters

requestItems Dictionary<string, KeysAndAttributes>

A map of one or more table names and, for each table, a map that describes one or more items to retrieve from that table. Each table name can be used only once per

BatchGetItem

request. Each element in the map of items to retrieve consists of the following:

```
ConsistentRead
```
- If
```
true
```
, a strongly consistent read is used; if
```
false
```
(the default), an eventually consistent read is used.
```
ExpressionAttributeNames
```
- One or more substitution tokens for attribute names in the
```
ProjectionExpression
```
parameter. The following are some use cases for using
```
ExpressionAttributeNames
```
:
- To access an attribute whose name conflicts with a DynamoDB reserved word.
- To create a placeholder for repeating occurrences of an attribute name in an expression.
- To prevent special characters in an attribute name from being misinterpreted in an expression.
Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:
- ```
Percentile
```
The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for
```
ExpressionAttributeNames
```
:
- ```
{"#P":"Percentile"}
```
You could then use this substitution in an expression, as in this example:
- ```
#P = :val
```
note
Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.
For more information about expression attribute names, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
```
Keys
```
- An array of primary key attribute values that define specific items in the table. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide the partition key value. For a composite key, you must provide both the partition key value and the sort key value.
```
ProjectionExpression
```
- A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result. For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.
```
AttributesToGet
```
- This is a legacy parameter. Use
```
ProjectionExpression
```
instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BatchGetItemResponse>: The response from the BatchGetItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for BatchGetItem Operation

BatchWriteItemAsync(BatchWriteItemRequest, CancellationToken)

The

BatchWriteItem

operation puts or deletes multiple items in one or more tables. A single call to

BatchWriteItem

can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

note

BatchWriteItem

cannot update items. To update items, use the

UpdateItem

action.

The individual

PutItem

and

DeleteItem

operations specified in

BatchWriteItem

are atomic; however

BatchWriteItem

as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the

UnprocessedItems

response parameter. You can investigate and optionally resend the requests. Typically, you would call

BatchWriteItem

in a loop. Each iteration would check for unprocessed items and submit a new

BatchWriteItem

request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then

BatchWriteItem

returns a

ProvisionedThroughputExceededException

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With

BatchWriteItem

, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations,

BatchWriteItem

does not behave in the same way as individual

PutItem

and

DeleteItem

calls would. For example, you cannot specify conditions on individual put and delete requests, and

BatchWriteItem

does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations,

BatchWriteItem

performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

One or more tables specified in the
```
BatchWriteItem
```
request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same
```
BatchWriteItem
```
request. For example, you cannot put and delete the same item in the same
```
BatchWriteItem
```
request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.

Task<BatchWriteItemResponse> BatchWriteItemAsync(BatchWriteItemRequest request, CancellationToken cancellationToken = default)

Parameters

request BatchWriteItemRequest: Container for the necessary parameters to execute the BatchWriteItem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BatchWriteItemResponse>: The response from the BatchWriteItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for BatchWriteItem Operation

BatchWriteItemAsync(Dictionary<string, List<WriteRequest>>, CancellationToken)

The

BatchWriteItem

operation puts or deletes multiple items in one or more tables. A single call to

BatchWriteItem

note

BatchWriteItem

cannot update items. To update items, use the

UpdateItem

action.

The individual

PutItem

and

DeleteItem

operations specified in

BatchWriteItem

are atomic; however

BatchWriteItem

as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the

UnprocessedItems

response parameter. You can investigate and optionally resend the requests. Typically, you would call

BatchWriteItem

in a loop. Each iteration would check for unprocessed items and submit a new

BatchWriteItem

request with those unprocessed items until all items have been processed.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then

BatchWriteItem

returns a

ProvisionedThroughputExceededException

For more information, see Batch Operations and Error Handling in the Amazon DynamoDB Developer Guide.

With

BatchWriteItem

BatchWriteItem

does not behave in the same way as individual

PutItem

and

DeleteItem

calls would. For example, you cannot specify conditions on individual put and delete requests, and

BatchWriteItem

does not return deleted items in the response.

BatchWriteItem

performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

One or more tables specified in the
```
BatchWriteItem
```
request does not exist.
Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.
You try to perform multiple operations on the same item in the same
```
BatchWriteItem
```
request. For example, you cannot put and delete the same item in the same
```
BatchWriteItem
```
request.
Your request contains at least two items with identical hash and range keys (which essentially is two put operations).
There are more than 25 requests in the batch.
Any individual item in a batch exceeds 400 KB.
The total request size exceeds 16 MB.

Task<BatchWriteItemResponse> BatchWriteItemAsync(Dictionary<string, List<WriteRequest>> requestItems, CancellationToken cancellationToken = default)

Parameters

requestItems Dictionary<string, List<WriteRequest>>

A map of one or more table names and, for each table, a list of operations to be performed (

DeleteRequest

PutRequest

). Each element in the map consists of the following:

```
DeleteRequest
```
- Perform a
```
DeleteItem
```
operation on the specified item. The item to be deleted is identified by a
```
Key
```
subelement:
- ```
Key
```
  - A map of primary key attribute values that uniquely identify the item. Each entry in this map consists of an attribute name and an attribute value. For each primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.
```
PutRequest
```
- Perform a
```
PutItem
```
operation on the specified item. The item to be put is identified by an
```
Item
```
subelement:
- ```
Item
```
  - A map of attributes and their values. Each entry in this map consists of an attribute name and an attribute value. Attribute values must not be null; string and binary type attributes must have lengths greater than zero; and set type attributes must not be empty. Requests that contain empty values are rejected with a
```
ValidationException
```
  exception. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<BatchWriteItemResponse>: The response from the BatchWriteItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

ContinuousBackupsUnavailableException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for BatchWriteItem Operation

CreateBackupAsync(CreateBackupRequest, CancellationToken)

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call

CreateBackup

at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Streams
Provisioned read and write capacity

Task<CreateBackupResponse> CreateBackupAsync(CreateBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateBackupRequest: Container for the necessary parameters to execute the CreateBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateBackupResponse>: The response from the CreateBackup service method, as returned by DynamoDB.

Exceptions

BackupInUseException

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

Backups have not yet been enabled for this table.

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

The only exception is when you are creating a table with one or more secondary indexes. You can have up to 250 such requests running at a time; however, if the table or index specifications are complex, DynamoDB might temporarily reduce the number of concurrent operations.

There is a soft account quota of 2,500 tables.

TableInUseException

A target table with the specified name is either being created or deleted.

GlobalTableAlreadyExistsException

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for CreateBackup Operation

CreateGlobalTableAsync(CreateGlobalTableRequest, CancellationToken)

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

note

This operation only applies to Version 2017.11.29 of global tables.

If you want to add a new replica table to a global table, each of the following conditions must be true:

The table must have the same primary key as all of the other replicas.
The table must have the same name as all of the other replicas.
The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.
None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

The local secondary indexes must have the same name.
The local secondary indexes must have the same hash key and sort key (if present).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Task<CreateGlobalTableResponse> CreateGlobalTableAsync(CreateGlobalTableRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateGlobalTableRequest: Container for the necessary parameters to execute the CreateGlobalTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateGlobalTableResponse>: The response from the CreateGlobalTable service method, as returned by DynamoDB.

Exceptions

The specified global table already exists.

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for CreateGlobalTable Operation

CreateTableAsync(CreateTableRequest, CancellationToken)

The

CreateTable

operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.

CreateTable

is an asynchronous operation. Upon receiving a

CreateTable

request, DynamoDB immediately returns a response with a

TableStatus

CREATING

. After the table is created, DynamoDB sets the

TableStatus

ACTIVE

. You can perform read and write operations only on an

ACTIVE

table.

You can optionally define secondary indexes on the new table, as part of the

CreateTable

operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the

CREATING

state at any given time.

You can use the

DescribeTable

action to check the table status.

Task<CreateTableResponse> CreateTableAsync(CreateTableRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateTableRequest: Container for the necessary parameters to execute the CreateTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateTableResponse>: The response from the CreateTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

See Also: REST API Reference for CreateTable Operation

CreateTableAsync(string, List<KeySchemaElement>, List<AttributeDefinition>, ProvisionedThroughput, CancellationToken)

The

CreateTable

CreateTable

is an asynchronous operation. Upon receiving a

CreateTable

request, DynamoDB immediately returns a response with a

TableStatus

CREATING

. After the table is created, DynamoDB sets the

TableStatus

ACTIVE

. You can perform read and write operations only on an

ACTIVE

table.

You can optionally define secondary indexes on the new table, as part of the

CreateTable

operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the

CREATING

state at any given time.

You can use the

DescribeTable

action to check the table status.

Task<CreateTableResponse> CreateTableAsync(string tableName, List<KeySchemaElement> keySchema, List<AttributeDefinition> attributeDefinitions, ProvisionedThroughput provisionedThroughput, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table to create.

keySchema List<KeySchemaElement>

Specifies the attributes that make up the primary key for a table or an index. The attributes in

KeySchema

must also be defined in the

AttributeDefinitions

array. For more information, see Data Model in the Amazon DynamoDB Developer Guide. Each

KeySchemaElement

in the array is composed of:

```
AttributeName
```
- The name of this key attribute.
```
KeyType
```
- The role that the key attribute will assume:
- ```
HASH
```
  - partition key
- ```
RANGE
```
  - sort key

note

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a

KeyType

HASH

. For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a

KeyType

HASH

, and the second element must have a

KeyType

RANGE

. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

attributeDefinitions List<AttributeDefinition>

An array of attributes that describe the key schema for the table and indexes.

provisionedThroughput ProvisionedThroughput

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the

UpdateTable

operation. If you set BillingMode as

PROVISIONED

, you must specify this property. If you set BillingMode as

PAY_PER_REQUEST

, you cannot specify this property. For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateTableResponse>: The response from the CreateTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

BackupNotFoundException

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

See Also: REST API Reference for CreateTable Operation

DeleteBackupAsync(DeleteBackupRequest, CancellationToken)

Deletes an existing backup of a table.

You can call

DeleteBackup

at a maximum rate of 10 times per second.

Task<DeleteBackupResponse> DeleteBackupAsync(DeleteBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteBackupRequest: Container for the necessary parameters to execute the DeleteBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteBackupResponse>: The response from the DeleteBackup service method, as returned by DynamoDB.

Exceptions

BackupInUseException

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

Backup not found for the given BackupARN.

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

See Also: REST API Reference for DeleteBackup Operation

DeleteItemAsync(DeleteItemRequest, CancellationToken)

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the

ReturnValues

parameter.

Unless you specify conditions, the

DeleteItem

is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Task<DeleteItemResponse> DeleteItemAsync(DeleteItemRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteItemRequest: Container for the necessary parameters to execute the DeleteItem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteItemResponse>: The response from the DeleteItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for DeleteItem Operation

DeleteItemAsync(string, Dictionary<string, AttributeValue>, ReturnValue, CancellationToken)

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the

ReturnValues

parameter.

Unless you specify conditions, the

DeleteItem

is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Task<DeleteItemResponse> DeleteItemAsync(string tableName, Dictionary<string, AttributeValue> key, ReturnValue returnValues, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table from which to delete the item.

A map of attribute names to

AttributeValue

objects, representing the primary key of the item to delete. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

returnValues ReturnValue

Use

ReturnValues

if you want to get the item attributes as they appeared before they were deleted. For

DeleteItem

, the valid values are:

```
NONE
```
- If
```
ReturnValues
```
is not specified, or if its value is
```
NONE
```
, then nothing is returned. (This setting is the default for
```
ReturnValues
```
.)
```
ALL_OLD
```
- The content of the old item is returned.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

note

The

ReturnValues

parameter is used by several DynamoDB operations; however,

DeleteItem

does not recognize any values other than

NONE

ALL_OLD

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteItemResponse>: The response from the DeleteItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for DeleteItem Operation

DeleteItemAsync(string, Dictionary<string, AttributeValue>, CancellationToken)

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the

ReturnValues

parameter.

Unless you specify conditions, the

DeleteItem

is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Task<DeleteItemResponse> DeleteItemAsync(string tableName, Dictionary<string, AttributeValue> key, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table from which to delete the item.

A map of attribute names to

AttributeValue

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteItemResponse>: The response from the DeleteItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for DeleteItem Operation

DeleteTableAsync(DeleteTableRequest, CancellationToken)

The

DeleteTable

operation deletes a table and all of its items. After a

DeleteTable

request, the specified table is in the

DELETING

state until DynamoDB completes the deletion. If the table is in the

ACTIVE

state, you can delete it. If a table is in

CREATING

UPDATING

states, then DynamoDB returns a

ResourceInUseException

. If the specified table does not exist, DynamoDB returns a

ResourceNotFoundException

. If table is already in the

DELETING

state, no error is returned.

note

DynamoDB might continue to accept data read and write operations, such as

GetItem

and

PutItem

, on a table in the

DELETING

state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the

DISABLED

state, and the stream is automatically deleted after 24 hours.

Use the

DescribeTable

action to check the status of the table.

Task<DeleteTableResponse> DeleteTableAsync(DeleteTableRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteTableRequest: Container for the necessary parameters to execute the DeleteTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteTableResponse>: The response from the DeleteTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DeleteTable Operation

DeleteTableAsync(string, CancellationToken)

The

DeleteTable

operation deletes a table and all of its items. After a

DeleteTable

request, the specified table is in the

DELETING

state until DynamoDB completes the deletion. If the table is in the

ACTIVE

state, you can delete it. If a table is in

CREATING

UPDATING

states, then DynamoDB returns a

ResourceInUseException

. If the specified table does not exist, DynamoDB returns a

ResourceNotFoundException

. If table is already in the

DELETING

state, no error is returned.

note

DynamoDB might continue to accept data read and write operations, such as

GetItem

and

PutItem

, on a table in the

DELETING

state until the table deletion is complete.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the

DISABLED

state, and the stream is automatically deleted after 24 hours.

Use the

DescribeTable

action to check the status of the table.

Task<DeleteTableResponse> DeleteTableAsync(string tableName, CancellationToken cancellationToken = default)

Parameters

tableName string: The name of the table to delete.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteTableResponse>: The response from the DeleteTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DeleteTable Operation

DescribeBackupAsync(DescribeBackupRequest, CancellationToken)

Describes an existing backup of a table.

You can call

DescribeBackup

at a maximum rate of 10 times per second.

Task<DescribeBackupResponse> DescribeBackupAsync(DescribeBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeBackupRequest: Container for the necessary parameters to execute the DescribeBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeBackupResponse>: The response from the DescribeBackup service method, as returned by DynamoDB.

Exceptions

BackupNotFoundException: Backup not found for the given BackupARN.
InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for DescribeBackup Operation

DescribeContinuousBackupsAsync(DescribeContinuousBackupsRequest, CancellationToken)

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are

ENABLED

on all tables at table creation. If point in time recovery is enabled,

PointInTimeRecoveryStatus

will be set to ENABLED.

After continuous backups and point in time recovery are enabled, you can restore to any point in time within

EarliestRestorableDateTime

and

LatestRestorableDateTime

LatestRestorableDateTime

is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

You can call

DescribeContinuousBackups

at a maximum rate of 10 times per second.

Task<DescribeContinuousBackupsResponse> DescribeContinuousBackupsAsync(DescribeContinuousBackupsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeContinuousBackupsRequest: Container for the necessary parameters to execute the DescribeContinuousBackups service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeContinuousBackupsResponse>: The response from the DescribeContinuousBackups service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for DescribeContinuousBackups Operation

DescribeContributorInsightsAsync(DescribeContributorInsightsRequest, CancellationToken)

Returns information about contributor insights, for a given table or global secondary index.

Task<DescribeContributorInsightsResponse> DescribeContributorInsightsAsync(DescribeContributorInsightsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeContributorInsightsRequest: Container for the necessary parameters to execute the DescribeContributorInsights service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeContributorInsightsResponse>: The response from the DescribeContributorInsights service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

ExportNotFoundException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeContributorInsights Operation

DescribeEndpointsAsync(DescribeEndpointsRequest, CancellationToken)

Returns the regional endpoint information.

Task<DescribeEndpointsResponse> DescribeEndpointsAsync(DescribeEndpointsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeEndpointsRequest: Container for the necessary parameters to execute the DescribeEndpoints service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeEndpointsResponse>: The response from the DescribeEndpoints service method, as returned by DynamoDB.

See Also: REST API Reference for DescribeEndpoints Operation

DescribeExportAsync(DescribeExportRequest, CancellationToken)

Describes an existing table export.

Task<DescribeExportResponse> DescribeExportAsync(DescribeExportRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeExportRequest: Container for the necessary parameters to execute the DescribeExport service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeExportResponse>: The response from the DescribeExport service method, as returned by DynamoDB.

Exceptions

The specified export was not found.

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

See Also: REST API Reference for DescribeExport Operation

DescribeGlobalTableAsync(DescribeGlobalTableRequest, CancellationToken)

Returns information about the specified global table.

note

This operation only applies to Version 2017.11.29 of global tables. If you are using global tables Version 2019.11.21 you can use DescribeTable instead.

Task<DescribeGlobalTableResponse> DescribeGlobalTableAsync(DescribeGlobalTableRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeGlobalTableRequest: Container for the necessary parameters to execute the DescribeGlobalTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeGlobalTableResponse>: The response from the DescribeGlobalTable service method, as returned by DynamoDB.

Exceptions

GlobalTableNotFoundException: The specified global table does not exist.
InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for DescribeGlobalTable Operation

DescribeGlobalTableSettingsAsync(DescribeGlobalTableSettingsRequest, CancellationToken)

Describes Region-specific settings for a global table.

note

This operation only applies to Version 2017.11.29 of global tables.

Task<DescribeGlobalTableSettingsResponse> DescribeGlobalTableSettingsAsync(DescribeGlobalTableSettingsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeGlobalTableSettingsRequest: Container for the necessary parameters to execute the DescribeGlobalTableSettings service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeGlobalTableSettingsResponse>: The response from the DescribeGlobalTableSettings service method, as returned by DynamoDB.

Exceptions

GlobalTableNotFoundException: The specified global table does not exist.
InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for DescribeGlobalTableSettings Operation

DescribeImportAsync(DescribeImportRequest, CancellationToken)

Represents the properties of the import.

Task<DescribeImportResponse> DescribeImportAsync(DescribeImportRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeImportRequest: Container for the necessary parameters to execute the DescribeImport service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeImportResponse>: The response from the DescribeImport service method, as returned by DynamoDB.

Exceptions

ImportNotFoundException: The specified import was not found.

See Also: REST API Reference for DescribeImport Operation

DescribeKinesisStreamingDestinationAsync(DescribeKinesisStreamingDestinationRequest, CancellationToken)

Returns information about the status of Kinesis streaming.

Task<DescribeKinesisStreamingDestinationResponse> DescribeKinesisStreamingDestinationAsync(DescribeKinesisStreamingDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeKinesisStreamingDestinationRequest: Container for the necessary parameters to execute the DescribeKinesisStreamingDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeKinesisStreamingDestinationResponse>: The response from the DescribeKinesisStreamingDestination service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeKinesisStreamingDestination Operation

DescribeLimitsAsync(DescribeLimitsRequest, CancellationToken)

Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The

DescribeLimits

action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

For example, you could use one of the Amazon Web Services SDKs to do the following:

Call
```
DescribeLimits
```
for a particular Region to obtain your current account quotas on provisioned capacity there.
Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.
Call
```
ListTables
```
to obtain a list of all your DynamoDB tables.
For each table name listed by
```
ListTables
```
, do the following:
- Call
```
DescribeTable
```
  with the table name.
- Use the data returned by
```
DescribeTable
```
  to add the read capacity units and write capacity units provisioned for the table itself to your variables.
- If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.
Report the account quotas for that Region returned by
```
DescribeLimits
```
, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level quotas.

The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

note

DescribeLimits

should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The

DescribeLimits

Request element has no content.

Task<DescribeLimitsResponse> DescribeLimitsAsync(DescribeLimitsRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeLimitsRequest: Container for the necessary parameters to execute the DescribeLimits service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeLimitsResponse>: The response from the DescribeLimits service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for DescribeLimits Operation

DescribeTableAsync(DescribeTableRequest, CancellationToken)

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

note

If you issue a

DescribeTable

request immediately after a

CreateTable

request, DynamoDB might return a

ResourceNotFoundException

. This is because

DescribeTable

uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the

DescribeTable

request again.

Task<DescribeTableResponse> DescribeTableAsync(DescribeTableRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeTableRequest: Container for the necessary parameters to execute the DescribeTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeTableResponse>: The response from the DescribeTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeTable Operation

DescribeTableAsync(string, CancellationToken)

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

note

If you issue a

DescribeTable

request immediately after a

CreateTable

request, DynamoDB might return a

ResourceNotFoundException

. This is because

DescribeTable

uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the

DescribeTable

request again.

Task<DescribeTableResponse> DescribeTableAsync(string tableName, CancellationToken cancellationToken = default)

Parameters

tableName string: The name of the table to describe.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeTableResponse>: The response from the DescribeTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeTable Operation

DescribeTableReplicaAutoScalingAsync(DescribeTableReplicaAutoScalingRequest, CancellationToken)

Describes auto scaling settings across replicas of the global table at once.

note

This operation only applies to Version 2019.11.21 of global tables.

Task<DescribeTableReplicaAutoScalingResponse> DescribeTableReplicaAutoScalingAsync(DescribeTableReplicaAutoScalingRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeTableReplicaAutoScalingRequest: Container for the necessary parameters to execute the DescribeTableReplicaAutoScaling service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeTableReplicaAutoScalingResponse>: The response from the DescribeTableReplicaAutoScaling service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeTableReplicaAutoScaling Operation

DescribeTimeToLiveAsync(DescribeTimeToLiveRequest, CancellationToken)

Gives a description of the Time to Live (TTL) status on the specified table.

Task<DescribeTimeToLiveResponse> DescribeTimeToLiveAsync(DescribeTimeToLiveRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeTimeToLiveRequest: Container for the necessary parameters to execute the DescribeTimeToLive service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeTimeToLiveResponse>: The response from the DescribeTimeToLive service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeTimeToLive Operation

DescribeTimeToLiveAsync(string, CancellationToken)

Gives a description of the Time to Live (TTL) status on the specified table.

Task<DescribeTimeToLiveResponse> DescribeTimeToLiveAsync(string tableName, CancellationToken cancellationToken = default)

Parameters

tableName string: The name of the table to be described.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeTimeToLiveResponse>: The response from the DescribeTimeToLive service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DescribeTimeToLive Operation

DisableKinesisStreamingDestinationAsync(DisableKinesisStreamingDestinationRequest, CancellationToken)

Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.

Task<DisableKinesisStreamingDestinationResponse> DisableKinesisStreamingDestinationAsync(DisableKinesisStreamingDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request DisableKinesisStreamingDestinationRequest: Container for the necessary parameters to execute the DisableKinesisStreamingDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DisableKinesisStreamingDestinationResponse>: The response from the DisableKinesisStreamingDestination service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for DisableKinesisStreamingDestination Operation

EnableKinesisStreamingDestinationAsync(EnableKinesisStreamingDestinationRequest, CancellationToken)

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

Task<EnableKinesisStreamingDestinationResponse> EnableKinesisStreamingDestinationAsync(EnableKinesisStreamingDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request EnableKinesisStreamingDestinationRequest: Container for the necessary parameters to execute the EnableKinesisStreamingDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<EnableKinesisStreamingDestinationResponse>: The response from the EnableKinesisStreamingDestination service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for EnableKinesisStreamingDestination Operation

ExecuteStatementAsync(ExecuteStatementRequest, CancellationToken)

This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

For PartiQL reads (

SELECT

statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a

LastEvaluatedKey

value to continue the read in a subsequent operation. If the filter criteria in

WHERE

clause does not match any data, the read will return an empty result set.

A single

SELECT

statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using

WHERE

clause). If

LastEvaluatedKey

is present in the response, you need to paginate the result set.

Task<ExecuteStatementResponse> ExecuteStatementAsync(ExecuteStatementRequest request, CancellationToken cancellationToken = default)

Parameters

request ExecuteStatementRequest: Container for the necessary parameters to execute the ExecuteStatement service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ExecuteStatementResponse>: The response from the ExecuteStatement service method, as returned by DynamoDB.

Exceptions

DuplicateItemException

A condition specified in the operation could not be evaluated.

There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

IdempotentParameterMismatchException

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for ExecuteStatement Operation

ExecuteTransactionAsync(ExecuteTransactionRequest, CancellationToken)

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

note

The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to

ConditionCheck

in the TransactWriteItems API.

Task<ExecuteTransactionResponse> ExecuteTransactionAsync(ExecuteTransactionRequest request, CancellationToken cancellationToken = default)

Parameters

request ExecuteTransactionRequest: Container for the necessary parameters to execute the ExecuteTransaction service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ExecuteTransactionResponse>: The response from the ExecuteTransaction service method, as returned by DynamoDB.

Exceptions

DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

TransactionCanceledException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

The entire transaction request was canceled.

DynamoDB cancels a

TransactWriteItems

request under the following circumstances:

A condition in one of the condition expressions is not met.
A table in the
```
TransactWriteItems
```
request is in a different account or region.
More than one action in the
```
TransactWriteItems
```
operation targets the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
There is a user error, such as an invalid data format.

DynamoDB cancels a

TransactGetItems

request under the following circumstances:

There is an ongoing
```
TransactGetItems
```
operation that conflicts with a concurrent
```
PutItem
```
,
```
UpdateItem
```
,
```
DeleteItem
```
or
```
TransactWriteItems
```
request. In this case the
```
TransactGetItems
```
operation fails with a
```
TransactionCanceledException
```
.
A table in the
```
TransactGetItems
```
request is in a different account or region.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.

note

If using Java, DynamoDB lists the cancellation reasons on the

CancellationReasons

property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have

None

code and

Null

message.

Cancellation reason codes and possible error messages:

No Errors:
- Code:
```
None
```
- Message:
```
null
```
Conditional Check Failed:
- Code:
```
ConditionalCheckFailed
```
- Message: The conditional request failed.
Item Collection Size Limit Exceeded:
- Code:
```
ItemCollectionSizeLimitExceeded
```
- Message: Collection size exceeded.
Transaction Conflict:
- Code:
```
TransactionConflict
```
- Message: Transaction is ongoing for the item.
Provisioned Throughput Exceeded:
- Code:
```
ProvisionedThroughputExceeded
```
- Messages:
  - The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
    note
    This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
  - The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
    note
    This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
Throttling Error:
- Code:
```
ThrottlingError
```
- Messages:
  - Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
    note
    This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
  - Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
    note
    This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
Validation Error:
- Code:
```
ValidationError
```
- Messages:
  - One or more parameter values were invalid.
  - The update expression attempted to update the secondary index key beyond allowed size limits.
  - The update expression attempted to update the secondary index key to unsupported type.
  - An operand in the update expression has an incorrect data type.
  - Item size to update has exceeded the maximum allowed size.
  - Number overflow. Attempting to store a number with magnitude larger than supported range.
  - Type mismatch for attribute to update.
  - Nesting Levels have exceeded supported limits.
  - The document path provided in the update expression is invalid for update.
  - The provided expression refers to an attribute that does not exist in the item.

TransactionInProgressException

The transaction with the given request token is already in progress.

See Also: REST API Reference for ExecuteTransaction Operation

ExportTableToPointInTimeAsync(ExportTableToPointInTimeRequest, CancellationToken)

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

Task<ExportTableToPointInTimeResponse> ExportTableToPointInTimeAsync(ExportTableToPointInTimeRequest request, CancellationToken cancellationToken = default)

Parameters

request ExportTableToPointInTimeRequest: Container for the necessary parameters to execute the ExportTableToPointInTime service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ExportTableToPointInTimeResponse>: The response from the ExportTableToPointInTime service method, as returned by DynamoDB.

Exceptions

ExportConflictException

There was a conflict when writing to the specified S3 bucket.

InvalidExportTimeException

An error occurred on the server side.

The specified

ExportTime

is outside of the point in time recovery window.

PointInTimeRecoveryUnavailableException

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

Point in time recovery has not yet been enabled for this source table.

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for ExportTableToPointInTime Operation

GetItemAsync(GetItemRequest, CancellationToken)

The

GetItem

operation returns a set of attributes for the item with the given primary key. If there is no matching item,

GetItem

does not return any data and there will be no

Item

element in the response.

GetItem

provides an eventually consistent read by default. If your application requires a strongly consistent read, set

ConsistentRead

true

. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Task<GetItemResponse> GetItemAsync(GetItemRequest request, CancellationToken cancellationToken = default)

Parameters

request GetItemRequest: Container for the necessary parameters to execute the GetItem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetItemResponse>: The response from the GetItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for GetItem Operation

GetItemAsync(string, Dictionary<string, AttributeValue>, bool, CancellationToken)

The

GetItem

operation returns a set of attributes for the item with the given primary key. If there is no matching item,

GetItem

does not return any data and there will be no

Item

element in the response.

GetItem

provides an eventually consistent read by default. If your application requires a strongly consistent read, set

ConsistentRead

true

. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Task<GetItemResponse> GetItemAsync(string tableName, Dictionary<string, AttributeValue> key, bool consistentRead, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the requested item.

A map of attribute names to

AttributeValue

objects, representing the primary key of the item to retrieve. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

consistentRead bool

Determines the read consistency model: If set to

true

, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetItemResponse>: The response from the GetItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for GetItem Operation

GetItemAsync(string, Dictionary<string, AttributeValue>, CancellationToken)

The

GetItem

operation returns a set of attributes for the item with the given primary key. If there is no matching item,

GetItem

does not return any data and there will be no

Item

element in the response.

GetItem

provides an eventually consistent read by default. If your application requires a strongly consistent read, set

ConsistentRead

true

. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Task<GetItemResponse> GetItemAsync(string tableName, Dictionary<string, AttributeValue> key, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the requested item.

A map of attribute names to

AttributeValue

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<GetItemResponse>: The response from the GetItem service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

ImportConflictException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for GetItem Operation

ImportTableAsync(ImportTableRequest, CancellationToken)

Imports table data from an S3 bucket.

Task<ImportTableResponse> ImportTableAsync(ImportTableRequest request, CancellationToken cancellationToken = default)

Parameters

request ImportTableRequest: Container for the necessary parameters to execute the ImportTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ImportTableResponse>: The response from the ImportTable service method, as returned by DynamoDB.

Exceptions

There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

See Also: REST API Reference for ImportTable Operation

ListBackupsAsync(ListBackupsRequest, CancellationToken)

List backups associated with an Amazon Web Services account. To list backups for a given table, specify

TableName

ListBackups

returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.

In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.

You can call

ListBackups

a maximum of five times per second.

Task<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListBackupsRequest: Container for the necessary parameters to execute the ListBackups service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListBackupsResponse>: The response from the ListBackups service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListBackups Operation

ListContributorInsightsAsync(ListContributorInsightsRequest, CancellationToken)

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

Task<ListContributorInsightsResponse> ListContributorInsightsAsync(ListContributorInsightsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListContributorInsightsRequest: Container for the necessary parameters to execute the ListContributorInsights service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListContributorInsightsResponse>: The response from the ListContributorInsights service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for ListContributorInsights Operation

ListExportsAsync(ListExportsRequest, CancellationToken)

Lists completed exports within the past 90 days.

Task<ListExportsResponse> ListExportsAsync(ListExportsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListExportsRequest: Container for the necessary parameters to execute the ListExports service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListExportsResponse>: The response from the ListExports service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

See Also: REST API Reference for ListExports Operation

ListGlobalTablesAsync(ListGlobalTablesRequest, CancellationToken)

Lists all global tables that have a replica in the specified Region.

note

This operation only applies to Version 2017.11.29 of global tables.

Task<ListGlobalTablesResponse> ListGlobalTablesAsync(ListGlobalTablesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListGlobalTablesRequest: Container for the necessary parameters to execute the ListGlobalTables service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListGlobalTablesResponse>: The response from the ListGlobalTables service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListGlobalTables Operation

ListImportsAsync(ListImportsRequest, CancellationToken)

Lists completed imports within the past 90 days.

Task<ListImportsResponse> ListImportsAsync(ListImportsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListImportsRequest: Container for the necessary parameters to execute the ListImports service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListImportsResponse>: The response from the ListImports service method, as returned by DynamoDB.

Exceptions

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

See Also: REST API Reference for ListImports Operation

ListTablesAsync(ListTablesRequest, CancellationToken)

Returns an array of table names associated with the current account and endpoint. The output from

ListTables

is paginated, with each page returning a maximum of 100 table names.

Task<ListTablesResponse> ListTablesAsync(ListTablesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListTablesRequest: Container for the necessary parameters to execute the ListTables service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTablesResponse>: The response from the ListTables service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListTables Operation

ListTablesAsync(int, CancellationToken)

Returns an array of table names associated with the current account and endpoint. The output from

ListTables

is paginated, with each page returning a maximum of 100 table names.

Task<ListTablesResponse> ListTablesAsync(int limit, CancellationToken cancellationToken = default)

Parameters

limit int: A maximum number of table names to return. If this parameter is not specified, the limit is 100.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTablesResponse>: The response from the ListTables service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListTables Operation

ListTablesAsync(string, int, CancellationToken)

Returns an array of table names associated with the current account and endpoint. The output from

ListTables

is paginated, with each page returning a maximum of 100 table names.

Task<ListTablesResponse> ListTablesAsync(string exclusiveStartTableName, int limit, CancellationToken cancellationToken = default)

Parameters

exclusiveStartTableName string

The first table name that this operation will evaluate. Use the value that was returned for

LastEvaluatedTableName

in a previous operation, so that you can obtain the next page of results.

limit int

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTablesResponse>: The response from the ListTables service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListTables Operation

ListTablesAsync(string, CancellationToken)

Returns an array of table names associated with the current account and endpoint. The output from

ListTables

is paginated, with each page returning a maximum of 100 table names.

Task<ListTablesResponse> ListTablesAsync(string exclusiveStartTableName, CancellationToken cancellationToken = default)

Parameters

exclusiveStartTableName string

The first table name that this operation will evaluate. Use the value that was returned for

LastEvaluatedTableName

in a previous operation, so that you can obtain the next page of results.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTablesResponse>: The response from the ListTables service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListTables Operation

ListTablesAsync(CancellationToken)

Returns an array of table names associated with the current account and endpoint. The output from

ListTables

is paginated, with each page returning a maximum of 100 table names.

Task<ListTablesResponse> ListTablesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTablesResponse>: The response from the ListTables service method, as returned by DynamoDB.

Exceptions

InternalServerErrorException: An error occurred on the server side.

See Also: REST API Reference for ListTables Operation

ListTagsOfResourceAsync(ListTagsOfResourceRequest, CancellationToken)

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Task<ListTagsOfResourceResponse> ListTagsOfResourceAsync(ListTagsOfResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request ListTagsOfResourceRequest: Container for the necessary parameters to execute the ListTagsOfResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTagsOfResourceResponse>: The response from the ListTagsOfResource service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for ListTagsOfResource Operation

PutItemAsync(PutItemRequest, CancellationToken)

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the

ReturnValues

parameter.

When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

Invalid Requests with empty values will be rejected with a

ValidationException

exception.

note

To prevent a new item from replacing an existing item, use a conditional expression that contains the

attribute_not_exists

function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the

attribute_not_exists

function will only succeed if no matching item exists.

For more information about

PutItem

, see Working with Items in the Amazon DynamoDB Developer Guide.

Task<PutItemResponse> PutItemAsync(PutItemRequest request, CancellationToken cancellationToken = default)

Parameters

request PutItemRequest: Container for the necessary parameters to execute the PutItem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutItemResponse>: The response from the PutItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for PutItem Operation

PutItemAsync(string, Dictionary<string, AttributeValue>, ReturnValue, CancellationToken)

ReturnValues

parameter.

When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

Invalid Requests with empty values will be rejected with a

ValidationException

exception.

note

To prevent a new item from replacing an existing item, use a conditional expression that contains the

attribute_not_exists

function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the

attribute_not_exists

function will only succeed if no matching item exists.

For more information about

PutItem

, see Working with Items in the Amazon DynamoDB Developer Guide.

Task<PutItemResponse> PutItemAsync(string tableName, Dictionary<string, AttributeValue> item, ReturnValue returnValues, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table to contain the item.

item Dictionary<string, AttributeValue>

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item. You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key. If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition. Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide. Each element in the

Item

map is an

AttributeValue

object.

returnValues ReturnValue

Use

ReturnValues

if you want to get the item attributes as they appeared before they were updated with the

PutItem

request. For

PutItem

, the valid values are:

```
NONE
```
- If
```
ReturnValues
```
is not specified, or if its value is
```
NONE
```
, then nothing is returned. (This setting is the default for
```
ReturnValues
```
.)
```
ALL_OLD
```
- If
```
PutItem
```
overwrote an attribute name-value pair, then the content of the old item is returned.

The values returned are strongly consistent. There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

note

The

ReturnValues

parameter is used by several DynamoDB operations; however,

PutItem

does not recognize any values other than

NONE

ALL_OLD

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutItemResponse>: The response from the PutItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for PutItem Operation

PutItemAsync(string, Dictionary<string, AttributeValue>, CancellationToken)

ReturnValues

parameter.

When you add an item, the primary key attributes are the only required attributes. Attribute values cannot be null.

Invalid Requests with empty values will be rejected with a

ValidationException

exception.

note

To prevent a new item from replacing an existing item, use a conditional expression that contains the

attribute_not_exists

function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the

attribute_not_exists

function will only succeed if no matching item exists.

For more information about

PutItem

, see Working with Items in the Amazon DynamoDB Developer Guide.

Task<PutItemResponse> PutItemAsync(string tableName, Dictionary<string, AttributeValue> item, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table to contain the item.

item Dictionary<string, AttributeValue>

Item

map is an

AttributeValue

object.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutItemResponse>: The response from the PutItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for PutItem Operation

QueryAsync(QueryRequest, CancellationToken)

You must provide the name of the partition key attribute and a single value for that attribute.

Query

returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

Use the

KeyConditionExpression

parameter to provide a specific value for the partition key. The

Query

operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the

Query

operation by specifying a sort key value and a comparison operator in

KeyConditionExpression

. To further refine the

Query

results, you can optionally provide a

FilterExpression

. A

FilterExpression

determines which items within the results should be returned to you. All of the other results are discarded.

Query

operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

note

DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a

FilterExpression

Query

results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the

ScanIndexForward

parameter to false.

A single

Query

operation will read up to the maximum number of items set (if using the

Limit

parameter) or a maximum of 1 MB of data and then apply any filtering to the results using

FilterExpression

. If

LastEvaluatedKey

is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

FilterExpression

is applied after a

Query

finishes, but before the results are returned. A

FilterExpression

cannot contain partition key or sort key attributes. You need to specify those attributes in the

KeyConditionExpression

note

Query

operation can return an empty result set and a

LastEvaluatedKey

if all the items read for the page of results are filtered out.

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the

ConsistentRead

parameter to

true

and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify

ConsistentRead

when querying a global secondary index.

Task<QueryResponse> QueryAsync(QueryRequest request, CancellationToken cancellationToken = default)

Parameters

request QueryRequest: Container for the necessary parameters to execute the Query service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<QueryResponse>: The response from the Query service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

BackupNotFoundException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for Query Operation

RestoreTableFromBackupAsync(RestoreTableFromBackupRequest, CancellationToken)

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

You can call

RestoreTableFromBackup

at a maximum rate of 10 times per second.

You must manually set up the following on the restored table:

Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings

Task<RestoreTableFromBackupResponse> RestoreTableFromBackupAsync(RestoreTableFromBackupRequest request, CancellationToken cancellationToken = default)

Parameters

request RestoreTableFromBackupRequest: Container for the necessary parameters to execute the RestoreTableFromBackup service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<RestoreTableFromBackupResponse>: The response from the RestoreTableFromBackup service method, as returned by DynamoDB.

Exceptions

BackupInUseException

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

Backup not found for the given BackupARN.

An error occurred on the server side.

TableAlreadyExistsException

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

A target table with the specified name already exists.

TableInUseException

A target table with the specified name is either being created or deleted.

See Also: REST API Reference for RestoreTableFromBackup Operation

RestoreTableToPointInTimeAsync(RestoreTableToPointInTimeRequest, CancellationToken)

Restores the specified table to the specified point in time within

EarliestRestorableDateTime

and

LatestRestorableDateTime

. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Provisioned read and write capacity
Encryption settings
All these settings come from the current settings of the source table at the time of restore.

You must manually set up the following on the restored table:

Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings
Point in time recovery settings

Task<RestoreTableToPointInTimeResponse> RestoreTableToPointInTimeAsync(RestoreTableToPointInTimeRequest request, CancellationToken cancellationToken = default)

Parameters

request RestoreTableToPointInTimeRequest: Container for the necessary parameters to execute the RestoreTableToPointInTime service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<RestoreTableToPointInTimeResponse>: The response from the RestoreTableToPointInTime service method, as returned by DynamoDB.

Exceptions

InvalidRestoreTimeException

An error occurred on the server side.

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

PointInTimeRecoveryUnavailableException

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

Point in time recovery has not yet been enabled for this source table.

TableAlreadyExistsException

A target table with the specified name already exists.

TableInUseException

A target table with the specified name is either being created or deleted.

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for RestoreTableToPointInTime Operation

ScanAsync(ScanRequest, CancellationToken)

The

Scan

operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a

FilterExpression

operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a

LastEvaluatedKey

value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single

Scan

operation reads up to the maximum number of items set (if using the

Limit

parameter) or a maximum of 1 MB of data and then apply any filtering to the results using

FilterExpression

. If

LastEvaluatedKey

is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan

operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel

Scan

operation by providing the

Segment

and

TotalSegments

parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Scan

uses eventually consistent reads when accessing the data in a table; therefore, the result set might not include the changes to data in the table immediately before the operation began. If you need a consistent copy of the data, as of the time that the

Scan

begins, you can set the

ConsistentRead

parameter to

true

Task<ScanResponse> ScanAsync(ScanRequest request, CancellationToken cancellationToken = default)

Parameters

request ScanRequest: Container for the necessary parameters to execute the Scan service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ScanResponse>: The response from the Scan service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for Scan Operation

ScanAsync(string, Dictionary<string, Condition>, CancellationToken)

The

Scan

operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a

FilterExpression

operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a

LastEvaluatedKey

value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single

Scan

operation reads up to the maximum number of items set (if using the

Limit

parameter) or a maximum of 1 MB of data and then apply any filtering to the results using

FilterExpression

. If

LastEvaluatedKey

is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan

operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel

Scan

operation by providing the

Segment

and

TotalSegments

parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Scan

Scan

begins, you can set the

ConsistentRead

parameter to

true

Task<ScanResponse> ScanAsync(string tableName, Dictionary<string, Condition> scanFilter, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the requested items; or, if you provide

IndexName

, the name of the table to which that index belongs.

scanFilter Dictionary<string, Condition>

This is a legacy parameter. Use

FilterExpression

instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ScanResponse>: The response from the Scan service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for Scan Operation

ScanAsync(string, List<string>, Dictionary<string, Condition>, CancellationToken)

The

Scan

operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a

FilterExpression

operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a

LastEvaluatedKey

value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single

Scan

operation reads up to the maximum number of items set (if using the

Limit

parameter) or a maximum of 1 MB of data and then apply any filtering to the results using

FilterExpression

. If

LastEvaluatedKey

is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan

operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel

Scan

operation by providing the

Segment

and

TotalSegments

parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Scan

Scan

begins, you can set the

ConsistentRead

parameter to

true

Task<ScanResponse> ScanAsync(string tableName, List<string> attributesToGet, Dictionary<string, Condition> scanFilter, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the requested items; or, if you provide

IndexName

, the name of the table to which that index belongs.

attributesToGet List<string>

This is a legacy parameter. Use

ProjectionExpression

instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

scanFilter Dictionary<string, Condition>

This is a legacy parameter. Use

FilterExpression

instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ScanResponse>: The response from the Scan service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for Scan Operation

ScanAsync(string, List<string>, CancellationToken)

The

Scan

operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a

FilterExpression

operation.

If the total number of scanned items exceeds the maximum dataset size limit of 1 MB, the scan stops and results are returned to the user as a

LastEvaluatedKey

value to continue the scan in a subsequent operation. The results also include the number of items exceeding the limit. A scan can result in no table data meeting the filter criteria.

A single

Scan

operation reads up to the maximum number of items set (if using the

Limit

parameter) or a maximum of 1 MB of data and then apply any filtering to the results using

FilterExpression

. If

LastEvaluatedKey

is present in the response, you need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan

operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel

Scan

operation by providing the

Segment

and

TotalSegments

parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Scan

Scan

begins, you can set the

ConsistentRead

parameter to

true

Task<ScanResponse> ScanAsync(string tableName, List<string> attributesToGet, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the requested items; or, if you provide

IndexName

, the name of the table to which that index belongs.

attributesToGet List<string>

This is a legacy parameter. Use

ProjectionExpression

instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ScanResponse>: The response from the Scan service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for Scan Operation

TagResourceAsync(TagResourceRequest, CancellationToken)

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Task<TagResourceResponse> TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request TagResourceRequest: Container for the necessary parameters to execute the TagResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TagResourceResponse>: The response from the TagResource service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for TagResource Operation

TransactGetItemsAsync(TransactGetItemsRequest, CancellationToken)

TransactGetItems

is a synchronous operation that atomically retrieves

    multiple items from one or more tables (but not from indexes) in a single account
    and Region. A <pre><code class="lang-csharp">TransactGetItems</code></pre> call can contain up to 100 <pre><code class="lang-csharp">TransactGetItem</code></pre>
    objects, each of which contains a <pre><code class="lang-csharp">Get</code></pre> structure that specifies an item
    to retrieve from a table in the account and Region. A call to <pre><code class="lang-csharp">TransactGetItems</code></pre>
    cannot retrieve items from tables in more than one Amazon Web Services account or
    Region. The aggregate size of the items in the transaction cannot exceed 4 MB.


    <p>
    DynamoDB rejects the entire <pre><code class="lang-csharp">TransactGetItems</code></pre> request if any of the following
    is true:
    </p><ul><li><p>
    A conflicting operation is in the process of updating an item to be read.
    </p></li><li><p>
    There is insufficient provisioned capacity for the transaction to be completed.
    </p></li><li><p>
    There is a user error, such as an invalid data format.
    </p></li><li><p>
    The aggregate size of the items in the transaction cannot exceed 4 MB.
    </p></li></ul>

Task<TransactGetItemsResponse> TransactGetItemsAsync(TransactGetItemsRequest request, CancellationToken cancellationToken = default)

Parameters

request TransactGetItemsRequest: Container for the necessary parameters to execute the TransactGetItems service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TransactGetItemsResponse>: The response from the TransactGetItems service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

TransactionCanceledException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

The entire transaction request was canceled.

DynamoDB cancels a

TransactWriteItems

request under the following circumstances:

A condition in one of the condition expressions is not met.
A table in the
```
TransactWriteItems
```
request is in a different account or region.
More than one action in the
```
TransactWriteItems
```
operation targets the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
There is a user error, such as an invalid data format.

DynamoDB cancels a

TransactGetItems

request under the following circumstances:

There is an ongoing
```
TransactGetItems
```
operation that conflicts with a concurrent
```
PutItem
```
,
```
UpdateItem
```
,
```
DeleteItem
```
or
```
TransactWriteItems
```
request. In this case the
```
TransactGetItems
```
operation fails with a
```
TransactionCanceledException
```
.
A table in the
```
TransactGetItems
```
request is in a different account or region.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.

note

If using Java, DynamoDB lists the cancellation reasons on the

CancellationReasons

property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have

None

code and

Null

message.

Cancellation reason codes and possible error messages:

No Errors:
- Code:
```
None
```
- Message:
```
null
```
Conditional Check Failed:
- Code:
```
ConditionalCheckFailed
```
- Message: The conditional request failed.
Item Collection Size Limit Exceeded:
- Code:
```
ItemCollectionSizeLimitExceeded
```
- Message: Collection size exceeded.
Transaction Conflict:
- Code:
```
TransactionConflict
```
- Message: Transaction is ongoing for the item.
Provisioned Throughput Exceeded:
- Code:
```
ProvisionedThroughputExceeded
```
- Messages:
  - The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
    note
    This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
  - The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
    note
    This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
Throttling Error:
- Code:
```
ThrottlingError
```
- Messages:
  - Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
    note
    This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
  - Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
    note
    This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
Validation Error:
- Code:
```
ValidationError
```
- Messages:
  - One or more parameter values were invalid.
  - The update expression attempted to update the secondary index key beyond allowed size limits.
  - The update expression attempted to update the secondary index key to unsupported type.
  - An operand in the update expression has an incorrect data type.
  - Item size to update has exceeded the maximum allowed size.
  - Number overflow. Attempting to store a number with magnitude larger than supported range.
  - Type mismatch for attribute to update.
  - Nesting Levels have exceeded supported limits.
  - The document path provided in the update expression is invalid for update.
  - The provided expression refers to an attribute that does not exist in the item.

See Also: REST API Reference for TransactGetItems Operation

TransactWriteItemsAsync(TransactWriteItemsRequest, CancellationToken)

TransactWriteItems

is a synchronous write operation that groups up to

    100 action requests. These actions can target items in different tables, but not in
    different Amazon Web Services accounts or Regions, and no two actions can target the
    same item. For example, you cannot both <pre><code class="lang-csharp">ConditionCheck</code></pre> and <pre><code class="lang-csharp">Update</code></pre>
    the same item. The aggregate size of the items in the transaction cannot exceed 4
    MB.


    <p>
    The actions are completed atomically so that either all of them succeed, or all of
    them fail. They are defined by the following objects:
    </p><ul><li><p>
                   <pre><code class="lang-csharp">Put</code></pre>  —   Initiates a <pre><code class="lang-csharp">PutItem</code></pre> operation to write a new item.
    This structure specifies the primary key of the item to be written, the name of the
    table to write it in, an optional condition expression that must be satisfied for
    the write to succeed, a list of the item's attributes, and a field indicating whether
    to retrieve the item's attributes if the condition is not met.
    </p></li><li><p>
                    <pre><code class="lang-csharp">Update</code></pre>  —   Initiates an <pre><code class="lang-csharp">UpdateItem</code></pre> operation to update
    an existing item. This structure specifies the primary key of the item to be updated,
    the name of the table where it resides, an optional condition expression that must
    be satisfied for the update to succeed, an expression that defines one or more attributes
    to be updated, and a field indicating whether to retrieve the item's attributes if
    the condition is not met.
    </p></li><li><p>
                    <pre><code class="lang-csharp">Delete</code></pre>  —   Initiates a <pre><code class="lang-csharp">DeleteItem</code></pre> operation to delete
    an existing item. This structure specifies the primary key of the item to be deleted,
    the name of the table where it resides, an optional condition expression that must
    be satisfied for the deletion to succeed, and a field indicating whether to retrieve
    the item's attributes if the condition is not met.
    </p></li><li><p>
                    <pre><code class="lang-csharp">ConditionCheck</code></pre>  —   Applies a condition to an item that is not being
    modified by the transaction. This structure specifies the primary key of the item
    to be checked, the name of the table where it resides, a condition expression that
    must be satisfied for the transaction to succeed, and a field indicating whether to
    retrieve the item's attributes if the condition is not met.
    </p></li></ul><p>
    DynamoDB rejects the entire <pre><code class="lang-csharp">TransactWriteItems</code></pre> request if any of the
    following is true:
    </p><ul><li><p>
    A condition in one of the condition expressions is not met.
    </p></li><li><p>
    An ongoing operation is in the process of updating the same item.
    </p></li><li><p>
    There is insufficient provisioned capacity for the transaction to be completed.
    </p></li><li><p>
    An item size becomes too large (bigger than 400 KB), a local secondary index (LSI)
    becomes too large, or a similar validation error occurs because of changes made by
    the transaction.
    </p></li><li><p>
    The aggregate size of the items in the transaction exceeds 4 MB.
    </p></li><li><p>
    There is a user error, such as an invalid data format.
    </p></li></ul>

Task<TransactWriteItemsResponse> TransactWriteItemsAsync(TransactWriteItemsRequest request, CancellationToken cancellationToken = default)

Parameters

request TransactWriteItemsRequest: Container for the necessary parameters to execute the TransactWriteItems service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TransactWriteItemsResponse>: The response from the TransactWriteItems service method, as returned by DynamoDB.

Exceptions

IdempotentParameterMismatchException

DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

An error occurred on the server side.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

TransactionCanceledException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

The entire transaction request was canceled.

DynamoDB cancels a

TransactWriteItems

request under the following circumstances:

A condition in one of the condition expressions is not met.
A table in the
```
TransactWriteItems
```
request is in a different account or region.
More than one action in the
```
TransactWriteItems
```
operation targets the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
There is a user error, such as an invalid data format.

DynamoDB cancels a

TransactGetItems

request under the following circumstances:

There is an ongoing
```
TransactGetItems
```
operation that conflicts with a concurrent
```
PutItem
```
,
```
UpdateItem
```
,
```
DeleteItem
```
or
```
TransactWriteItems
```
request. In this case the
```
TransactGetItems
```
operation fails with a
```
TransactionCanceledException
```
.
A table in the
```
TransactGetItems
```
request is in a different account or region.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.

note

If using Java, DynamoDB lists the cancellation reasons on the

CancellationReasons

property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have

None

code and

Null

message.

Cancellation reason codes and possible error messages:

No Errors:
- Code:
```
None
```
- Message:
```
null
```
Conditional Check Failed:
- Code:
```
ConditionalCheckFailed
```
- Message: The conditional request failed.
Item Collection Size Limit Exceeded:
- Code:
```
ItemCollectionSizeLimitExceeded
```
- Message: Collection size exceeded.
Transaction Conflict:
- Code:
```
TransactionConflict
```
- Message: Transaction is ongoing for the item.
Provisioned Throughput Exceeded:
- Code:
```
ProvisionedThroughputExceeded
```
- Messages:
  - The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.
    note
    This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.
  - The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.
    note
    This message is returned when provisioned throughput is exceeded is on a provisioned GSI.
Throttling Error:
- Code:
```
ThrottlingError
```
- Messages:
  - Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.
    note
    This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.
  - Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.
    note
    This message is returned when when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.
Validation Error:
- Code:
```
ValidationError
```
- Messages:
  - One or more parameter values were invalid.
  - The update expression attempted to update the secondary index key beyond allowed size limits.
  - The update expression attempted to update the secondary index key to unsupported type.
  - An operand in the update expression has an incorrect data type.
  - Item size to update has exceeded the maximum allowed size.
  - Number overflow. Attempting to store a number with magnitude larger than supported range.
  - Type mismatch for attribute to update.
  - Nesting Levels have exceeded supported limits.
  - The document path provided in the update expression is invalid for update.
  - The provided expression refers to an attribute that does not exist in the item.

TransactionInProgressException

The transaction with the given request token is already in progress.

See Also: REST API Reference for TransactWriteItems Operation

UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes the association of tags from an Amazon DynamoDB resource. You can call

UntagResource

up to five times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Task<UntagResourceResponse> UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request UntagResourceRequest: Container for the necessary parameters to execute the UntagResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UntagResourceResponse>: The response from the UntagResource service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

ContinuousBackupsUnavailableException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for UntagResource Operation

UpdateContinuousBackupsAsync(UpdateContinuousBackupsRequest, CancellationToken)

UpdateContinuousBackups

enables or disables point in time recovery for

    the specified table. A successful <pre><code class="lang-csharp">UpdateContinuousBackups</code></pre> call returns
    the current <pre><code class="lang-csharp">ContinuousBackupsDescription</code></pre>. Continuous backups are <pre><code class="lang-csharp">ENABLED</code></pre>
    on all tables at table creation. If point in time recovery is enabled, <pre><code class="lang-csharp">PointInTimeRecoveryStatus</code></pre>
    will be set to ENABLED.


    <p>
     Once continuous backups and point in time recovery are enabled, you can restore to
    any point in time within <pre><code class="lang-csharp">EarliestRestorableDateTime</code></pre> and <pre><code class="lang-csharp">LatestRestorableDateTime</code></pre>.

    </p><p>
           <pre><code class="lang-csharp">LatestRestorableDateTime</code></pre> is typically 5 minutes before the current time.
    You can restore your table to any point in time during the last 35 days. 
    </p>

Task<UpdateContinuousBackupsResponse> UpdateContinuousBackupsAsync(UpdateContinuousBackupsRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateContinuousBackupsRequest: Container for the necessary parameters to execute the UpdateContinuousBackups service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateContinuousBackupsResponse>: The response from the UpdateContinuousBackups service method, as returned by DynamoDB.

Exceptions

Backups have not yet been enabled for this table.

An error occurred on the server side.

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for UpdateContinuousBackups Operation

UpdateContributorInsightsAsync(UpdateContributorInsightsRequest, CancellationToken)

Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.

Task<UpdateContributorInsightsResponse> UpdateContributorInsightsAsync(UpdateContributorInsightsRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateContributorInsightsRequest: Container for the necessary parameters to execute the UpdateContributorInsights service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateContributorInsightsResponse>: The response from the UpdateContributorInsights service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

GlobalTableNotFoundException

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for UpdateContributorInsights Operation

UpdateGlobalTableAsync(UpdateGlobalTableRequest, CancellationToken)

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

note

Although you can use

UpdateGlobalTable

to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

If global secondary indexes are specified, then the following conditions must also be met:

The global secondary indexes must have the same name.
The global secondary indexes must have the same hash key and sort key (if present).
The global secondary indexes must have the same provisioned and maximum write capacity units.

Task<UpdateGlobalTableResponse> UpdateGlobalTableAsync(UpdateGlobalTableRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateGlobalTableRequest: Container for the necessary parameters to execute the UpdateGlobalTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateGlobalTableResponse>: The response from the UpdateGlobalTable service method, as returned by DynamoDB.

Exceptions

The specified global table does not exist.

ReplicaAlreadyExistsException

An error occurred on the server side.

The specified replica is already part of the global table.

ReplicaNotFoundException

The specified replica is no longer part of the global table.

GlobalTableNotFoundException

A source table with the name

TableName

does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

See Also: REST API Reference for UpdateGlobalTable Operation

UpdateGlobalTableSettingsAsync(UpdateGlobalTableSettingsRequest, CancellationToken)

Updates settings for a global table.

Task<UpdateGlobalTableSettingsResponse> UpdateGlobalTableSettingsAsync(UpdateGlobalTableSettingsRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateGlobalTableSettingsRequest: Container for the necessary parameters to execute the UpdateGlobalTableSettings service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateGlobalTableSettingsResponse>: The response from the UpdateGlobalTableSettings service method, as returned by DynamoDB.

Exceptions

The specified global table does not exist.

IndexNotFoundException

The operation tried to access a nonexistent index.

An error occurred on the server side.

ReplicaNotFoundException

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The specified replica is no longer part of the global table.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

See Also: REST API Reference for UpdateGlobalTableSettings Operation

UpdateItemAsync(UpdateItemRequest, CancellationToken)

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same

UpdateItem

operation using the

ReturnValues

parameter.

Task<UpdateItemResponse> UpdateItemAsync(UpdateItemRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateItemRequest: Container for the necessary parameters to execute the UpdateItem service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateItemResponse>: The response from the UpdateItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for UpdateItem Operation

UpdateItemAsync(string, Dictionary<string, AttributeValue>, Dictionary<string, AttributeValueUpdate>, ReturnValue, CancellationToken)

You can also return the item's attribute values in the same

UpdateItem

operation using the

ReturnValues

parameter.

Task<UpdateItemResponse> UpdateItemAsync(string tableName, Dictionary<string, AttributeValue> key, Dictionary<string, AttributeValueUpdate> attributeUpdates, ReturnValue returnValues, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the item to update.

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute. For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

attributeUpdates Dictionary<string, AttributeValueUpdate>

This is a legacy parameter. Use

UpdateExpression

instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

returnValues ReturnValue

Use

ReturnValues

if you want to get the item attributes as they appear before or after they are updated. For

UpdateItem

, the valid values are:

```
NONE
```
- If
```
ReturnValues
```
is not specified, or if its value is
```
NONE
```
, then nothing is returned. (This setting is the default for
```
ReturnValues
```
.)
```
ALL_OLD
```
- Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
```
UPDATED_OLD
```
- Returns only the updated attributes, as they appeared before the UpdateItem operation.
```
ALL_NEW
```
- Returns all of the attributes of the item, as they appear after the UpdateItem operation.
```
UPDATED_NEW
```
- Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed. The values returned are strongly consistent.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateItemResponse>: The response from the UpdateItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for UpdateItem Operation

UpdateItemAsync(string, Dictionary<string, AttributeValue>, Dictionary<string, AttributeValueUpdate>, CancellationToken)

You can also return the item's attribute values in the same

UpdateItem

operation using the

ReturnValues

parameter.

Task<UpdateItemResponse> UpdateItemAsync(string tableName, Dictionary<string, AttributeValue> key, Dictionary<string, AttributeValueUpdate> attributeUpdates, CancellationToken cancellationToken = default)

Parameters

tableName string

The name of the table containing the item to update.

attributeUpdates Dictionary<string, AttributeValueUpdate>

This is a legacy parameter. Use

UpdateExpression

instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

cancellationToken CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateItemResponse>: The response from the UpdateItem service method, as returned by DynamoDB.

Exceptions

A condition specified in the operation could not be evaluated.

An error occurred on the server side.

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

Operation was rejected because there is an ongoing transaction for the item.

See Also: REST API Reference for UpdateItem Operation

UpdateTableAsync(UpdateTableRequest, CancellationToken)

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use
```
UpdateTable
```
to perform other operations.

UpdateTable

is an asynchronous operation; while it is executing, the table status changes from

ACTIVE

UPDATING

. While it is

UPDATING

, you cannot issue another

UpdateTable

request. When the table returns to the

ACTIVE

state, the

UpdateTable

operation is complete.

Task<UpdateTableResponse> UpdateTableAsync(UpdateTableRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateTableRequest: Container for the necessary parameters to execute the UpdateTable service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateTableResponse>: The response from the UpdateTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for UpdateTable Operation

UpdateTableAsync(string, ProvisionedThroughput, CancellationToken)

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

You can only perform one of the following operations at once:

Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use
```
UpdateTable
```
to perform other operations.

UpdateTable

is an asynchronous operation; while it is executing, the table status changes from

ACTIVE

UPDATING

. While it is

UPDATING

, you cannot issue another

UpdateTable

request. When the table returns to the

ACTIVE

state, the

UpdateTable

operation is complete.

Task<UpdateTableResponse> UpdateTableAsync(string tableName, ProvisionedThroughput provisionedThroughput, CancellationToken cancellationToken = default)

Parameters

tableName string: The name of the table to be updated.
provisionedThroughput ProvisionedThroughput: The new provisioned throughput settings for the specified table or index.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateTableResponse>: The response from the UpdateTable service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for UpdateTable Operation

UpdateTableReplicaAutoScalingAsync(UpdateTableReplicaAutoScalingRequest, CancellationToken)

Updates auto scaling settings on your global tables at once.

note

This operation only applies to Version 2019.11.21 of global tables.

Task<UpdateTableReplicaAutoScalingResponse> UpdateTableReplicaAutoScalingAsync(UpdateTableReplicaAutoScalingRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateTableReplicaAutoScalingRequest: Container for the necessary parameters to execute the UpdateTableReplicaAutoScaling service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateTableReplicaAutoScalingResponse>: The response from the UpdateTableReplicaAutoScaling service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be

ACTIVE

See Also: REST API Reference for UpdateTableReplicaAutoScaling Operation

UpdateTimeToLiveAsync(UpdateTimeToLiveRequest, CancellationToken)

The

UpdateTimeToLive

method enables or disables Time to Live (TTL) for the specified table. A successful

UpdateTimeToLive

call returns the current

TimeToLiveSpecification

. It can take up to one hour for the change to

fully process. Any additional

UpdateTimeToLive

calls for the same table during this one hour duration result in a

ValidationException

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

note

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

Task<UpdateTimeToLiveResponse> UpdateTimeToLiveAsync(UpdateTimeToLiveRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateTimeToLiveRequest: Container for the necessary parameters to execute the UpdateTimeToLive service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateTimeToLiveResponse>: The response from the UpdateTimeToLive service method, as returned by DynamoDB.

Exceptions

An error occurred on the server side.

There is no limit to the number of daily on-demand backups that can be taken.

Up to 500 simultaneous table operations are allowed per account. These operations include

CreateTable

UpdateTable

DeleteTable

UpdateTimeToLive

RestoreTableFromBackup

, and

RestoreTableToPointInTime

There is a soft account quota of 2,500 tables.

The operation conflicts with the resource's availability. For example, you attempted to recreate an existing table, or tried to delete a table currently in the

CREATING

state.