aws-sdk 1.8.5 → 1.9.0

data/lib/aws/dynamo_db/config.rb

@@ -13,7 +13,7 @@
 
 AWS::Core::Configuration.module_eval do
 
-  add_service 'DynamoDB', 'dynamo_db', 'dynamodb.us-east-1.amazonaws.com'
+  add_service 'DynamoDB', 'dynamo_db', 'dynamodb.%s.amazonaws.com'
 
   add_option :dynamo_db_retry_throughput_errors, true, :boolean => true
 

data/lib/aws/dynamo_db/item.rb

@@ -18,16 +18,16 @@ module AWS
     # complex primary key (according to the table schema) and consists
     # of a collection of attributes.  Attributes are name/value pairs
     # where the value may be a string, number, string set, or number
-    # set.  
+    # set.
     #
     # Getting an item by hash key value:
     #
-    #   item = table.items['hash-key-value'] 
+    #     item = table.items['hash-key-value']
     #
     # Getting an item from a table with both hash and range keys:
     #
-    #   item = table.items['hash-key','range-key']
-    # 
+    #     item = table.items['hash-key','range-key']
+    #
     class Item < Core::Resource
 
       extend Types
@@ -41,7 +41,7 @@ module AWS
       attr_reader :hash_value
 
       # @return [String, Numeric, nil] The range key value of the
-      #   item, or +nil+ if the table has a simple primary key.
+      #   item, or `nil` if the table has a simple primary key.
       attr_reader :range_value
 
       # @private
@@ -60,17 +60,17 @@ module AWS
       #   The operation will fail unless the item exists and has the
       #   attributes in the value for this option.  For example:
       #
-      #     # throws DynamoDB::Errors::ConditionalCheckFailedException
-      #     # unless the item has "color" set to "red"
-      #     item.delete(:if => { :color => "red" })
+      #       # throws DynamoDB::Errors::ConditionalCheckFailedException
+      #       # unless the item has "color" set to "red"
+      #       item.delete(:if => { :color => "red" })
       #
       # @option options [String, Symbol, Array] :unless_exists A name
       #   or collection of attribute names; if the item has a value
       #   for any of these attributes, this method will raise
-      #   +DynamoDB::Errors::ConditionalCheckFailedException+.  For
+      #   `DynamoDB::Errors::ConditionalCheckFailedException`.  For
       #   example:
       #
-      #     item.delete(:unless_exists => "version")
+      #       item.delete(:unless_exists => "version")
       def delete(options = {})
         client_opts = item_key_options(self)
 

data/lib/aws/dynamo_db/item_collection.rb

@@ -22,31 +22,31 @@ module AWS
     # * Get an {Item}
     # * Enumerate {Item} or {ItemData} objects
     #
-    # == Creating an Item
+    # ## Creating an Item
     #
     # To create an item, just call {#create} with a hash of attributes.
     #
-    #   table = dynamo_db.tables['my-table']
-    #   table.hash_key = [:id, :string]
+    #     table = dynamo_db.tables['my-table']
+    #     table.hash_key = [:id, :string]
     #
-    #   table.items.create('id' => 'abc', 'count' => 5, 'colors' => %w(red blue))
+    #     table.items.create('id' => 'abc', 'count' => 5, 'colors' => %w(red blue))
     #
     # Attribute names can be symbols/strings and values can be strings or
     # numbers or arrays/sets of strings/numbers.  The attributes must contain
     # the hash key name/value for the item and the value must be of the
     # correct type (e.g. string or number).
     #
-    # == Getting an Item
+    # ## Getting an Item
     #
     # To get an item, you provide the hash key
     #
-    #   # gets a reference to the item, no request is made
-    #   item = table.items['hash-key-value']
+    #     # gets a reference to the item, no request is made
+    #     item = table.items['hash-key-value']
     #
     # You call methods against the item returned to get, add, update or delete
     # attributes.  See {Item} for more information.
     #
-    # == Enumerating Items
+    # ## Enumerating Items
     #
     # You can enumerate items 2 ways:
     #
@@ -61,26 +61,26 @@ module AWS
     #
     # To enumerate {Item} objects just call each on the item collection.
     #
-    #   table.items.each do |item|
-    #     puts item.hash_value
-    #   end
+    #     table.items.each do |item|
+    #       puts item.hash_value
+    #     end
     #
     # To enumerate {ItemData} objects you need to specify what attributes
     # you are interested in.  This will cause #each to yield {ItemData}
     # objects.  Call {ItemData#attributes} to get the hash of attribute
     # names/values.
     #
