AWS SDK for .NET Documentation
AmazonDynamoDBClient Class
AmazonAmazon.DynamoDBAmazonDynamoDBClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing AmazonDynamoDB.

Amazon DynamoDB is a fast, highly scalable, highly available, cost-effective non-relational database service.

Amazon DynamoDB removes traditional scalability limitations on data storage while maintaining low latency and predictable performance.

Declaration Syntax
C#
public class AmazonDynamoDBClient : AmazonWebServiceClient, 
	AmazonDynamoDB, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
AmazonDynamoDBClient()()()()
Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonDynamoDBClient(RegionEndpoint)
Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonDynamoDBClient(AmazonDynamoDBConfig)
Constructs AmazonDynamoDBClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonDynamoDBClient(AWSCredentials)
Constructs AmazonDynamoDBClient with AWS Credentials

AmazonDynamoDBClient(AWSCredentials, RegionEndpoint)
Constructs AmazonDynamoDBClient with AWS Credentials

AmazonDynamoDBClient(AWSCredentials, AmazonDynamoDBConfig)
Constructs AmazonDynamoDBClient with AWS Credentials and an AmazonDynamoDBClient Configuration object.

AmazonDynamoDBClient(String, String)
Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key

AmazonDynamoDBClient(String, String, RegionEndpoint)
Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key

AmazonDynamoDBClient(String, String, AmazonDynamoDBConfig)
Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AmazonDynamoDBClient(String, String, String)
Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key

AmazonDynamoDBClient(String, String, String, RegionEndpoint)
Constructs AmazonDynamoDBClient with AWS Access Key ID and AWS Secret Key

AmazonDynamoDBClient(String, String, String, AmazonDynamoDBConfig)
Constructs AmazonDynamoDBClient with AWS Access Key ID, AWS Secret Key and an AmazonDynamoDBClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BatchGetItem(BatchGetItemRequest)

Retrieves the attributes for multiple items from multiple tables using their primary keys.

The maximum number of item attributes that can be retrieved for a single operation is 100. Also, the number of items retrieved is constrained by a 1 MB the size limit. If the response size limit is exceeded or a partial result is returned due to an internal processing failure, Amazon DynamoDB returns an UnprocessedKeys value so you can retry the operation starting with the next item to get.

Amazon DynamoDB automatically adjusts the number of items returned per page to enforce this limit. For example, even if you ask to retrieve 100 items, but each individual item is 50k in size, the system returns 20 items and an appropriate UnprocessedKeys value so you can get the next page of results. If necessary, your application needs its own logic to assemble the pages of results into one set.


BatchWriteItem(BatchWriteItemRequest)

Allows to execute a batch of Put and/or Delete Requests for many tables in a single call. A total of 25 requests are allowed.

There are no transaction guarantees provided by this API. It does not allow conditional puts nor does it support return values.


BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginBatchGetItem(BatchGetItemRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the BatchGetItem operation.

BeginBatchWriteItem(BatchWriteItemRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the BatchWriteItem operation.

BeginCreateTable(CreateTableRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateTable operation.

BeginDeleteItem(DeleteItemRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteItem operation.

BeginDeleteTable(DeleteTableRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteTable operation.

BeginDescribeTable(DescribeTableRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeTable operation.

BeginGetItem(GetItemRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetItem operation.

BeginListTables(ListTablesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListTables operation.

BeginPutItem(PutItemRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the PutItem operation.

BeginQuery(QueryRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the Query operation.

BeginScan(ScanRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the Scan operation.

BeginUpdateItem(UpdateItemRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateItem operation.

BeginUpdateTable(UpdateTableRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateTable operation.

CreateTable(CreateTableRequest)

Adds a new table to your account.

The table name must be unique among those associated with the AWS Account issuing the request, and the AWS Region that receives the request (e.g. us-east-1 ).

The CreateTable operation triggers an asynchronous workflow to begin creating the table. Amazon DynamoDB immediately returns the state of the table ( CREATING ) until the table is in the ACTIVE state. Once the table is in the ACTIVE state, you can perform data plane operations.


DeleteItem(DeleteItemRequest)

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.


DeleteTable(DeleteTableRequest)

Deletes a table and all of its items.

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 .


DescribeTable(DescribeTableRequest)

Retrieves information about the table, including the current status of the table, the primary key schema and when the table was created.

If the table does not exist, Amazon DynamoDB returns a ResourceNotFoundException .


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndBatchGetItem(IAsyncResult)
Finishes the asynchronous execution of the BatchGetItem operation.

EndBatchWriteItem(IAsyncResult)
Finishes the asynchronous execution of the BatchWriteItem operation.

EndCreateTable(IAsyncResult)
Finishes the asynchronous execution of the CreateTable operation.

EndDeleteItem(IAsyncResult)
Finishes the asynchronous execution of the DeleteItem operation.

EndDeleteTable(IAsyncResult)
Finishes the asynchronous execution of the DeleteTable operation.

EndDescribeTable(IAsyncResult)
Finishes the asynchronous execution of the DescribeTable operation.

EndGetItem(IAsyncResult)
Finishes the asynchronous execution of the GetItem operation.

EndListTables(IAsyncResult)
Finishes the asynchronous execution of the ListTables operation.

EndPutItem(IAsyncResult)
Finishes the asynchronous execution of the PutItem operation.

EndQuery(IAsyncResult)
Finishes the asynchronous execution of the Query operation.

EndScan(IAsyncResult)
Finishes the asynchronous execution of the Scan operation.

EndUpdateItem(IAsyncResult)
Finishes the asynchronous execution of the UpdateItem operation.

EndUpdateTable(IAsyncResult)
Finishes the asynchronous execution of the UpdateTable operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetItem(GetItemRequest)

Retrieves a set of Attributes for an item that matches the primary key.

The GetItem operation provides an eventually-consistent read by default. If eventually-consistent reads are not acceptable for your application, use ConsistentRead . Although this operation might take longer than a standard read, it always returns the last updated value.


GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ListTables(ListTablesRequest)

Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. us-east-1 ).


ListTables()()()()

Retrieves a paginated list of table names created by the AWS Account of the caller in the AWS Region (e.g. us-east-1 ).


PutItem(PutItemRequest)

Creates a new item, or replaces an old item with a new item (including all the attributes).

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.


Query(QueryRequest)

Gets the values of one or more items and its attributes by primary key (composite primary key, only).

Narrow the scope of the query using comparison operators on the RangeKeyValue of the composite key. Use the ScanIndexForward parameter to get results in forward or reverse order by range key.


Scan(ScanRequest)

Retrieves one or more items and its attributes by performing a full scan of a table.

Provide a ScanFilter to get more specific results.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UpdateItem(UpdateItemRequest)

Edits an existing item's attributes.

You can 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).


UpdateTable(UpdateTableRequest)

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.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonDynamoDBClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)