GetItemRequest Class

.NET Framework 4.5
 
 
 
Did this page help you?  Yes  No   Tell us about it...
Container for the parameters to the GetItem operation.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.DynamoDBv2.Model.GetItemRequest

Namespace: Amazon.DynamoDBv2.Model
Assembly: AWSSDK.dll
Version: 2.0.0.3

Syntax

C#
public class GetItemRequest : AmazonWebServiceRequest
         IRequestEvents

The GetItemRequest type exposes the following members

Constructors

  Name Description
Public Method GetItemRequest()

Properties

  Name Description
Public Property AttributesToGet The names of one or more attributes to retrieve. If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

Constraints:Length1 -

Public Property ConsistentRead If set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.
Public Property Key A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.
Public Property ReturnConsumedCapacity If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:Allowed ValuesTOTAL, NONE

Public Property TableName The name of the table containing the requested item.

Constraints:Length3 - 255Pattern[a-zA-Z0-9_.-]+

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
GetItemResult result = client.GetItem(request).GetItemResult;

// 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, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8

.NET for Windows Phone:
Supported in: Window Phone 8