Aws.DynamoDb.Commands.UpdateItem

aws-0.16: Amazon Web Services (AWS) for Haskell

Copyright | Soostone Inc
License | BSD3
Maintainer | Ozgun Ataman <ozgun.ataman@soostone.com>
Stability | experimental
Safe Haskell | None
Language | Haskell2010

Aws.DynamoDb.Commands.UpdateItem

Description

Synopsis

- data UpdateItem = UpdateItem {
  - uiTable :: Text
  - uiKey :: PrimaryKey
  - uiUpdates :: [AttributeUpdate]
  - uiExpect :: Conditions
  - uiReturn :: UpdateReturn
  - uiRetCons :: ReturnConsumption
  - uiRetMet :: ReturnItemCollectionMetrics
  }
- updateItem :: Text -> PrimaryKey -> [AttributeUpdate] -> UpdateItem
- data AttributeUpdate = AttributeUpdate {
  - auAttr :: Attribute
  - auAction :: UpdateAction
  }
- au :: Attribute -> AttributeUpdate
- data UpdateAction
  - = UPut
  - | UAdd
  - | UDelete
- data UpdateItemResponse = UpdateItemResponse {
  - uirAttrs :: Maybe Item
  - uirConsumed :: Maybe ConsumedCapacity
  }

# Documentation

data UpdateItem #

An `UpdateItem` request.

Constructors

UpdateItem |
Fields uiTable :: Text uiKey :: PrimaryKey uiUpdates :: [AttributeUpdate] uiExpect :: Conditions Conditional update - see DynamoDb documentation uiReturn :: UpdateReturn uiRetCons :: ReturnConsumption uiRetMet :: ReturnItemCollectionMetrics

Instances

Eq UpdateItem # |
Methods (==) :: UpdateItem -> UpdateItem -> Bool # (/=) :: UpdateItem -> UpdateItem -> Bool #
Ord UpdateItem # |
Methods compare :: UpdateItem -> UpdateItem -> Ordering # (<) :: UpdateItem -> UpdateItem -> Bool # (<=) :: UpdateItem -> UpdateItem -> Bool # (>) :: UpdateItem -> UpdateItem -> Bool # (>=) :: UpdateItem -> UpdateItem -> Bool # max :: UpdateItem -> UpdateItem -> UpdateItem # min :: UpdateItem -> UpdateItem -> UpdateItem #
Read UpdateItem # |
Methods readsPrec :: Int -> ReadS UpdateItem # readList :: ReadS [UpdateItem] # readPrec :: ReadPrec UpdateItem # readListPrec :: ReadPrec [UpdateItem] #
Show UpdateItem # |
Methods showsPrec :: Int -> UpdateItem -> ShowS # show :: UpdateItem -> String # showList :: [UpdateItem] -> ShowS #
ToJSON UpdateItem # |
Methods toJSON :: UpdateItem -> Value # toEncoding :: UpdateItem -> Encoding # toJSONList :: [UpdateItem] -> Value # toEncodingList :: [UpdateItem] -> Encoding #
SignQuery UpdateItem # |
Associated Types type ServiceConfiguration UpdateItem :: * -> * # Methods signQuery :: UpdateItem -> ServiceConfiguration UpdateItem queryType -> SignatureData -> SignedQuery #
Transaction UpdateItem UpdateItemResponse # |
type ServiceConfiguration UpdateItem # |
type ServiceConfiguration UpdateItem = DdbConfiguration

updateItem #

Arguments

:: Text | Table name
-> PrimaryKey | Primary key for item
-> [AttributeUpdate] | Updates for this item
-> UpdateItem |

Construct a minimal `UpdateItem` request.

data AttributeUpdate #

Constructors

AttributeUpdate |
Fields auAttr :: Attribute Attribute key-value auAction :: UpdateAction Type of update operation.

Instances

Eq AttributeUpdate # |
Methods (==) :: AttributeUpdate -> AttributeUpdate -> Bool # (/=) :: AttributeUpdate -> AttributeUpdate -> Bool #
Ord AttributeUpdate # |
Methods compare :: AttributeUpdate -> AttributeUpdate -> Ordering # (<) :: AttributeUpdate -> AttributeUpdate -> Bool # (<=) :: AttributeUpdate -> AttributeUpdate -> Bool # (>) :: AttributeUpdate -> AttributeUpdate -> Bool # (>=) :: AttributeUpdate -> AttributeUpdate -> Bool # max :: AttributeUpdate -> AttributeUpdate -> AttributeUpdate # min :: AttributeUpdate -> AttributeUpdate -> AttributeUpdate #
Read AttributeUpdate # |
Methods readsPrec :: Int -> ReadS AttributeUpdate # readList :: ReadS [AttributeUpdate] # readPrec :: ReadPrec AttributeUpdate # readListPrec :: ReadPrec [AttributeUpdate] #
Show AttributeUpdate # |
Methods showsPrec :: Int -> AttributeUpdate -> ShowS # show :: AttributeUpdate -> String # showList :: [AttributeUpdate] -> ShowS #
DynSize AttributeUpdate # |
Methods dynSize :: AttributeUpdate -> Int #

