AmazonDynamoDBClient.GetItem Method (GetItemRequest)

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 to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetItemAsync.

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

Syntax

public virtual GetItemResponse GetItem(
         GetItemRequest request
)

Parameters

request: Type: Amazon.DynamoDBv2.Model.GetItemRequest

Container for the necessary parameters to execute the GetItem service method.

Return Value

Type: GetItemResponse

The response from the GetItem service method, as returned by DynamoDB.

Exceptions

Exception	Condition
InternalServerErrorException	An error occurred on the server side.
ProvisionedThroughputExceededException	The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. 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.
RequestLimitExceededException	Throughput exceeds the current throughput quota for your account. For detailed information about why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception. Contact Amazon Web ServicesSupport to request a quota increase.
ResourceNotFoundException	The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.
ThrottlingException	The request was denied due to request throttling. For detailed information about why the request was throttled and the ARN of the impacted resource, find the ThrottlingReason field in the returned exception.

Examples

This example shows how to get an item in a table.

GetItem sample


// Create a client
AmazonDynamoDBClient client = new AmazonDynamoDBClient();

// Define item key
//  Hash-key of the target item is string value "Mark Twain"
//  Range-key of the target item is string value "The Adventures of Tom Sawyer"
Dictionary<string, AttributeValue> key = new Dictionary<string, AttributeValue>
{
    { "Author", new AttributeValue { S = "Mark Twain" } },
    { "Title", new AttributeValue { S = "The Adventures of Tom Sawyer" } }
};

// Create GetItem request
GetItemRequest request = new GetItemRequest
{
    TableName = "SampleTable",
    Key = key,
};

// Issue request
var result = client.GetItem(request);

// View response
Console.WriteLine("Item:");
Dictionary<string, AttributeValue> item = result.Item;
foreach (var keyValuePair in item)
{
    Console.WriteLine("{0} : S={1}, N={2}, SS=[{3}], NS=[{4}]",
        keyValuePair.Key,
        keyValuePair.Value.S,
        keyValuePair.Value.N,
        string.Join(", ", keyValuePair.Value.SS ?? new List<string>()),
        string.Join(", ", keyValuePair.Value.NS ?? new List<string>()));
}

Version Information

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

AmazonDynamoDBClient.GetItem (GetItemRequest)

Method