-    #   table.items.select('id', 'category').each do |item_data|
-    #     item_data.attributes #=> { 'id' => 'abc', 'category' => 'foo' }
-    #   end
+    #     table.items.select('id', 'category').each do |item_data|
+    #       item_data.attributes #=> { 'id' => 'abc', 'category' => 'foo' }
+    #     end
     #
     # If you want item data objects with all attributes just call select
     # without a list of attributes (#select still accepts options).
     #
-    #   # request a maximum of 10 items from Amazon DynamoDB
-    #   table.items.select(:limit => 10).each do |item_data|
-    #     item_data.attributes #=> { 'id' => 'abc', 'category' => 'foo', ... }
-    #   end
+    #     # request a maximum of 10 items from Amazon DynamoDB
+    #     table.items.select(:limit => 10).each do |item_data|
+    #       item_data.attributes #=> { 'id' => 'abc', 'category' => 'foo', ... }
+    #     end
     #
     # Please note that enumerating objects is done via the scan operation.
     # Refer to the Amazon DynamoDB documentation for more information
@@ -114,7 +114,7 @@ module AWS
       # primary key doesn't exist), or replace an existing item if it
       # has certain attribute values.
       #
-      #   items.put(:id => "abc123", :colors => ["red", "white"])
+      #     items.put(:id => "abc123", :colors => ["red", "white"])
       #
       # @param [Hash] attributes The attributes to store with the
       #   item.  These must include the primary key attributes for the
@@ -122,10 +122,10 @@ module AWS
       #   Attribute names may be symbols or UTF-8 strings, and
       #   attribute values may be any of these types:
       #
-      #   * String
-      #   * Array<String> or Set<String>
-      #   * Numeric
-      #   * Array<Numeric> or Set<Numeric>
+      #     * String
+      #     * Array<String> or Set<String>
+      #     * Numeric
+      #     * Array<Numeric> or Set<Numeric>
       #
       #   Empty sets, arrays, and strings are invalid.
       #
@@ -136,33 +136,33 @@ module AWS
       #   operation will fail unless the item exists and has the
       #   attributes in the value for this option.  For example:
       #
-      #     # throws DynamoDB::Errors::ConditionalCheckFailedException
-      #     # unless the item has "color" set to "red"
-      #     items.put(
-      #       { :foo => "Bar" },
-      #       :if => { :color => "red" }
-      #     )
+      #       # throws DynamoDB::Errors::ConditionalCheckFailedException
+      #       # unless the item has "color" set to "red"
+      #       items.put(
+      #         { :foo => "Bar" },
+      #         :if => { :color => "red" }
+      #       )
       #
       # @option options [String, Symbol, Array] :unless_exists A name
       #   or collection of attribute names; if the item already exists
       #   and has a value for any of these attributes, this method
       #   will raise
-      #   +DynamoDB::Errors::ConditionalCheckFailedException+.  For example:
+      #   `DynamoDB::Errors::ConditionalCheckFailedException`.  For example:
       #
-      #     items.put({ :id => "abc123" }, :unless_exists => "id")
+      #       items.put({ :id => "abc123" }, :unless_exists => "id")
       #
-      # @option options [Symbol] :return If set to +:all_old+, this
+      # @option options [Symbol] :return If set to `:all_old`, this
       #   method will return a hash containing the previous values of
       #   all attributes for the item that was overwritten.  If this
-      #   option is set to +:none+, or if it is set to +:all_old+ and
+      #   option is set to `:none`, or if it is set to `:all_old` and
       #   no item currently exists with the same primary key values,
-      #   the method will return +nil+.
+      #   the method will return `nil`.
       #
       # @return [Item] An object representing the item that was
       #   stored.  Note that the SDK retains only the item's primary
       #   key values in memory; if you access the attributes of the
       #   item using the returned object, the SDK will contact the
-      #   service to retrieve those attributes.  The +:return+ option
+      #   service to retrieve those attributes.  The `:return` option
       #   may be used to change the return value of this method.
       def create attributes, options = {}
         table.assert_schema!
@@ -200,8 +200,8 @@ module AWS
       # exception unless the table has a schema loaded or configured,
       # or if the table has a composite primary key.
       #
-      #   table.hash_key = [:id, :string]
-      #   item = table.items["abc123"]
+      #     table.hash_key = [:id, :string]
+      #     item = table.items["abc123"]
       #
       # @param [String, Numeric] hash_value The hash key value for the
       #   item.  The type of this parameter must match the type in the
