libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DynamoDB.Types.ConditionCheck

Description

 
Synopsis

Documentation

data ConditionCheck Source #

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

Instances

Instances details
Eq ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Read ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Show ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Generic ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Associated Types

type Rep ConditionCheck :: Type -> Type #

NFData ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

Methods

rnf :: ConditionCheck -> () #

Hashable ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

ToJSON ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

type Rep ConditionCheck Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.ConditionCheck

type Rep ConditionCheck = D1 ('MetaData "ConditionCheck" "Amazonka.DynamoDB.Types.ConditionCheck" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" '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 Source #

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)) Source #

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

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

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

conditionCheck_returnValuesOnConditionCheckFailure :: Lens' ConditionCheck (Maybe ReturnValuesOnConditionCheckFailure) Source #

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) Source #

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 Source #

Name of the table for the check item request.

conditionCheck_conditionExpression :: Lens' ConditionCheck Text Source #

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