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

Container for the parameters to the GetItem operation. More...

Inheritance diagram for Amazon.DynamoDBv2.Model.GetItemRequest:
Amazon.DynamoDBv2.AmazonDynamoDBv2Request

Properties

string TableName [get, set]
 The name of the table containing the requested item. More...
 
Dictionary< string,
AttributeValue
Key [get, set]
 A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve. More...
 
List< string > AttributesToGet [get, set]
 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. More...
 
bool ConsistentRead [get, set]
 If set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used. More...
 
ReturnConsumedCapacity ReturnConsumedCapacity [get, set]
 If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included. More...
 

Detailed Description

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.

Property Documentation

List<string> Amazon.DynamoDBv2.Model.GetItemRequest.AttributesToGet
getset

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:

  • Length 1 -
bool Amazon.DynamoDBv2.Model.GetItemRequest.ConsistentRead
getset

If set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.

Dictionary<string,AttributeValue> Amazon.DynamoDBv2.Model.GetItemRequest.Key
getset

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

ReturnConsumedCapacity Amazon.DynamoDBv2.Model.GetItemRequest.ReturnConsumedCapacity
getset

If set to TOTAL, ConsumedCapacity is included in the response; if set to NONE (the default), ConsumedCapacity is not included.

Constraints:

  • Allowed Values INDEXES, TOTAL, NONE
string Amazon.DynamoDBv2.Model.GetItemRequest.TableName
getset

The name of the table containing the requested item.

Constraints:

  • Length 3 - 255
  • Pattern [a-zA-Z0-9_.-]+

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