@@ -225,9 +225,9 @@ module AWS
       # currently the SDK makes no attempt to validate the key
       # elements.
       #
-      #   table.hash_key = [:id, :string]
-      #   table.range_key = [:range, :number]
-      #   item = table.items.at("abc123", 12)
+      #     table.hash_key = [:id, :string]
+      #     table.range_key = [:range, :number]
+      #     item = table.items.at("abc123", 12)
       #
       # @param [String, Numeric] hash_value The hash key value for the
       #   item.
@@ -249,7 +249,7 @@ module AWS
 
       # Provides a convenient syntax for expressing scan filters.
       #
-      #   table.items.where(:path).begins_with("users/")
+      #     table.items.where(:path).begins_with("users/")
       #
       class FilterBuilder
 
@@ -423,7 +423,7 @@ module AWS
 
       # @overload where(attributes)
       #
-      #   table.items.where(:name => "Fred")
+      #       table.items.where(:name => "Fred")
       #
       #   @param [Hash] attributes The returned collection will be
       #     filtered such that each item contains the attributes and
@@ -434,7 +434,7 @@ module AWS
       #
       # @overload where(attribute_name)
       #
-      #   table.items.where(:name).equals("Fred")
+      #       table.items.where(:name).equals("Fred")
       #
       #   @return [FilterBuilder] An object that allows you to specify
       #     a filter on the provided attribute name.
@@ -505,16 +505,16 @@ module AWS
       # method allows you to specify which attributes to retrieve from
       # DynamoDB.
       #
-      #   # fetch all attributes for a collection of items
-      #   items.select { |data| p data.attributes }
+      #     # fetch all attributes for a collection of items
+      #     items.select { |data| p data.attributes }
       #
-      #   # fetch only the "color" attribute of each item
-      #   items.select(:color) { |data| p data.attributes["color"] }
+      #     # fetch only the "color" attribute of each item
+      #     items.select(:color) { |data| p data.attributes["color"] }
       #
-      #   # use client-side filtering to delete a subset of the items
-      #   items.select do |data|
-      #     data.item.delete if data.attributes.size % 2 == 0
-      #   end
+      #     # use client-side filtering to delete a subset of the items
+      #     items.select do |data|
+      #       data.item.delete if data.attributes.size % 2 == 0
+      #     end
       #
       # @overload select(*attributes, options = {})
       #
@@ -566,8 +566,8 @@ module AWS
       # count applies to the items that match all the filters on the
       # collection.  For example:
       #
-      #   # count the blue items
-      #   items.where(:color => "blue").count
+      #     # count the blue items
+      #     items.where(:color => "blue").count
       #
       # @param [Hash] options Options for counting the items.
       #
@@ -618,32 +618,32 @@ module AWS
       # of key conditions and does not have the added step of
       # filtering out results.
       #
-      #   # find all items with a given hash key value
-      #   items.query(:hash_value => "abc123")
+      #     # find all items with a given hash key value
+      #     items.query(:hash_value => "abc123")
       #
-      #   # get only the colors attribute of each item
-      #   items.query(
-      #     :hash_value => "abc123",
-      #     :select => [:colors])
+      #     # get only the colors attribute of each item
+      #     items.query(
+      #       :hash_value => "abc123",
+      #       :select => [:colors])
       #
-      #   # find only the items where the range key is between two values
-      #   items.query(
-      #     :hash_value => "abc123",
-      #     :range_value => 1..100
-      #   )
+      #     # find only the items where the range key is between two values
+      #     items.query(
+      #       :hash_value => "abc123",
+      #       :range_value => 1..100
+      #     )
       #
       # @note This method is only valid for tables with a composite
       #   primary key.
       #
-      # @param [Hash] options Options for the query.  +:hash_value+ is
+      # @param [Hash] options Options for the query.  `:hash_value` is
       #   required.  Only one of the following options may be set:
       #
-      #   * +:range_value+
-      #   * +:range_greater_than+
-      #   * +:range_less_than+
-      #   * +:range_gte+
-      #   * +:range_lte+
-      #   * +:range_begins_with+
+      #     * `:range_value`
+      #     * `:range_greater_than`
+      #     * `:range_less_than`
+      #     * `:range_gte`
+      #     * `:range_lte`
+      #     * `:range_begins_with`
       #
       # @option [Boolean] :scan_index_forward (true) Specifies which
       #   order records will be returned.  Defaults to returning them
