Twoorb Plugins  1.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Amazon.DynamoDBv2.AmazonDynamoDBClient Class Reference

Implementation for accessing AmazonDynamoDBv2. More...

Inheritance diagram for Amazon.DynamoDBv2.AmazonDynamoDBClient:
Amazon.DynamoDBv2.IAmazonDynamoDB Amazon.DynamoDBv2.IAmazonDynamoDB

Public Member Functions

 AmazonDynamoDBClient (string awsAccessKeyId, string awsSecretAccessKey, AmazonDynamoDBConfig clientConfig)
 Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. More...
 
void BatchGetItem (BatchGetItemRequest batchGetItemRequest, Action< BatchGetItemResponse > responseCallback)
 
BatchGetItemResponse EndBatchGetItem (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the BatchGetItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem
More...
 
void BatchWriteItem (BatchWriteItemRequest batchWriteItemRequest, Action< BatchWriteItemResponse > responseCallback)
 
BatchWriteItemResponse EndBatchWriteItem (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the BatchWriteItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItem
More...
 
void CreateTable (CreateTableRequest createTableRequest, Action< CreateTableResponse > responseCallback)
 
CreateTableResponse EndCreateTable (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the CreateTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTable
More...
 
void DeleteItem (DeleteItemRequest deleteItemRequest, Action< DeleteItemResponse > responseCallback)
 
DeleteItemResponse EndDeleteItem (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem
More...
 
void DeleteTable (DeleteTableRequest deleteTableRequest, Action< DeleteTableResponse > responseCallback)
 
DeleteTableResponse EndDeleteTable (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DeleteTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTable
More...
 
void DescribeTable (DescribeTableRequest describeTableRequest, Action< DescribeTableResponse > responseCallback)
 
DescribeTableResponse EndDescribeTable (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the DescribeTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTable
More...
 
void GetItem (GetItemRequest getItemRequest, Action< GetItemResponse > responseCallback)
 
GetItemResponse EndGetItem (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the GetItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem
More...
 
void ListTables (ListTablesRequest listTablesRequest, Action< ListTablesResponse > responseCallback)
 
ListTablesResponse EndListTables (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the ListTables operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables
More...
 
void PutItem (PutItemRequest putItemRequest, Action< PutItemResponse > responseCallback)
 
PutItemResponse EndPutItem (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the PutItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem
More...
 
void Query (QueryRequest queryRequest, Action< QueryResponse > responseCallback)
 
QueryResponse EndQuery (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the Query operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.Query
More...
 
void Scan (ScanRequest scanRequest, Action< ScanResponse > responseCallback)
 
ScanResponse EndScan (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the Scan operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.Scan
More...
 
void UpdateItem (UpdateItemRequest updateItemRequest, Action< UpdateItemResponse > responseCallback)
 
UpdateItemResponse EndUpdateItem (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the UpdateItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem
More...
 
void UpdateTable (UpdateTableRequest updateTableRequest, Action< UpdateTableResponse > responseCallback)
 
UpdateTableResponse EndUpdateTable (IAsyncResult asyncResult)
 Finishes the asynchronous execution of the UpdateTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTable
More...
 

Protected Member Functions

override void Dispose (bool disposing)
 
override void pauseExponentially (int retries)
 Override the pausing function so retries would happen more frequent then the default operation. More...
 

Detailed Description

Implementation for accessing AmazonDynamoDBv2.

Amazon DynamoDB Overview

This is the Amazon DynamoDB API Reference. This guide provides descriptions and samples of the Amazon DynamoDB API.

Constructor & Destructor Documentation

Amazon.DynamoDBv2.AmazonDynamoDBClient.AmazonDynamoDBClient ( string  awsAccessKeyId,
string  awsSecretAccessKey,
AmazonDynamoDBConfig  clientConfig 
)

Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object.

Parameters
awsAccessKeyIdAWS Access Key ID
awsSecretAccessKeyAWS Secret Access Key
clientConfigThe AmazonDynamoDBClient Configuration Object

Member Function Documentation

void Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchGetItem ( BatchGetItemRequest  batchGetItemRequest,
Action< BatchGetItemResponse responseCallback 
)

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 1 MB of data, which can comprise as many as 100 items. BatchGetItem will return a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys . You can use this value to retry the operation starting with the next item to get.

For example, if you ask to retrieve 100 items, but each individual item is 50 KB in size, the system returns 20 items (1 MB) and 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 no items can be processed because of insufficient provisioned throughput on each of the tables involved in the request, BatchGetItem throws ProvisionedThroughputExceededException .

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem fetches items in parallel.

When designing your application, keep in mind that Amazon DynamoDB does not return attributes in any particular order. To help parse the response by item, include the primary key values for the items in your request in the AttributesToGet parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Capacity Units Calculations in the Amazon DynamoDB Developer Guide.

Parameters
batchGetItemRequestContainer for the necessary parameters to execute the BatchGetItem service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the BatchGetItem service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceNotFoundException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.BatchWriteItem ( BatchWriteItemRequest  batchWriteItemRequest,
Action< BatchWriteItemResponse responseCallback 
)

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can write up to 1 MB of data, which can comprise as many as 25 put or delete requests. Individual items to be written can be as large as 64 KB.

NOTE: BatchWriteItem cannot update items. To update items, use the UpdateItem API.

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.

To write one item, you can use the PutItem operation; to delete one item, you can use the DeleteItem operation.

With BatchWriteItem , you can efficiently write or delete large amounts of data, such as from Amazon Elastic MapReduce (EMR), or copy data from another database into Amazon 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, such as Java, 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, such as PHP, BatchWriteItem will write or delete the specified items one at a time. In both situations, BatchWriteItem provides an alternative where the API 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, Amazon 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.

The total request size exceeds 1 MB.

Any individual item in a batch exceeds 64 KB.

Parameters
batchWriteItemRequestContainer for the necessary parameters to execute the BatchWriteItem service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the BatchWriteItem service method, as returned by AmazonDynamoDBv2.
Exceptions
ItemCollectionSizeLimitExceededException
Exceptions
ResourceNotFoundException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.CreateTable ( CreateTableRequest  createTableRequest,
Action< CreateTableResponse responseCallback 
)

The CreateTable operation adds a new table to your account. In an AWS 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, Amazon DynamoDB immediately returns a response with a TableStatus of CREATING . After the table is created, Amazon DynamoDB sets the TableStatus to ACTIVE . You can perform read and write operations only on an ACTIVE table.

If you want to create multiple tables with local secondary indexes on them, you must create them sequentially. Only one table with local secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable API to check the table status.

Parameters
createTableRequestContainer for the necessary parameters to execute the CreateTable service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the CreateTable service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceInUseException
Exceptions
LimitExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteItem ( DeleteItemRequest  deleteItemRequest,
Action< DeleteItemResponse responseCallback 
)

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 only deleting items if specific conditions are met. If those conditions are met, Amazon DynamoDB performs the delete. Otherwise, the item is not deleted.

Parameters
deleteItemRequestContainer for the necessary parameters to execute the DeleteItem service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the DeleteItem service method, as returned by AmazonDynamoDBv2.
Exceptions
ItemCollectionSizeLimitExceededException
Exceptions
ResourceNotFoundException
Exceptions
ConditionalCheckFailedException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.DeleteTable ( DeleteTableRequest  deleteTableRequest,
Action< DeleteTableResponse responseCallback 
)

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until Amazon DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then Amazon DynamoDB returns a ResourceInUseException . If the specified table does not exist, Amazon DynamoDB returns a ResourceNotFoundException . If table is already in the DELETING state, no error is returned.

NOTE: Amazon 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 local secondary indexes on that table are also deleted.

Use the DescribeTable API to check the status of the table.

Parameters
deleteTableRequestContainer for the necessary parameters to execute the DeleteTable service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the DeleteTable service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceInUseException
Exceptions
ResourceNotFoundException
Exceptions
LimitExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.DescribeTable ( DescribeTableRequest  describeTableRequest,
Action< DescribeTableResponse responseCallback 
)

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.

Parameters
describeTableRequestContainer for the necessary parameters to execute the DescribeTable service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the DescribeTable service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceNotFoundException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

BatchGetItemResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndBatchGetItem ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the BatchGetItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.BatchGetItem

Parameters
asyncResultThe IAsyncResult returned by the call to BeginBatchGetItem.
Returns
Returns a BatchGetItemResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

BatchWriteItemResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndBatchWriteItem ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the BatchWriteItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.BatchWriteItem

Parameters
asyncResultThe IAsyncResult returned by the call to BeginBatchWriteItem.
Returns
Returns a BatchWriteItemResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

CreateTableResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndCreateTable ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the CreateTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.CreateTable

Parameters
asyncResultThe IAsyncResult returned by the call to BeginCreateTable.
Returns
Returns a CreateTableResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

DeleteItemResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDeleteItem ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the DeleteItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteItem

Parameters
asyncResultThe IAsyncResult returned by the call to BeginDeleteItem.
Returns
Returns a DeleteItemResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

DeleteTableResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDeleteTable ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the DeleteTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.DeleteTable

Parameters
asyncResultThe IAsyncResult returned by the call to BeginDeleteTable.
Returns
Returns a DeleteTableResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

DescribeTableResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndDescribeTable ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the DescribeTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.DescribeTable

Parameters
asyncResultThe IAsyncResult returned by the call to BeginDescribeTable.
Returns
Returns a DescribeTableResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

GetItemResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndGetItem ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the GetItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.GetItem

Parameters
asyncResultThe IAsyncResult returned by the call to BeginGetItem.
Returns
Returns a GetItemResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

ListTablesResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndListTables ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the ListTables operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.ListTables

Parameters
asyncResultThe IAsyncResult returned by the call to BeginListTables.
Returns
Returns a ListTablesResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

PutItemResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndPutItem ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the PutItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.PutItem

Parameters
asyncResultThe IAsyncResult returned by the call to BeginPutItem.
Returns
Returns a PutItemResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

QueryResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndQuery ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the Query operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.Query

Parameters
asyncResultThe IAsyncResult returned by the call to BeginQuery.
Returns
Returns a QueryResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

ScanResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndScan ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the Scan operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.Scan

Parameters
asyncResultThe IAsyncResult returned by the call to BeginScan.
Returns
Returns a ScanResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

UpdateItemResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndUpdateItem ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the UpdateItem operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateItem

Parameters
asyncResultThe IAsyncResult returned by the call to BeginUpdateItem.
Returns
Returns a UpdateItemResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

UpdateTableResponse Amazon.DynamoDBv2.AmazonDynamoDBClient.EndUpdateTable ( IAsyncResult  asyncResult)

Finishes the asynchronous execution of the UpdateTable operation.

See Also
Amazon.DynamoDBv2.IAmazonDynamoDB.UpdateTable

Parameters
asyncResultThe IAsyncResult returned by the call to BeginUpdateTable.
Returns
Returns a UpdateTableResult from AmazonDynamoDBv2.

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.GetItem ( GetItemRequest  getItemRequest,
Action< GetItemResponse responseCallback 
)

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.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true . Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Parameters
getItemRequestContainer for the necessary parameters to execute the GetItem service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the GetItem service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceNotFoundException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.ListTables ( ListTablesRequest  listTablesRequest,
Action< ListTablesResponse responseCallback 
)

Returns an array of all the tables associated with the current account and endpoint.

Parameters
listTablesRequestContainer for the necessary parameters to execute the ListTables service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the ListTables service method, as returned by AmazonDynamoDBv2.
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

override void Amazon.DynamoDBv2.AmazonDynamoDBClient.pauseExponentially ( int  retries)
protected

Override the pausing function so retries would happen more frequent then the default operation.

Parameters
retriesCurrent number of retries.
void Amazon.DynamoDBv2.AmazonDynamoDBClient.PutItem ( PutItemRequest  putItemRequest,
Action< PutItemResponse responseCallback 
)

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

In addition to putting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attribute(s) are the only required attributes. Attribute values cannot be null. String and binary type attributes must have lengths greater than zero. Set type attributes cannot be empty. Requests with empty values will be rejected with a ValidationException .

You can request that PutItem return either a copy of the old item (before the update) or a copy of the new item (after the update). For more information, see the ReturnValues description.

NOTE: To prevent a new item from replacing an existing item, use a conditional put operation with Exists set to false for the primary key attribute, or attributes.

For more information about using this API, see Working with Items in the Amazon DynamoDB Developer Guide.

Parameters
putItemRequestContainer for the necessary parameters to execute the PutItem service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the PutItem service method, as returned by AmazonDynamoDBv2.
Exceptions
ItemCollectionSizeLimitExceededException
Exceptions
ResourceNotFoundException
Exceptions
ConditionalCheckFailedException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.Query ( QueryRequest  queryRequest,
Action< QueryResponse responseCallback 
)

A Query operation directly accesses items from a table using the table primary key, or from an index using the index key. You must provide a specific hash key value. You can narrow the scope of the query by using comparison operators on the range key value, or on the index key. You can use the ScanIndexForward parameter to get results in forward or reverse order, by range key or by index key.

Queries that do not return results consume the minimum read capacity units according to the type of read.

If the total number of items meeting the query criteria exceeds the result set size limit of 1 MB, the query stops and results are returned to the user with a LastEvaluatedKey to continue the query in a subsequent operation. Unlike a Scan operation, a Query operation never returns an empty result set and a LastEvaluatedKey . The LastEvaluatedKey is only provided if the results exceed 1 MB, or if you have used Limit .

To request a strongly consistent result, set ConsistentRead to true.

Parameters
queryRequestContainer for the necessary parameters to execute the Query service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the Query service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceNotFoundException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.Scan ( ScanRequest  scanRequest,
Action< ScanResponse responseCallback 
)

The Scan operation returns one or more items and item attributes by accessing every item in the table. To have Amazon DynamoDB return fewer items, you can provide a ScanFilter .

If the total number of scanned items exceeds the maximum data set size limit of 1 MB, the scan stops and results are returned to the user with a LastEvaluatedKey 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.

The result set is eventually consistent.

By default, Scan operations proceed sequentially; however, for faster performance on large tables, applications can request a parallel Scan by specifying the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

Parameters
scanRequestContainer for the necessary parameters to execute the Scan service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the Scan service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceNotFoundException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateItem ( UpdateItemRequest  updateItemRequest,
Action< UpdateItemResponse responseCallback 
)

Edits an existing item's attributes, or inserts a new item if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update (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).

In addition to updating an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Parameters
updateItemRequestContainer for the necessary parameters to execute the UpdateItem service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the UpdateItem service method, as returned by AmazonDynamoDBv2.
Exceptions
ItemCollectionSizeLimitExceededException
Exceptions
ResourceNotFoundException
Exceptions
ConditionalCheckFailedException
Exceptions
ProvisionedThroughputExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.

void Amazon.DynamoDBv2.AmazonDynamoDBClient.UpdateTable ( UpdateTableRequest  updateTableRequest,
Action< UpdateTableResponse responseCallback 
)

Updates the provisioned throughput for the given table. Setting the throughput for a table helps you manage performance and is part of the provisioned throughput feature of Amazon DynamoDB.

The provisioned throughput values can be upgraded or downgraded based on the maximums and minimums listed in the Limits section in the Amazon DynamoDB Developer Guide.

The table must be in the ACTIVE state for this operation to succeed. UpdateTable is an asynchronous operation; while executing the operation, the table is in the UPDATING state. While the table is in the UPDATING state, the table still has the provisioned throughput from before the call. The new provisioned throughput setting is in effect only when the table returns to the ACTIVE state after the UpdateTable operation.

You cannot add, modify or delete local secondary indexes using UpdateTable . Local secondary indexes can only be defined at table creation time.

Parameters
updateTableRequestContainer for the necessary parameters to execute the UpdateTable service method on AmazonDynamoDBv2.
responseCallbackThe response action that's called when the operation is complete. Upon Failure, the response will be returned with a null parameter
Returns
The response from the UpdateTable service method, as returned by AmazonDynamoDBv2.
Exceptions
ResourceInUseException
Exceptions
ResourceNotFoundException
Exceptions
LimitExceededException
Exceptions
InternalServerErrorException

Implements Amazon.DynamoDBv2.IAmazonDynamoDB.


The documentation for this class was generated from the following files: