Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.Types.Get

Description

Synopsis

data Get = Get' {
- projectionExpression :: Maybe Text
- expressionAttributeNames :: Maybe (HashMap Text Text)
- key :: HashMap Text AttributeValue
- tableName :: Text
}
newGet :: Text -> Get
get_projectionExpression :: Lens' Get (Maybe Text)
get_expressionAttributeNames :: Lens' Get (Maybe (HashMap Text Text))
get_key :: Lens' Get (HashMap Text AttributeValue)
get_tableName :: Lens' Get Text

Documentation

data Get Source #

Specifies an item and related attribute values to retrieve in a TransactGetItem object.

See: newGet smart constructor.

Constructors

Get'

Fields

projectionExpression :: Maybe Text
A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.
expressionAttributeNames :: Maybe (HashMap Text Text)
One or more substitution tokens for attribute names in the ProjectionExpression parameter.
key :: HashMap Text AttributeValue
A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.
tableName :: Text
The name of the table from which to retrieve the specified item.

Instances

Instances details

Eq Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Methods (==) :: Get -> Get -> Bool # (/=) :: Get -> Get -> Bool #
Read Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Methods readsPrec :: Int -> ReadS Get # readList :: ReadS [Get] # readPrec :: ReadPrec Get # readListPrec :: ReadPrec [Get] #
Show Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Methods showsPrec :: Int -> Get -> ShowS # show :: Get -> String # showList :: [Get] -> ShowS #
Generic Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Associated Types type Rep Get :: Type -> Type # Methods from :: Get -> Rep Get x # to :: Rep Get x -> Get #
NFData Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Methods rnf :: Get -> () #
Hashable Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Methods hashWithSalt :: Int -> Get -> Int # hash :: Get -> Int #
ToJSON Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get Methods toJSON :: Get -> Value # toEncoding :: Get -> Encoding # toJSONList :: [Get] -> Value # toEncodingList :: [Get] -> Encoding #
type Rep Get Source #
Instance details Defined in Amazonka.DynamoDB.Types.Get type Rep Get = D1 ('MetaData "Get" "Amazonka.DynamoDB.Types.Get" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "Get'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expressionAttributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text AttributeValue)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGet Source #

Arguments

:: Text	`$sel:tableName:Get'`
-> Get

Create a value of Get with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:projectionExpression:Get', get_projectionExpression - A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

$sel:expressionAttributeNames:Get', get_expressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter.

$sel:key:Get', get_key - A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

$sel:tableName:Get', get_tableName - The name of the table from which to retrieve the specified item.

get_projectionExpression :: Lens' Get (Maybe Text) Source #

A string that identifies one or more attributes of the specified item to retrieve from the table. The attributes in the expression must be separated by commas. If no attribute names are specified, then all attributes of the specified item are returned. If any of the requested attributes are not found, they do not appear in the result.

get_expressionAttributeNames :: Lens' Get (Maybe (HashMap Text Text)) Source #

One or more substitution tokens for attribute names in the ProjectionExpression parameter.

get_key :: Lens' Get (HashMap Text AttributeValue) Source #

A map of attribute names to AttributeValue objects that specifies the primary key of the item to retrieve.

get_tableName :: Lens' Get Text Source #

The name of the table from which to retrieve the specified item.