au :: Attribute -> AttributeUpdate #

Shorthand for the `AttributeUpdate` constructor. Defaults to PUT for the update action.

data UpdateAction #

Type of attribute update to perform.

See AWS docs at:

    http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_UpdateItem.html

Constructors

UPut | Simpley write, overwriting any previous value
UAdd | Numerical add or add to set.
UDelete | Empty value: remove; Set value: Subtract from set.

Instances

Eq UpdateAction # |
Methods (==) :: UpdateAction -> UpdateAction -> Bool # (/=) :: UpdateAction -> UpdateAction -> Bool #
Ord UpdateAction # |
Methods compare :: UpdateAction -> UpdateAction -> Ordering # (<) :: UpdateAction -> UpdateAction -> Bool # (<=) :: UpdateAction -> UpdateAction -> Bool # (>) :: UpdateAction -> UpdateAction -> Bool # (>=) :: UpdateAction -> UpdateAction -> Bool # max :: UpdateAction -> UpdateAction -> UpdateAction # min :: UpdateAction -> UpdateAction -> UpdateAction #
Read UpdateAction # |
Methods readsPrec :: Int -> ReadS UpdateAction # readList :: ReadS [UpdateAction] # readPrec :: ReadPrec UpdateAction # readListPrec :: ReadPrec [UpdateAction] #
Show UpdateAction # |
Methods showsPrec :: Int -> UpdateAction -> ShowS # show :: UpdateAction -> String # showList :: [UpdateAction] -> ShowS #
ToJSON UpdateAction # |
Methods toJSON :: UpdateAction -> Value # toEncoding :: UpdateAction -> Encoding # toJSONList :: [UpdateAction] -> Value # toEncodingList :: [UpdateAction] -> Encoding #
Default UpdateAction # |
Methods def :: UpdateAction #

data UpdateItemResponse #

Constructors

UpdateItemResponse |
Fields uirAttrs :: Maybe Item Old attributes, if requested uirConsumed :: Maybe ConsumedCapacity Amount of capacity consumed

Instances

Eq UpdateItemResponse # |
Methods (==) :: UpdateItemResponse -> UpdateItemResponse -> Bool # (/=) :: UpdateItemResponse -> UpdateItemResponse -> Bool #
Ord UpdateItemResponse # |
Methods compare :: UpdateItemResponse -> UpdateItemResponse -> Ordering # (<) :: UpdateItemResponse -> UpdateItemResponse -> Bool # (<=) :: UpdateItemResponse -> UpdateItemResponse -> Bool # (>) :: UpdateItemResponse -> UpdateItemResponse -> Bool # (>=) :: UpdateItemResponse -> UpdateItemResponse -> Bool # max :: UpdateItemResponse -> UpdateItemResponse -> UpdateItemResponse # min :: UpdateItemResponse -> UpdateItemResponse -> UpdateItemResponse #
Read UpdateItemResponse # |
Methods readsPrec :: Int -> ReadS UpdateItemResponse # readList :: ReadS [UpdateItemResponse] # readPrec :: ReadPrec UpdateItemResponse # readListPrec :: ReadPrec [UpdateItemResponse] #
Show UpdateItemResponse # |
Methods showsPrec :: Int -> UpdateItemResponse -> ShowS # show :: UpdateItemResponse -> String # showList :: [UpdateItemResponse] -> ShowS #
FromJSON UpdateItemResponse # |
Methods parseJSON :: Value -> Parser UpdateItemResponse # parseJSONList :: Value -> Parser [UpdateItemResponse] #
AsMemoryResponse UpdateItemResponse # |
Associated Types type MemoryResponse UpdateItemResponse :: * # Methods loadToMemory :: UpdateItemResponse -> ResourceT IO (MemoryResponse UpdateItemResponse) #
Transaction UpdateItem UpdateItemResponse # |
ResponseConsumer r UpdateItemResponse # |
Associated Types type ResponseMetadata UpdateItemResponse :: * # Methods responseConsumer :: Request -> r -> IORef (ResponseMetadata UpdateItemResponse) -> HTTPResponseConsumer UpdateItemResponse #
type MemoryResponse UpdateItemResponse # |
type MemoryResponse UpdateItemResponse = UpdateItemResponse
type ResponseMetadata UpdateItemResponse # |
type ResponseMetadata UpdateItemResponse = DdbResponse