| 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.Update
Description
Synopsis
- data Update = Update' {
- expressionAttributeNames :: Maybe (HashMap Text Text)
- expressionAttributeValues :: Maybe (HashMap Text AttributeValue)
- returnValuesOnConditionCheckFailure :: Maybe ReturnValuesOnConditionCheckFailure
- conditionExpression :: Maybe Text
- key :: HashMap Text AttributeValue
- updateExpression :: Text
- tableName :: Text
- newUpdate :: Text -> Text -> Update
- update_expressionAttributeNames :: Lens' Update (Maybe (HashMap Text Text))
- update_expressionAttributeValues :: Lens' Update (Maybe (HashMap Text AttributeValue))
- update_returnValuesOnConditionCheckFailure :: Lens' Update (Maybe ReturnValuesOnConditionCheckFailure)
- update_conditionExpression :: Lens' Update (Maybe Text)
- update_key :: Lens' Update (HashMap Text AttributeValue)
- update_updateExpression :: Lens' Update Text
- update_tableName :: Lens' Update Text
Documentation
Represents a request to perform an UpdateItem operation.
See: newUpdate smart constructor.
Constructors
| Update' | |
Fields
| |
Instances
Create a value of Update 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:Update', update_expressionAttributeNames - One or more substitution tokens for attribute names in an expression.
$sel:expressionAttributeValues:Update', update_expressionAttributeValues - One or more values that can be substituted in an expression.
$sel:returnValuesOnConditionCheckFailure:Update', update_returnValuesOnConditionCheckFailure - Use ReturnValuesOnConditionCheckFailure to get the item attributes if
the Update condition fails. For ReturnValuesOnConditionCheckFailure,
the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
$sel:conditionExpression:Update', update_conditionExpression - A condition that must be satisfied in order for a conditional update to
succeed.
$sel:key:Update', update_key - The primary key of the item to be updated. Each element consists of an
attribute name and a value for that attribute.
$sel:updateExpression:Update', update_updateExpression - An expression that defines one or more attributes to be updated, the
action to be performed on them, and new value(s) for them.
$sel:tableName:Update', update_tableName - Name of the table for the UpdateItem request.
update_expressionAttributeNames :: Lens' Update (Maybe (HashMap Text Text)) Source #
One or more substitution tokens for attribute names in an expression.
update_expressionAttributeValues :: Lens' Update (Maybe (HashMap Text AttributeValue)) Source #
One or more values that can be substituted in an expression.
update_returnValuesOnConditionCheckFailure :: Lens' Update (Maybe ReturnValuesOnConditionCheckFailure) Source #
Use ReturnValuesOnConditionCheckFailure to get the item attributes if
the Update condition fails. For ReturnValuesOnConditionCheckFailure,
the valid values are: NONE, ALL_OLD, UPDATED_OLD, ALL_NEW, UPDATED_NEW.
update_conditionExpression :: Lens' Update (Maybe Text) Source #
A condition that must be satisfied in order for a conditional update to succeed.
update_key :: Lens' Update (HashMap Text AttributeValue) Source #
The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.