amazonka-dynamodb-0.3.6: Amazon DynamoDB SDK.

Safe HaskellNone




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.



Request constructor

Request lenses

giAttributesToGet :: Lens' GetItem (NonEmpty Text) Source

This is a legacy parameter, for backward compatibility. New applications should use ProjectionExpression instead. Do not combine legacy parameters and expression parameters in a single API call; otherwise, DynamoDB will return a ValidationException exception.

This parameter allows you to retrieve attributes of type List or Map; however, it cannot retrieve individual elements within a List or a Map.

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

Note that AttributesToGet has no effect on provisioned throughput consumption. DynamoDB determines capacity units consumed based on item size, not on the amount of data that is returned to an application.

giConsistentRead :: Lens' GetItem (Maybe Bool) Source

A value that if set to true, then the operation uses strongly consistent reads; otherwise, eventually consistent reads are used.

giExpressionAttributeNames :: Lens' GetItem (HashMap Text Text) Source

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.

To create a placeholder for repeating occurrences of an attribute name in an expression.

To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:


The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:


You could then use this substitution in an expression, as in this example:

'#P = :val'

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Using Placeholdersfor Attribute Names and Values in the Amazon DynamoDB Developer Guide.

giKey :: Lens' GetItem (HashMap Text AttributeValue) Source

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

For the primary key, you must provide all of the attributes. For example, with a hash type primary key, you only need to provide the hash attribute. For a hash-and-range type primary key, you must provide both the hash attribute and the range attribute.

giProjectionExpression :: Lens' GetItem (Maybe Text) Source

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

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.

For more information, see Accessing Item Attributes in the Amazon DynamoDBDeveloper Guide.

ProjectionExpression replaces the legacy AttributesToGet parameter.

giTableName :: Lens' GetItem Text Source

The name of the table containing the requested item.


Response constructor

getItemResponse :: GetItemResponse Source

GetItemResponse constructor.

The fields accessible through corresponding lenses are:

Response lenses

girItem :: Lens' GetItemResponse (HashMap Text AttributeValue) Source

A map of attribute names to AttributeValue objects, as specified by AttributesToGet.