@@ -653,11 +653,11 @@ module AWS
       #   objects without any attribute data.  If you want to select
       #   specific attributes, pass a list of them to :select.
       #
-      #      :select => [:id, :category, :size]
+      #       :select => [:id, :category, :size]
       #
-      #   If you want to select ALL attributes, pass the symbol +:all+
+      #   If you want to select ALL attributes, pass the symbol `:all`
       #
-      #      :select => :all
+      #       :select => :all
       #
       # @option options [String, Numeric] :hash_value Attribute value
       #   of the hash component of the composite primary key.
@@ -665,7 +665,7 @@ module AWS
       # @option options [Array<String, Symbol>, String, Symbol] :select
       #   Attribute name or names to retrieve.  When this option is
       #   set, the returned or yielded items will be instances of
-      #   {ItemData} instead of {Item}.  The special value +:all+
+      #   {ItemData} instead of {Item}.  The special value `:all`
       #   indicates that all attributes should be retrieved and
       #   returned in ItemData instances.
       #

data/lib/aws/dynamo_db/table.rb

@@ -16,7 +16,7 @@ module AWS
 
     # Represents a DynamoDB table.
     #
-    # == Working with Tables
+    # ## Working with Tables
     #
     # Dynamo DB allows you to organize data into tables.  Tables have a
     # unique name and a key schema.  A key schema is comprised of a
@@ -27,47 +27,47 @@ module AWS
     # by the scale of a single box. You can reserve the required throughput
     # by specifying a number of reads and writes per second to support.
     #
-    # == Creating a Table
+    # ## Creating a Table
     #
     # To get started you can create a table by supplying a name
     # and the read/write capacity.  A default schema with a hash_key
     # of :id => :string will be provided.
     #
-    #   dynamo_db = AWS::DynamoDB.new
-    #   dynamo_db.tables.create('mytable', 10, 5)
+    #     dynamo_db = AWS::DynamoDB.new
+    #     dynamo_db.tables.create('mytable', 10, 5)
     #
     # You can provide your own hash key and optional range key.
     #
-    #   dynamo_db.tables.create('comments', 10, 5,
-    #     :hash_key => { :blog_post_id => :number },
-    #     :range_key => { :comment_id => :number }
-    #   )
+    #     dynamo_db.tables.create('comments', 10, 5,
+    #       :hash_key => { :blog_post_id => :number },
+    #       :range_key => { :comment_id => :number }
+    #     )
     #
-    # == Provisioning Throughput
+    # ## Provisioning Throughput
     #
     # You must specify the desired read and write capacity when
     # creating a table.  After a table is created you can see what has
     # been provisioned.
     #
-    #   table.read_capacity_units #=> 10
-    #   table.write_capacity_units #=> 5
+    #     table.read_capacity_units #=> 10
+    #     table.write_capacity_units #=> 5
     #
     # To change these values, call {#provision_throughput}:
     #
-    #   table.provision_throughput :read_capacity_units => 100, :write_capacity_units => 100
+    #     table.provision_throughput :read_capacity_units => 100, :write_capacity_units => 100
     #
     # Please note that provisioned throughput can be decreased only once
     # within a 24 hour period.
     #
-    # == Table Status
+    # ## Table Status
     #
     # When you create or update a table the changes can take some time to
     # apply.  You can query the status of your table at any time:
     #
-    #   # creating a table can be a *very* slow operation
-    #   table = dynamo_db.tables.create('mytable')
-    #   sleep 1 while table.status == :creating
-    #   table.status #=> :active
+    #     # creating a table can be a *very* slow operation
+    #     table = dynamo_db.tables.create('mytable')
+    #     sleep 1 while table.status == :creating
+    #     table.status #=> :active
     #
     # @attr_reader [Time] created_at When the table was first creatd.
     #
@@ -156,7 +156,7 @@ module AWS
       # @option options [Integer] :write_capacity_units
       #
       # @return [Hash] Returns a hash with the current throughput
-      #   provisioning (+:read_capacity_units+ and +:write_capacity_units+).
+      #   provisioning (`:read_capacity_units` and `:write_capacity_units`).
       #
       def provision_throughput options = {}
 
@@ -236,9 +236,9 @@ module AWS
       # This is the preferred way to load the table schema so that it
       # can be used to work with DynamoDB items.
       #
-      #   # these are equivalent:
-      #   table.hash_key = [:id, :string]
-      #   table.hash_key = { :id => :string }
+      #     # these are equivalent:
+      #     table.hash_key = [:id, :string]
+      #     table.hash_key = { :id => :string }
       #
       # @note For tables with composite primary keys, you must call
       #   this method first followed by {#range_key=} to configure the
