Amazonka.DynamoDB.Types.Get

Documentation

data Get

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

See: newGet smart constructor.

Constructors

Get'

Fields

• expressionAttributeNames :: Maybe (HashMap Text Text)

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

• 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.

• 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

ToJSON Get

Defined in Amazonka.DynamoDB.Types.Get

Methods

toJSON :: Get -> Value

toEncoding :: Get -> Encoding

toJSONList :: [Get] -> Value

toEncodingList :: [Get] -> Encoding

Generic Get

Defined in Amazonka.DynamoDB.Types.Get

Associated Types

type Rep Get :: Type -> Type

Methods

from :: Get -> Rep Get x

to :: Rep Get x -> Get

Read Get

Defined in Amazonka.DynamoDB.Types.Get

Methods

readsPrec :: Int -> ReadS Get

readList :: ReadS [Get]

readPrec :: ReadPrec Get

readListPrec :: ReadPrec [Get]

Show Get

Defined in Amazonka.DynamoDB.Types.Get

Methods

showsPrec :: Int -> Get -> ShowS

show :: Get -> String

showList :: [Get] -> ShowS

NFData Get

Defined in Amazonka.DynamoDB.Types.Get

Methods

rnf :: Get -> ()

Eq Get

Defined in Amazonka.DynamoDB.Types.Get

Methods

(==) :: Get -> Get -> Bool

(/=) :: Get -> Get -> Bool

Hashable Get

Defined in Amazonka.DynamoDB.Types.Get

Methods

hashWithSalt :: Int -> Get -> Int

hash :: Get -> Int

type Rep Get

Defined in Amazonka.DynamoDB.Types.Get

type Rep Get = D1 ('MetaData "Get" "Amazonka.DynamoDB.Types.Get" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "Get'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "expressionAttributeNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "projectionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text AttributeValue)) :*: S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGet

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:expressionAttributeNames:Get', get_expressionAttributeNames - One or more substitution tokens for attribute names in the ProjectionExpression parameter.

$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: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_expressionAttributeNames :: Lens' Get (Maybe (HashMap Text Text))

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

get_projectionExpression :: Lens' Get (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.

get_key :: Lens' Get (HashMap Text AttributeValue)

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

get_tableName :: Lens' Get Text

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