File: get_item.rb

package info (click to toggle)
ruby-fog-aws 3.3.0-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 7,816 kB
  • sloc: ruby: 68,587; makefile: 6
file content (43 lines) | stat: -rw-r--r-- 1,378 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
module Fog
  module AWS
    class DynamoDB
      class Real
        # Get DynamoDB item
        #
        # ==== Parameters
        # * 'table_name'<~String> - name of table for item
        # * 'key'<~Hash>:
        #     {
        #       "ForumName": {
        #         "S": "Amazon DynamoDB"
        #       }
        #     }
        # * 'options'<~Hash>:
        #   * 'AttributesToGet'<~Array>: list of array names to return, defaults to returning all
        #   * 'ConsistentRead'<~Boolean>: whether to wait for updates, defaults to false
        #
        # ==== Returns
        # * response<~Excon::Response>:
        #   * body<~Hash>:
        #     * 'ConsumedCapacityUnits'<~Float> - Capacity units used in read
        #     * 'Item':<~Hash>:
        #       * 'AttributeName'<~Hash>: in form of {"type":value}
        #
        # See DynamoDB Documentation: http://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_GetItem.html
        #
        def get_item(table_name, key, options = {})
          body = {
            'Key'               => key,
            'TableName'         => table_name
          }.merge(options)

          request(
            :body       => Fog::JSON.encode(body),
            :headers    => {'x-amz-target' => 'DynamoDB_20120810.GetItem'},
            :idempotent => true
          )
        end
      end
    end
  end
end