@@ -247,7 +247,7 @@ module AWS
       # @param description A description of the hash key element.  If
       #   this is a hash, it may contain a single mapping; the key is
       #   the name of the hash key attribute and the value is the type
-      #   (+:string+, +:number+ or +:binary+).  If it is an array, the first
+      #   (`:string`, `:number` or `:binary`).  If it is an array, the first
       #   element is the name and the second element is the type.
       #
       def hash_key= description
@@ -262,14 +262,14 @@ module AWS
       # be called after {#hash_key=} has been used to configure the
       # hash key element.
       #
-      #   # these are equivalent:
-      #   table.range_key = [:id, :string]
-      #   table.range_key = { :id => :string }
+      #     # these are equivalent:
+      #     table.range_key = [:id, :string]
+      #     table.range_key = { :id => :string }
       #
       # @param description A description of the range key element.  If
       #   this is a hash, it may contain a single mapping; the key is
       #   the name of the hash key attribute and the value is the type
-      #   (+:string+, +:number+ or +:binary+).  If it is an array, the first
+      #   (`:string`, `:number` or `:binary`).  If it is an array, the first
       #   element is the name and the second element is the type.
       #
       def range_key= description
@@ -282,7 +282,7 @@ module AWS
       end
 
       # Deletes a table and all of its items.  The table must be in an
-      # +:active+ state (see {#status}).
+      # `:active` state (see {#status}).
       #
       # @return [nil]
       #
@@ -298,7 +298,7 @@ module AWS
       end
 
       # @return [Boolean] Returns true if the table exists.  Note that a table
-      #   exists even when it is in a +:deleting+ state; this method
+      #   exists even when it is in a `:deleting` state; this method
       #   only returns false when DynamoDB no longer returns any
       #   information about the table.
       def exists?
@@ -315,43 +315,43 @@ module AWS
       #
       # You can call this method in two forms:
       #
-      #   # block form
-      #   table.batch_get(:all, items) do |attributes|
-      #     # yeilds one hash of attribute names/values for each item
-      #     puts attributes.to_yaml
-      #   end
+      #     # block form
+      #     table.batch_get(:all, items) do |attributes|
+      #       # yeilds one hash of attribute names/values for each item
+      #       puts attributes.to_yaml
+      #     end
       #
-      #   # enumerable return value
-      #   attribute_hashes = table.batch_get(:all, items)
-      #   attribute_hashes.each do |attributes|
-      #     # ...
-      #   end
+      #     # enumerable return value
+      #     attribute_hashes = table.batch_get(:all, items)
+      #     attribute_hashes.each do |attributes|
+      #       # ...
+      #     end
       #
       # @note This method does not require the table schema to be loaded.
       #
-      # == Attributes
+      # ## Attributes
       #
       # You can specify the list of attributes to request in 3 ways:
       #
-      # * The symbol +:all+ (to recieve all attributes)
+      # * The symbol `:all` (to recieve all attributes)
       # * A single attribute name (e.g. 'size')
       # * An array of attribute names (e.g. ['size', 'color'])
       #
       # A few exmaples:
       #
-      #   # get all attributes
-      #   table.batch_get(:all, items)
+      #     # get all attributes
+      #     table.batch_get(:all, items)
       #
-      #   # only get the 'color' attribute
-      #   table.batch_get('color', items)
+      #     # only get the 'color' attribute
+      #     table.batch_get('color', items)
       #
-      #   # get 'color' and 'size' attributes
-      #   table.batch_get(['color', size'], items)
+      #     # get 'color' and 'size' attributes
+      #     table.batch_get(['color', size'], items)
       #
-      # == Items
+      # ## Items
       #
       # You must specify an array of items to fetch attributes for.
-      # The +items+ param should always be an array with:
+      # The `items` param should always be an array with:
       #
       # * String hash key values
       # * Arrays of string hash key and range key values
@@ -359,41 +359,41 @@ module AWS
       #
       # Here are a few examples:
       #
-      #   # items as a list of hash key values
-      #   items = %w(hashkey1 hashkey2 hashkey3)
-      #   table.batch_get(:all, items)
+      #     # items as a list of hash key values
+      #     items = %w(hashkey1 hashkey2 hashkey3)
+      #     table.batch_get(:all, items)
       #
