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

Description

Documentation

data Put Source #

Represents a request to perform a PutItem operation.

See: newPut smart constructor.

Constructors

Put'

Fields

expressionAttributeNames :: Maybe (HashMap Text Text)
One or more substitution tokens for attribute names in an expression.
expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
One or more values that can be substituted in an expression.
returnValuesOnConditionCheckFailure :: Maybe ReturnValuesOnConditionCheckFailure
Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.
conditionExpression :: Maybe Text
A condition that must be satisfied in order for a conditional update to succeed.
item :: HashMap Text AttributeValue
A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.
tableName :: Text
Name of the table in which to write the item.

Instances

Instances details

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

newPut Source #

Arguments

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

Create a value of Put 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:Put', put_expressionAttributeNames - One or more substitution tokens for attribute names in an expression.

$sel:expressionAttributeValues:Put', put_expressionAttributeValues - One or more values that can be substituted in an expression.

$sel:returnValuesOnConditionCheckFailure:Put', put_returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

$sel:conditionExpression:Put', put_conditionExpression - A condition that must be satisfied in order for a conditional update to succeed.

$sel:item:Put', put_item - A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

$sel:tableName:Put', put_tableName - Name of the table in which to write the item.

put_expressionAttributeNames :: Lens' Put (Maybe (HashMap Text Text)) Source #

One or more substitution tokens for attribute names in an expression.

put_expressionAttributeValues :: Lens' Put (Maybe (HashMap Text AttributeValue)) Source #

One or more values that can be substituted in an expression.

put_returnValuesOnConditionCheckFailure :: Lens' Put (Maybe ReturnValuesOnConditionCheckFailure) Source #

Use ReturnValuesOnConditionCheckFailure to get the item attributes if the Put condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

put_conditionExpression :: Lens' Put (Maybe Text) Source #

A condition that must be satisfied in order for a conditional update to succeed.

put_item :: Lens' Put (HashMap Text AttributeValue) Source #

A map of attribute name to attribute values, representing the primary key of the item to be written by PutItem. All of the table's primary key attributes must be specified, and their data types must match those of the table's key schema. If any attributes are present in the item that are part of an index key schema for the table, their types must match the index key schema.

put_tableName :: Lens' Put Text Source #

Name of the table in which to write the item.