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

Description

Documentation

data Delete Source #

Represents a request to perform a DeleteItem operation.

See: newDelete smart constructor.

Constructors

Delete'

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 Delete 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 delete to succeed.
key :: HashMap Text AttributeValue
The primary key of the item to be deleted. Each element consists of an attribute name and a value for that attribute.
tableName :: Text
Name of the table in which the item to be deleted resides.

Instances

Instances details

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

newDelete Source #

Arguments

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

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

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

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

$sel:conditionExpression:Delete', delete_conditionExpression - A condition that must be satisfied in order for a conditional delete to succeed.

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

$sel:tableName:Delete', delete_tableName - Name of the table in which the item to be deleted resides.

delete_expressionAttributeNames :: Lens' Delete (Maybe (HashMap Text Text)) Source #

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

delete_expressionAttributeValues :: Lens' Delete (Maybe (HashMap Text AttributeValue)) Source #

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

delete_returnValuesOnConditionCheckFailure :: Lens' Delete (Maybe ReturnValuesOnConditionCheckFailure) Source #

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

delete_conditionExpression :: Lens' Delete (Maybe Text) Source #

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

delete_key :: Lens' Delete (HashMap Text AttributeValue) Source #

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

delete_tableName :: Lens' Delete Text Source #

Name of the table in which the item to be deleted resides.