Sha256: 24d5d80645a21aa761852afa17061330c2773a2e8fdc8815fc619281adba5c22

Contents?: true

Size: 1.67 KB

Versions: 36

Compression:

Stored size: 1.67 KB

Contents

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

Version data entries

36 entries across 36 versions & 5 rubygems

Version Path
fog-aws-0.0.5 lib/fog/aws/requests/dynamodb/delete_item.rb
fog-1.26.0 lib/fog/aws/requests/dynamodb/delete_item.rb
fog-1.25.0 lib/fog/aws/requests/dynamodb/delete_item.rb
nsidc-fog-1.24.1 lib/fog/aws/requests/dynamodb/delete_item.rb
fog-1.24.0 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.11 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.10 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.9 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.8 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.7 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.6 lib/fog/aws/requests/dynamodb/delete_item.rb
fog-1.23.0 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.4 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.3 lib/fog/aws/requests/dynamodb/delete_item.rb
ns-fog-1.22.2 lib/fog/aws/requests/dynamodb/delete_item.rb
fog-1.22.1 lib/fog/aws/requests/dynamodb/delete_item.rb