-      #   # items as a list of hash and range key values
-      #   items = [['hashkey1', 'rangekey2'], ['hashkey1', 'rangekey2']]
-      #   table.batch_get(:all, items)
+      #     # items as a list of hash and range key values
+      #     items = [['hashkey1', 'rangekey2'], ['hashkey1', 'rangekey2']]
+      #     table.batch_get(:all, items)
       #
-      #   # items as a list of Item objects
-      #   items = []
-      #   items << Item.new(table, 'hashkey1')
-      #   items << Item.new(table, 'hashkey2')
-      #   table.batch_get(:all, items)
+      #     # items as a list of Item objects
+      #     items = []
+      #     items << Item.new(table, 'hashkey1')
+      #     items << Item.new(table, 'hashkey2')
+      #     table.batch_get(:all, items)
       #
       # Please note that you must provide both hash and range keys for tables
       # that include a range key in the schema.
       #
       # @param [:all, String, Array<String>] attributes The list of
-      #   attributes you want to fetch for each item.  +attributes+ may be:
+      #   attributes you want to fetch for each item.  `attributes` may be:
       #
-      #   * the symbol +:all+
-      #   * a single attribute name string
-      #   * an array of attribute name strings
+      #     * the symbol `:all`
+      #     * a single attribute name string
+      #     * an array of attribute name strings
       #
       # @param [Mixed] items A list of 2 or more items to fetch attributes
-      #   for.  You may provide +items+ as:
+      #   for.  You may provide `items` as:
       #
-      #   * an array of hash key value strings
-      #   * an array of hash and range key value pairs (nested arrays)
-      #   * an array of {Item} objects
+      #     * an array of hash key value strings
+      #     * an array of hash and range key value pairs (nested arrays)
+      #     * an array of {Item} objects
       #
       # @param [Hash] options
       #
-      # @option options [Boolean] :consistent_read (false) When +true+, items
-      #   are read from this table with consistent reads.  When +false+, reads
+      # @option options [Boolean] :consistent_read (false) When `true`, items
+      #   are read from this table with consistent reads.  When `false`, reads
       #   are eventually consistent.
       #
       # @yield [Hash] Yields a hash of attributes for each item.
@@ -410,11 +410,11 @@ module AWS
 
       # Batch puts up to 25 items to this table.
       #
-      #   table.batch_put([
-      #     { :id => 'id1', :color => 'red' },
-      #     { :id => 'id2', :color => 'blue' },
-      #     { :id => 'id3', :color => 'green' },
-      #   ])
+      #     table.batch_put([
+      #       { :id => 'id1', :color => 'red' },
+      #       { :id => 'id2', :color => 'blue' },
+      #       { :id => 'id3', :color => 'green' },
+      #     ])
       #
       # @param [Array<Hash>] items A list of item attributes to put.
       #   The hash must contain the table hash key element and range key
@@ -431,14 +431,14 @@ module AWS
       # Batch writes up to 25 items to this table.  A batch may contain
       # a mix of items to put and items to delete.
       #
-      #   table.batch_write(
-      #     :put => [
-      #       { :id => 'id1', :color => 'red' },
-      #       { :id => 'id2', :color => 'blue' },
-      #       { :id => 'id3', :color => 'green' },
-      #     ],
-      #     :delete => ['id4', 'id5']
-      #   )
+      #     table.batch_write(
+      #       :put => [
+      #         { :id => 'id1', :color => 'red' },
+      #         { :id => 'id2', :color => 'blue' },
+      #         { :id => 'id3', :color => 'green' },
+      #       ],
+      #       :delete => ['id4', 'id5']
+      #     )
       #
       # @param [Hash] options
       #
@@ -454,18 +454,18 @@ module AWS
 
       # Delete up to 25 items in a single batch.
       #
-      #   table.batch_delete(%w(id1 id2 id3 id4 id5))
+      #     table.batch_delete(%w(id1 id2 id3 id4 id5))
       #
       # @param [Array<String>,Array<Array>] items A list of item keys to
       #   delete.  For tables without a range key, items should be an array
       #   of hash key strings.
       #
-      #      batch.delete('table-name', ['hk1', 'hk2', 'hk3'])
+      #       batch.delete('table-name', ['hk1', 'hk2', 'hk3'])
       #
       #   For tables with a range key, items should be an array of
       #   hash key and range key pairs.
       #
-      #      batch.delete('table-name', [['hk1', 'rk1'], ['hk1', 'rk2']])
+      #       batch.delete('table-name', [['hk1', 'rk1'], ['hk1', 'rk2']])
       #
       # @return (see BatchWrite#process!)
       #