mirror of
https://github.com/fog/fog-aws.git
synced 2022-11-09 13:50:52 -05:00
44 lines
1.7 KiB
Ruby
44 lines
1.7 KiB
Ruby
|
module Fog
|
||
|
|
module AWS
|
||
|
|
class DynamoDB
|
||
|
|
class Real
|
||
|
|
# Delete DynamoDB item
|
||
|
|
#
|
||
|
|
# ==== Parameters
|
||
|
|
# * 'table_name'<~String> - name of table for item
|
||
|
|
# * 'key'<~Hash>:
|
||
|
|
# * 'HashKeyElement'<~Hash>: info for primary key
|
||
|
|
# * 'AttributeName'<~String> - name of attribute
|
||
|
|
# * 'AttributeType'<~String> - type of attribute
|
||
|
|
# * 'RangeKeyElement'<~Hash>: optional, info for range key
|
||
|
|
# * 'AttributeName'<~String> - name of attribute
|
||
|
|
# * 'AttributeType'<~String> - type of attribute
|
||
|
|
# * 'options'<~Hash>:
|
||
|
|
# * 'Expected'<~Hash>: data to check against
|
||
|
|
# * 'AttributeName'<~String> - name of attribute
|
||
|
|
# * 'Value'<~Hash> - a value to check for the value of
|
||
|
|
# or
|
||
|
|
# * 'Exists'<~Boolean> - set as false to only allow update if attribute doesn't exist
|
||
|
|
# * 'ReturnValues'<~String> - data to return in %w{ALL_NEW ALL_OLD NONE UPDATED_NEW UPDATED_OLD}, defaults to NONE
|
||
|
|
#
|
||
|
|
# ==== Returns
|
||
|
|
# * response<~Excon::Response>:
|
||
|
|
# * body<~Hash>:
|
||
|
|
# varies based on ReturnValues param, see: http://docs.amazonwebservices.com/amazondynamodb/latest/developerguide/API_UpdateItem.html
|
||
|
|
def delete_item(table_name, key, options = {})
|
||
|
|
body = {
|
||
|
|
'Key' => key,
|
||
|
|
'TableName' => table_name
|
||
|
|
}.merge(options)
|
||
|
|
|
||
|
|
request(
|
||
|
|
:body => Fog::JSON.encode(body),
|
||
|
|
:headers => {'x-amz-target' => 'DynamoDB_20111205.DeleteItem'},
|
||
|
|
:idempotent => true
|
||
|
|
)
|
||
|
|
end
|
||
|
|
end
|
||
|
|
end
|
||
|
|
end
|
||
|
|
end
|