Amazonka.DynamoDB.Types.ConditionCheck

Documentation

data ConditionCheck

Represents a request to perform a check that an item exists or to check the condition of specific attributes of the item.

See: newConditionCheck smart constructor.

Constructors

ConditionCheck'

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 ConditionCheck condition fails. For ReturnValuesOnConditionCheckFailure, the valid values are: NONE and ALL_OLD.

• key :: HashMap Text AttributeValue

  The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

• tableName :: Text

  Name of the table for the check item request.

• conditionExpression :: Text

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

Instances

ToJSON ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

toJSON :: ConditionCheck -> Value

toEncoding :: ConditionCheck -> Encoding

toJSONList :: [ConditionCheck] -> Value

toEncodingList :: [ConditionCheck] -> Encoding

Generic ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Associated Types

type Rep ConditionCheck :: Type -> Type

Methods

from :: ConditionCheck -> Rep ConditionCheck x

to :: Rep ConditionCheck x -> ConditionCheck

Read ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

readsPrec :: Int -> ReadS ConditionCheck

readList :: ReadS [ConditionCheck]

readPrec :: ReadPrec ConditionCheck

readListPrec :: ReadPrec [ConditionCheck]

Show ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

showsPrec :: Int -> ConditionCheck -> ShowS

show :: ConditionCheck -> String

showList :: [ConditionCheck] -> ShowS

NFData ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

rnf :: ConditionCheck -> ()

Eq ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

(==) :: ConditionCheck -> ConditionCheck -> Bool

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

Hashable ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

hashWithSalt :: Int -> ConditionCheck -> Int

hash :: ConditionCheck -> Int

type Rep ConditionCheck

Defined in Amazonka.DynamoDB.Types.ConditionCheck

type Rep ConditionCheck = D1 ('MetaData "ConditionCheck" "Amazonka.DynamoDB.Types.ConditionCheck" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "ConditionCheck'" '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 "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text AttributeValue)) :*: (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "conditionExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newConditionCheck

Arguments

:: Text

$sel:tableName:ConditionCheck'

-> Text

$sel:conditionExpression:ConditionCheck'

-> ConditionCheck

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

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

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

$sel:key:ConditionCheck', conditionCheck_key - The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

$sel:tableName:ConditionCheck', conditionCheck_tableName - Name of the table for the check item request.

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

conditionCheck_expressionAttributeNames :: Lens' ConditionCheck (Maybe (HashMap Text Text))

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

conditionCheck_expressionAttributeValues :: Lens' ConditionCheck (Maybe (HashMap Text AttributeValue))

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

conditionCheck_returnValuesOnConditionCheckFailure :: Lens' ConditionCheck (Maybe ReturnValuesOnConditionCheckFailure)

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

conditionCheck_key :: Lens' ConditionCheck (HashMap Text AttributeValue)

The primary key of the item to be checked. Each element consists of an attribute name and a value for that attribute.

conditionCheck_tableName :: Lens' ConditionCheck Text

Name of the table for the check item request.

conditionCheck_conditionExpression :: Lens' ConditionCheck Text

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