aws-sdk 1.5.8 → 1.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. data/lib/aws.rb +2 -0
  2. data/lib/aws/api_config/Route53-2012-02-29.yml +348 -0
  3. data/lib/aws/auto_scaling/client.rb +362 -588
  4. data/lib/aws/cloud_formation/client.rb +155 -224
  5. data/lib/aws/cloud_watch/client.rb +156 -229
  6. data/lib/aws/core.rb +67 -52
  7. data/lib/aws/core/client.rb +81 -82
  8. data/lib/aws/core/collection/with_limit_and_next_token.rb +2 -2
  9. data/lib/aws/core/configuration.rb +75 -72
  10. data/lib/aws/core/http/net_http_handler.rb +3 -3
  11. data/lib/aws/core/http/request.rb +107 -138
  12. data/lib/aws/core/inflection.rb +3 -3
  13. data/lib/aws/core/json_client.rb +106 -0
  14. data/lib/aws/core/option_grammar.rb +10 -1
  15. data/lib/aws/core/options/validator.rb +140 -0
  16. data/lib/aws/core/options/xml_serializer.rb +98 -0
  17. data/lib/aws/core/query_client.rb +131 -0
  18. data/lib/aws/core/rest_client.rb +90 -0
  19. data/lib/aws/core/rest_client/input_handler.rb +145 -0
  20. data/lib/aws/core/rest_client/output_handler.rb +43 -0
  21. data/lib/aws/core/signature/version_2.rb +7 -7
  22. data/lib/aws/core/signature/version_3.rb +5 -1
  23. data/lib/aws/core/signature/version_3_https.rb +51 -0
  24. data/lib/aws/core/signature/version_4.rb +5 -22
  25. data/lib/aws/core/signer.rb +1 -1
  26. data/lib/aws/core/uri_escape.rb +2 -0
  27. data/lib/aws/core/xml/frame.rb +8 -8
  28. data/lib/aws/core/xml/grammar.rb +8 -3
  29. data/lib/aws/dynamo_db/client.rb +600 -662
  30. data/lib/aws/ec2/client.rb +2688 -3492
  31. data/lib/aws/ec2/request.rb +0 -1
  32. data/lib/aws/elb/client.rb +280 -407
  33. data/lib/aws/emr/client.rb +7 -7
  34. data/lib/aws/iam/client.rb +822 -1268
  35. data/lib/aws/route_53.rb +71 -0
  36. data/lib/aws/route_53/client.rb +272 -0
  37. data/lib/aws/route_53/config.rb +18 -0
  38. data/lib/aws/route_53/errors.rb +22 -0
  39. data/lib/aws/route_53/request.rb +23 -0
  40. data/lib/aws/s3/object_version_collection.rb +6 -6
  41. data/lib/aws/s3/paginated_collection.rb +1 -1
  42. data/lib/aws/s3/request.rb +10 -5
  43. data/lib/aws/simple_db/client.rb +184 -234
  44. data/lib/aws/simple_email_service/client.rb +147 -238
  45. data/lib/aws/simple_workflow/client.rb +997 -1191
  46. data/lib/aws/sns/client.rb +176 -264
  47. data/lib/aws/sqs/client.rb +162 -253
  48. data/lib/aws/sqs/queue.rb +1 -1
  49. data/lib/aws/sqs/request.rb +4 -0
  50. data/lib/aws/sts/client.rb +57 -66
  51. metadata +95 -71
  52. data/lib/aws/core/client/query_json.rb +0 -112
  53. data/lib/aws/core/client/query_xml.rb +0 -122
@@ -25,6 +25,7 @@ module AWS
25
25
  value = value.encode("UTF-8") if value.respond_to?(:encode)
26
26
  CGI::escape(value.to_s).gsub('+', '%20').gsub('%7E', '~')
27
27
  end
28
+ module_function :escape
28
29
 
29
30
  # @param [String] value
30
31
  # @return [String] Returns a URI-escaped path without escaping the
@@ -36,6 +37,7 @@ module AWS
36
37
  end
37
38
  escaped
38
39
  end
40
+ module_function :escape_path
39
41
 
40
42
  end
41
43
  end
@@ -172,14 +172,14 @@ module AWS
172
172
  rules[:type] == :boolean ? false : nil
173
173
  else
174
174
  case rules[:type]
175
- when nil then @text
176
- when :datetime then datetime_like_value(DateTime, :civil)
177
- when :time then datetime_like_value(Time, :utc)
178
- when :integer then @text.to_i
179
- when :float then @text.to_f
180
- when :boolean then @text == 'true'
181
- when :blob then Base64.decode64(@text)
182
- when :symbol then Core::Inflection.ruby_name(@text).to_sym
175
+ when nil, :string then @text
176
+ when :datetime then datetime_like_value(DateTime, :civil)
177
+ when :time then datetime_like_value(Time, :utc)
178
+ when :integer then @text.to_i
179
+ when :float then @text.to_f
180
+ when :boolean then @text == 'true'
181
+ when :blob then Base64.decode64(@text)
182
+ when :symbol then Core::Inflection.ruby_name(@text).to_sym
183
183
  else raise "unhandled type"
184
184
  end
185
185
  end
@@ -127,9 +127,8 @@ module AWS
127
127
 
128
128
  def validate_config_method(method)
129
129
  allow_methods = %w(
130
- rename attribute_name boolean integer long float list force
131
- ignore collect_values symbol_value timestamp map_entry map
132
- blob string
130
+ rename attribute_name boolean integer long float list force string
131
+ ignore collect_values symbol_value timestamp map_entry map blob
133
132
  )
134
133
  unless allow_methods.include?(method.to_s)
135
134
  raise "#{method} cannot be used in configuration"
@@ -286,6 +285,12 @@ module AWS
286
285
  end
287
286
  alias_method :==, :eql?
288
287
 
288
+ def http_trait *args; end
289
+ alias_method :http_header, :http_trait
290
+ alias_method :http_uri_label, :http_trait
291
+ alias_method :http_payload, :http_trait
292
+ alias_method :http_status, :http_trait
293
+
289
294
  protected
290
295
  def context_for_child child_element_name
291
296
  @context[:children] ||= {}
@@ -19,7 +19,7 @@ module AWS
19
19
 
20
20
  API_VERSION = '2011-12-05'
21
21
 
22
- extend Core::Client::QueryJSON
22
+ extend Core::JSONClient
23
23
 
24
24
  # @private
25
25
  REGION_US_E1 = 'dynamodb.us-east-1.amazonaws.com'
@@ -34,88 +34,9 @@ module AWS
34
34
 
35
35
  # Calls the BatchGetItem API operation.
36
36
  # @method batch_get_item(options = {})
37
- #
38
- # === Options:
39
- #
40
- # * +:request_items+ - *required* - (Hash<String,Hash>)
41
- # * +:keys+ - *required* - (Array<Hash>)
42
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
43
- # treated as the primary key, and can be a string or a number.
44
- # Single attribute primary keys have one index value. The value can
45
- # be String, Number, StringSet, NumberSet.
46
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
47
- # The maximum size is limited by the size of the primary key
48
- # (1024 bytes as a range part of a key or 2048 bytes as a single
49
- # part hash key) or the item size (64k).
50
- # * +:n+ - (String) Numbers are positive or negative exact-value
51
- # decimals and integers. A number can have up to 38 digits
52
- # precision and can be between 10^-128 to 10^+126.
53
- # * +:ss+ - (Array<String>) A set of strings.
54
- # * +:ns+ - (Array<String>) A set of numbers.
55
- # * +:range_key_element+ - (Hash) A range key element is treated as a
56
- # secondary key (used in conjunction with the primary key), and can
57
- # be a string or a number, and is only used for hash-and-range
58
- # primary keys. The value can be String, Number, StringSet,
59
- # NumberSet.
60
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
61
- # The maximum size is limited by the size of the primary key
62
- # (1024 bytes as a range part of a key or 2048 bytes as a single
63
- # part hash key) or the item size (64k).
64
- # * +:n+ - (String) Numbers are positive or negative exact-value
65
- # decimals and integers. A number can have up to 38 digits
66
- # precision and can be between 10^-128 to 10^+126.
67
- # * +:ss+ - (Array<String>) A set of strings.
68
- # * +:ns+ - (Array<String>) A set of numbers.
69
- # * +:attributes_to_get+ - (Array<String>)
70
- #
71
- # === Response Structure:
72
- #
73
- # * +Responses+ - (Hash<String,Hash>)
74
- # * +member+ - (Hash<String,Hash>)
75
- # * +S+ - (String)
76
- # * +N+ - (String)
77
- # * +SS+ - (Array<String>)
78
- # * +NS+ - (Array<String>)
79
- # * +ConsumedCapacityUnits+ - (Numeric)
80
- # * +UnprocessedKeys+ - (Hash<String,Hash>)
81
- # * +Keys+ - (Array<Hash>)
82
- # * +HashKeyElement+ - (Hash)
83
- # * +S+ - (String)
84
- # * +N+ - (String)
85
- # * +SS+ - (Array<String>)
86
- # * +NS+ - (Array<String>)
87
- # * +RangeKeyElement+ - (Hash)
88
- # * +S+ - (String)
89
- # * +N+ - (String)
90
- # * +SS+ - (Array<String>)
91
- # * +NS+ - (Array<String>)
92
- # * +AttributesToGet+ - (Array<String>)
93
- #
94
- # @return [Core::Response]
95
- #
96
- define_client_method :batch_get_item, 'BatchGetItem'
97
-
98
- # Calls the BatchWriteItem API operation.
99
- # @method batch_write_item(options = {})
100
- #
101
- # === Options:
102
- #
103
- # * +:request_items+ - *required* - (Hash<String,Array<Hash>>) A map of
104
- # table name to list-of-write-requests. Used as input to the
105
- # BatchWriteItem API call
106
- # * +:put_request+ - (Hash)
107
- # * +:item+ - *required* - (Hash<String,Hash>) The item to put
108
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
109
- # The maximum size is limited by the size of the primary key
110
- # (1024 bytes as a range part of a key or 2048 bytes as a single
111
- # part hash key) or the item size (64k).
112
- # * +:n+ - (String) Numbers are positive or negative exact-value
113
- # decimals and integers. A number can have up to 38 digits
114
- # precision and can be between 10^-128 to 10^+126.
115
- # * +:ss+ - (Array<String>) A set of strings.
116
- # * +:ns+ - (Array<String>) A set of numbers.
117
- # * +:delete_request+ - (Hash)
118
- # * +:key+ - *required* - (Hash) The item's key to be delete
37
+ # @param [Hash] options
38
+ # * +:request_items+ - *required* - (Hash<String,Hash>)
39
+ # * +:keys+ - *required* - (Array<Hash>)
119
40
  # * +:hash_key_element+ - *required* - (Hash) A hash key element is
120
41
  # treated as the primary key, and can be a string or a number.
121
42
  # Single attribute primary keys have one index value. The value
@@ -143,323 +64,349 @@ module AWS
143
64
  # precision and can be between 10^-128 to 10^+126.
144
65
  # * +:ss+ - (Array<String>) A set of strings.
145
66
  # * +:ns+ - (Array<String>) A set of numbers.
146
- #
147
- # === Response Structure:
148
- #
149
- # * +Responses+ - (Hash<String,Hash>)
150
- # * +ConsumedCapacityUnits+ - (Numeric)
151
- # * +UnprocessedItems+ - (Hash<String,Hash>)
152
- # * +value+ - (Array<Hash>)
153
- # * +PutRequest+ - (Hash)
154
- # * +Item+ - (Hash<String,Hash>)
67
+ # * +:attributes_to_get+ - (Array<String>)
68
+ # @return [Core::Response]
69
+ # The #data method of the response object returns
70
+ # a hash with the following structure:
71
+ # * +Responses+ - (Hash<String,Hash>)
72
+ # * +member+ - (Hash<String,Hash>)
73
+ # * +S+ - (String)
74
+ # * +N+ - (String)
75
+ # * +SS+ - (Array<String>)
76
+ # * +NS+ - (Array<String>)
77
+ # * +ConsumedCapacityUnits+ - (Numeric)
78
+ # * +UnprocessedKeys+ - (Hash<String,Hash>)
79
+ # * +Keys+ - (Array<Hash>)
80
+ # * +HashKeyElement+ - (Hash)
155
81
  # * +S+ - (String)
156
82
  # * +N+ - (String)
157
83
  # * +SS+ - (Array<String>)
158
84
  # * +NS+ - (Array<String>)
159
- # * +DeleteRequest+ - (Hash)
160
- # * +Key+ - (Hash)
161
- # * +HashKeyElement+ - (Hash)
162
- # * +S+ - (String)
163
- # * +N+ - (String)
164
- # * +SS+ - (Array<String>)
165
- # * +NS+ - (Array<String>)
166
- # * +RangeKeyElement+ - (Hash)
85
+ # * +RangeKeyElement+ - (Hash)
86
+ # * +S+ - (String)
87
+ # * +N+ - (String)
88
+ # * +SS+ - (Array<String>)
89
+ # * +NS+ - (Array<String>)
90
+ # * +AttributesToGet+ - (Array<String>)
91
+ define_client_method :batch_get_item, 'BatchGetItem'
92
+
93
+ # Calls the BatchWriteItem API operation.
94
+ # @method batch_write_item(options = {})
95
+ # @param [Hash] options
96
+ # * +:request_items+ - *required* - (Hash<String,Array<Hash>>) A map of
97
+ # table name to list-of-write-requests. Used as input to the
98
+ # BatchWriteItem API call
99
+ # * +:put_request+ - (Hash)
100
+ # * +:item+ - *required* - (Hash<String,Hash>) The item to put
101
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary
102
+ # encoding. The maximum size is limited by the size of the
103
+ # primary key (1024 bytes as a range part of a key or 2048
104
+ # bytes as a single part hash key) or the item size (64k).
105
+ # * +:n+ - (String) Numbers are positive or negative exact-value
106
+ # decimals and integers. A number can have up to 38 digits
107
+ # precision and can be between 10^-128 to 10^+126.
108
+ # * +:ss+ - (Array<String>) A set of strings.
109
+ # * +:ns+ - (Array<String>) A set of numbers.
110
+ # * +:delete_request+ - (Hash)
111
+ # * +:key+ - *required* - (Hash) The item's key to be delete
112
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element
113
+ # is treated as the primary key, and can be a string or a
114
+ # number. Single attribute primary keys have one index value.
115
+ # The value can be String, Number, StringSet, NumberSet.
116
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary
117
+ # encoding. The maximum size is limited by the size of the
118
+ # primary key (1024 bytes as a range part of a key or 2048
119
+ # bytes as a single part hash key) or the item size (64k).
120
+ # * +:n+ - (String) Numbers are positive or negative
121
+ # exact-value decimals and integers. A number can have up to
122
+ # 38 digits precision and can be between 10^-128 to 10^+126.
123
+ # * +:ss+ - (Array<String>) A set of strings.
124
+ # * +:ns+ - (Array<String>) A set of numbers.
125
+ # * +:range_key_element+ - (Hash) A range key element is treated
126
+ # as a secondary key (used in conjunction with the primary
127
+ # key), and can be a string or a number, and is only used for
128
+ # hash-and-range primary keys. The value can be String, Number,
129
+ # StringSet, NumberSet.
130
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary
131
+ # encoding. The maximum size is limited by the size of the
132
+ # primary key (1024 bytes as a range part of a key or 2048
133
+ # bytes as a single part hash key) or the item size (64k).
134
+ # * +:n+ - (String) Numbers are positive or negative
135
+ # exact-value decimals and integers. A number can have up to
136
+ # 38 digits precision and can be between 10^-128 to 10^+126.
137
+ # * +:ss+ - (Array<String>) A set of strings.
138
+ # * +:ns+ - (Array<String>) A set of numbers.
139
+ # @return [Core::Response]
140
+ # The #data method of the response object returns
141
+ # a hash with the following structure:
142
+ # * +Responses+ - (Hash<String,Hash>)
143
+ # * +ConsumedCapacityUnits+ - (Numeric)
144
+ # * +UnprocessedItems+ - (Hash<String,Hash>)
145
+ # * +value+ - (Array<Hash>)
146
+ # * +PutRequest+ - (Hash)
147
+ # * +Item+ - (Hash<String,Hash>)
167
148
  # * +S+ - (String)
168
149
  # * +N+ - (String)
169
150
  # * +SS+ - (Array<String>)
170
151
  # * +NS+ - (Array<String>)
171
- #
172
- # @return [Core::Response]
173
- #
152
+ # * +DeleteRequest+ - (Hash)
153
+ # * +Key+ - (Hash)
154
+ # * +HashKeyElement+ - (Hash)
155
+ # * +S+ - (String)
156
+ # * +N+ - (String)
157
+ # * +SS+ - (Array<String>)
158
+ # * +NS+ - (Array<String>)
159
+ # * +RangeKeyElement+ - (Hash)
160
+ # * +S+ - (String)
161
+ # * +N+ - (String)
162
+ # * +SS+ - (Array<String>)
163
+ # * +NS+ - (Array<String>)
174
164
  define_client_method :batch_write_item, 'BatchWriteItem'
175
165
 
176
166
  # Calls the CreateTable API operation.
177
167
  # @method create_table(options = {})
178
- #
179
- # === Options:
180
- #
181
- # * +:table_name+ - *required* - (String) The name of the table you want
182
- # to create. Allowed characters are a-z, A-Z, 0-9, _ (underscore), -
183
- # (hyphen) and . (period).
184
- # * +:key_schema+ - *required* - (Hash)
185
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
186
- # treated as the primary key, and can be a string or a number. Single
187
- # attribute primary keys have one index value. The value can be
188
- # String, Number, StringSet, NumberSet.
189
- # * +:attribute_name+ - *required* - (String) The AttributeName of
190
- # the KeySchemaElement.
191
- # * +:attribute_type+ - *required* - (String) The AttributeType of
192
- # the KeySchemaElement which can be a String or a Number.
193
- # * +:range_key_element+ - (Hash) A range key element is treated as a
194
- # secondary key (used in conjunction with the primary key), and can
195
- # be a string or a number, and is only used for hash-and-range
196
- # primary keys. The value can be String, Number, StringSet,
197
- # NumberSet.
198
- # * +:attribute_name+ - *required* - (String) The AttributeName of
199
- # the KeySchemaElement.
200
- # * +:attribute_type+ - *required* - (String) The AttributeType of
201
- # the KeySchemaElement which can be a String or a Number.
202
- # * +:provisioned_throughput+ - *required* - (Hash)
203
- # * +:read_capacity_units+ - *required* - (Integer) ReadCapacityUnits
204
- # are in terms of strictly consistent reads, assuming items of 1k. 2k
205
- # items require twice the ReadCapacityUnits. Eventually-consistent
206
- # reads only require half the ReadCapacityUnits of stirctly
207
- # consistent reads.
208
- # * +:write_capacity_units+ - *required* - (Integer) WriteCapacityUnits
209
- # are in terms of strictly consistent reads, assuming items of 1k. 2k
210
- # items require twice the WriteCapacityUnits.
211
- #
212
- # === Response Structure:
213
- #
214
- # * +TableDescription+ - (Hash)
215
- # * +TableName+ - (String)
216
- # * +KeySchema+ - (Hash)
217
- # * +HashKeyElement+ - (Hash)
218
- # * +AttributeName+ - (String)
219
- # * +AttributeType+ - (String)
220
- # * +RangeKeyElement+ - (Hash)
221
- # * +AttributeName+ - (String)
222
- # * +AttributeType+ - (String)
223
- # * +TableStatus+ - (String)
224
- # * +CreationDateTime+ - (Time)
225
- # * +ProvisionedThroughput+ - (Hash)
226
- # * +LastIncreaseDateTime+ - (Time)
227
- # * +LastDecreaseDateTime+ - (Time)
228
- # * +ReadCapacityUnits+ - (Integer)
229
- # * +WriteCapacityUnits+ - (Integer)
230
- # * +TableSizeBytes+ - (Integer)
231
- # * +ItemCount+ - (Integer)
232
- #
168
+ # @param [Hash] options
169
+ # * +:table_name+ - *required* - (String) The name of the table you
170
+ # want to create. Allowed characters are a-z, A-Z, 0-9, _
171
+ # (underscore), - (hyphen) and . (period).
172
+ # * +:key_schema+ - *required* - (Hash)
173
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element is
174
+ # treated as the primary key, and can be a string or a number.
175
+ # Single attribute primary keys have one index value. The value can
176
+ # be String, Number, StringSet, NumberSet.
177
+ # * +:attribute_name+ - *required* - (String) The AttributeName of
178
+ # the KeySchemaElement.
179
+ # * +:attribute_type+ - *required* - (String) The AttributeType of
180
+ # the KeySchemaElement which can be a String or a Number.
181
+ # * +:range_key_element+ - (Hash) A range key element is treated as a
182
+ # secondary key (used in conjunction with the primary key), and can
183
+ # be a string or a number, and is only used for hash-and-range
184
+ # primary keys. The value can be String, Number, StringSet,
185
+ # NumberSet.
186
+ # * +:attribute_name+ - *required* - (String) The AttributeName of
187
+ # the KeySchemaElement.
188
+ # * +:attribute_type+ - *required* - (String) The AttributeType of
189
+ # the KeySchemaElement which can be a String or a Number.
190
+ # * +:provisioned_throughput+ - *required* - (Hash)
191
+ # * +:read_capacity_units+ - *required* - (Integer) ReadCapacityUnits
192
+ # are in terms of strictly consistent reads, assuming items of 1k.
193
+ # 2k items require twice the ReadCapacityUnits.
194
+ # Eventually-consistent reads only require half the
195
+ # ReadCapacityUnits of stirctly consistent reads.
196
+ # * +:write_capacity_units+ - *required* - (Integer)
197
+ # WriteCapacityUnits are in terms of strictly consistent reads,
198
+ # assuming items of 1k. 2k items require twice the
199
+ # WriteCapacityUnits.
233
200
  # @return [Core::Response]
234
- #
201
+ # The #data method of the response object returns
202
+ # a hash with the following structure:
203
+ # * +TableDescription+ - (Hash)
204
+ # * +TableName+ - (String)
205
+ # * +KeySchema+ - (Hash)
206
+ # * +HashKeyElement+ - (Hash)
207
+ # * +AttributeName+ - (String)
208
+ # * +AttributeType+ - (String)
209
+ # * +RangeKeyElement+ - (Hash)
210
+ # * +AttributeName+ - (String)
211
+ # * +AttributeType+ - (String)
212
+ # * +TableStatus+ - (String)
213
+ # * +CreationDateTime+ - (Time)
214
+ # * +ProvisionedThroughput+ - (Hash)
215
+ # * +LastIncreaseDateTime+ - (Time)
216
+ # * +LastDecreaseDateTime+ - (Time)
217
+ # * +ReadCapacityUnits+ - (Integer)
218
+ # * +WriteCapacityUnits+ - (Integer)
219
+ # * +TableSizeBytes+ - (Integer)
220
+ # * +ItemCount+ - (Integer)
235
221
  define_client_method :create_table, 'CreateTable'
236
222
 
237
223
  # Calls the DeleteItem API operation.
238
224
  # @method delete_item(options = {})
239
- #
240
- # === Options:
241
- #
242
- # * +:table_name+ - *required* - (String) The name of the table in which
243
- # you want to delete an item. Allowed characters are a-z, A-Z, 0-9, _
244
- # (underscore), - (hyphen) and . (period).
245
- # * +:key+ - *required* - (Hash)
246
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
247
- # treated as the primary key, and can be a string or a number. Single
248
- # attribute primary keys have one index value. The value can be
249
- # String, Number, StringSet, NumberSet.
250
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
251
- # The maximum size is limited by the size of the primary key (1024
252
- # bytes as a range part of a key or 2048 bytes as a single part
253
- # hash key) or the item size (64k).
254
- # * +:n+ - (String) Numbers are positive or negative exact-value
255
- # decimals and integers. A number can have up to 38 digits
256
- # precision and can be between 10^-128 to 10^+126.
257
- # * +:ss+ - (Array<String>) A set of strings.
258
- # * +:ns+ - (Array<String>) A set of numbers.
259
- # * +:range_key_element+ - (Hash) A range key element is treated as a
260
- # secondary key (used in conjunction with the primary key), and can
261
- # be a string or a number, and is only used for hash-and-range
262
- # primary keys. The value can be String, Number, StringSet,
263
- # NumberSet.
264
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
265
- # The maximum size is limited by the size of the primary key (1024
266
- # bytes as a range part of a key or 2048 bytes as a single part
267
- # hash key) or the item size (64k).
268
- # * +:n+ - (String) Numbers are positive or negative exact-value
269
- # decimals and integers. A number can have up to 38 digits
270
- # precision and can be between 10^-128 to 10^+126.
271
- # * +:ss+ - (Array<String>) A set of strings.
272
- # * +:ns+ - (Array<String>) A set of numbers.
273
- # * +:expected+ - (Hash<String,Hash>)
274
- # * +:value+ - (Hash) Specify whether or not a value already exists and
275
- # has a specific content for the attribute name-value pair.
276
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
277
- # The maximum size is limited by the size of the primary key (1024
278
- # bytes as a range part of a key or 2048 bytes as a single part
279
- # hash key) or the item size (64k).
280
- # * +:n+ - (String) Numbers are positive or negative exact-value
281
- # decimals and integers. A number can have up to 38 digits
282
- # precision and can be between 10^-128 to 10^+126.
283
- # * +:ss+ - (Array<String>) A set of strings.
284
- # * +:ns+ - (Array<String>) A set of numbers.
285
- # * +:exists+ - (Boolean) Specify whether or not a value already exists
286
- # for the attribute name-value pair.
287
- # * +:return_values+ - (String)
288
- #
289
- # === Response Structure:
290
- #
291
- # * +Attributes+ - (Hash<String,Hash>)
292
- # * +S+ - (String)
293
- # * +N+ - (String)
294
- # * +SS+ - (Array<String>)
295
- # * +NS+ - (Array<String>)
296
- # * +ConsumedCapacityUnits+ - (Numeric)
297
- #
225
+ # @param [Hash] options
226
+ # * +:table_name+ - *required* - (String) The name of the table in
227
+ # which you want to delete an item. Allowed characters are a-z, A-Z,
228
+ # 0-9, _ (underscore), - (hyphen) and . (period).
229
+ # * +:key+ - *required* - (Hash)
230
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element is
231
+ # treated as the primary key, and can be a string or a number.
232
+ # Single attribute primary keys have one index value. The value can
233
+ # be String, Number, StringSet, NumberSet.
234
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
235
+ # The maximum size is limited by the size of the primary key
236
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
237
+ # part hash key) or the item size (64k).
238
+ # * +:n+ - (String) Numbers are positive or negative exact-value
239
+ # decimals and integers. A number can have up to 38 digits
240
+ # precision and can be between 10^-128 to 10^+126.
241
+ # * +:ss+ - (Array<String>) A set of strings.
242
+ # * +:ns+ - (Array<String>) A set of numbers.
243
+ # * +:range_key_element+ - (Hash) A range key element is treated as a
244
+ # secondary key (used in conjunction with the primary key), and can
245
+ # be a string or a number, and is only used for hash-and-range
246
+ # primary keys. The value can be String, Number, StringSet,
247
+ # NumberSet.
248
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
249
+ # The maximum size is limited by the size of the primary key
250
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
251
+ # part hash key) or the item size (64k).
252
+ # * +:n+ - (String) Numbers are positive or negative exact-value
253
+ # decimals and integers. A number can have up to 38 digits
254
+ # precision and can be between 10^-128 to 10^+126.
255
+ # * +:ss+ - (Array<String>) A set of strings.
256
+ # * +:ns+ - (Array<String>) A set of numbers.
257
+ # * +:expected+ - (Hash<String,Hash>)
258
+ # * +:value+ - (Hash) Specify whether or not a value already exists
259
+ # and has a specific content for the attribute name-value pair.
260
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
261
+ # The maximum size is limited by the size of the primary key
262
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
263
+ # part hash key) or the item size (64k).
264
+ # * +:n+ - (String) Numbers are positive or negative exact-value
265
+ # decimals and integers. A number can have up to 38 digits
266
+ # precision and can be between 10^-128 to 10^+126.
267
+ # * +:ss+ - (Array<String>) A set of strings.
268
+ # * +:ns+ - (Array<String>) A set of numbers.
269
+ # * +:exists+ - (Boolean) Specify whether or not a value already
270
+ # exists for the attribute name-value pair.
271
+ # * +:return_values+ - (String)
298
272
  # @return [Core::Response]
299
- #
273
+ # The #data method of the response object returns
274
+ # a hash with the following structure:
275
+ # * +Attributes+ - (Hash<String,Hash>)
276
+ # * +S+ - (String)
277
+ # * +N+ - (String)
278
+ # * +SS+ - (Array<String>)
279
+ # * +NS+ - (Array<String>)
280
+ # * +ConsumedCapacityUnits+ - (Numeric)
300
281
  define_client_method :delete_item, 'DeleteItem'
301
282
 
302
283
  # Calls the DeleteTable API operation.
303
284
  # @method delete_table(options = {})
304
- #
305
- # === Options:
306
- #
307
- # * +:table_name+ - *required* - (String) The name of the table you want
308
- # to delete. Allowed characters are a-z, A-Z, 0-9, _ (underscore), -
309
- # (hyphen) and . (period).
310
- #
311
- # === Response Structure:
312
- #
313
- # * +TableDescription+ - (Hash)
314
- # * +TableName+ - (String)
315
- # * +KeySchema+ - (Hash)
316
- # * +HashKeyElement+ - (Hash)
317
- # * +AttributeName+ - (String)
318
- # * +AttributeType+ - (String)
319
- # * +RangeKeyElement+ - (Hash)
320
- # * +AttributeName+ - (String)
321
- # * +AttributeType+ - (String)
322
- # * +TableStatus+ - (String)
323
- # * +CreationDateTime+ - (Time)
324
- # * +ProvisionedThroughput+ - (Hash)
325
- # * +LastIncreaseDateTime+ - (Time)
326
- # * +LastDecreaseDateTime+ - (Time)
327
- # * +ReadCapacityUnits+ - (Integer)
328
- # * +WriteCapacityUnits+ - (Integer)
329
- # * +TableSizeBytes+ - (Integer)
330
- # * +ItemCount+ - (Integer)
331
- #
285
+ # @param [Hash] options
286
+ # * +:table_name+ - *required* - (String) The name of the table you
287
+ # want to delete. Allowed characters are a-z, A-Z, 0-9, _
288
+ # (underscore), - (hyphen) and . (period).
332
289
  # @return [Core::Response]
333
- #
290
+ # The #data method of the response object returns
291
+ # a hash with the following structure:
292
+ # * +TableDescription+ - (Hash)
293
+ # * +TableName+ - (String)
294
+ # * +KeySchema+ - (Hash)
295
+ # * +HashKeyElement+ - (Hash)
296
+ # * +AttributeName+ - (String)
297
+ # * +AttributeType+ - (String)
298
+ # * +RangeKeyElement+ - (Hash)
299
+ # * +AttributeName+ - (String)
300
+ # * +AttributeType+ - (String)
301
+ # * +TableStatus+ - (String)
302
+ # * +CreationDateTime+ - (Time)
303
+ # * +ProvisionedThroughput+ - (Hash)
304
+ # * +LastIncreaseDateTime+ - (Time)
305
+ # * +LastDecreaseDateTime+ - (Time)
306
+ # * +ReadCapacityUnits+ - (Integer)
307
+ # * +WriteCapacityUnits+ - (Integer)
308
+ # * +TableSizeBytes+ - (Integer)
309
+ # * +ItemCount+ - (Integer)
334
310
  define_client_method :delete_table, 'DeleteTable'
335
311
 
336
312
  # Calls the DescribeTable API operation.
337
313
  # @method describe_table(options = {})
338
- #
339
- # === Options:
340
- #
341
- # * +:table_name+ - *required* - (String) The name of the table you want
342
- # to describe. Allowed characters are a-z, A-Z, 0-9, _ (underscore), -
343
- # (hyphen) and . (period).
344
- #
345
- # === Response Structure:
346
- #
347
- # * +Table+ - (Hash)
348
- # * +TableName+ - (String)
349
- # * +KeySchema+ - (Hash)
350
- # * +HashKeyElement+ - (Hash)
351
- # * +AttributeName+ - (String)
352
- # * +AttributeType+ - (String)
353
- # * +RangeKeyElement+ - (Hash)
354
- # * +AttributeName+ - (String)
355
- # * +AttributeType+ - (String)
356
- # * +TableStatus+ - (String)
357
- # * +CreationDateTime+ - (Time)
358
- # * +ProvisionedThroughput+ - (Hash)
359
- # * +LastIncreaseDateTime+ - (Time)
360
- # * +LastDecreaseDateTime+ - (Time)
361
- # * +ReadCapacityUnits+ - (Integer)
362
- # * +WriteCapacityUnits+ - (Integer)
363
- # * +TableSizeBytes+ - (Integer)
364
- # * +ItemCount+ - (Integer)
365
- #
314
+ # @param [Hash] options
315
+ # * +:table_name+ - *required* - (String) The name of the table you
316
+ # want to describe. Allowed characters are a-z, A-Z, 0-9, _
317
+ # (underscore), - (hyphen) and . (period).
366
318
  # @return [Core::Response]
367
- #
319
+ # The #data method of the response object returns
320
+ # a hash with the following structure:
321
+ # * +Table+ - (Hash)
322
+ # * +TableName+ - (String)
323
+ # * +KeySchema+ - (Hash)
324
+ # * +HashKeyElement+ - (Hash)
325
+ # * +AttributeName+ - (String)
326
+ # * +AttributeType+ - (String)
327
+ # * +RangeKeyElement+ - (Hash)
328
+ # * +AttributeName+ - (String)
329
+ # * +AttributeType+ - (String)
330
+ # * +TableStatus+ - (String)
331
+ # * +CreationDateTime+ - (Time)
332
+ # * +ProvisionedThroughput+ - (Hash)
333
+ # * +LastIncreaseDateTime+ - (Time)
334
+ # * +LastDecreaseDateTime+ - (Time)
335
+ # * +ReadCapacityUnits+ - (Integer)
336
+ # * +WriteCapacityUnits+ - (Integer)
337
+ # * +TableSizeBytes+ - (Integer)
338
+ # * +ItemCount+ - (Integer)
368
339
  define_client_method :describe_table, 'DescribeTable'
369
340
 
370
341
  # Calls the GetItem API operation.
371
342
  # @method get_item(options = {})
372
- #
373
- # === Options:
374
- #
375
- # * +:table_name+ - *required* - (String) The name of the table in which
376
- # you want to get an item. Allowed characters are a-z, A-Z, 0-9, _
377
- # (underscore), - (hyphen) and . (period).
378
- # * +:key+ - *required* - (Hash)
379
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
380
- # treated as the primary key, and can be a string or a number. Single
381
- # attribute primary keys have one index value. The value can be
382
- # String, Number, StringSet, NumberSet.
383
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
384
- # The maximum size is limited by the size of the primary key (1024
385
- # bytes as a range part of a key or 2048 bytes as a single part
386
- # hash key) or the item size (64k).
387
- # * +:n+ - (String) Numbers are positive or negative exact-value
388
- # decimals and integers. A number can have up to 38 digits
389
- # precision and can be between 10^-128 to 10^+126.
390
- # * +:ss+ - (Array<String>) A set of strings.
391
- # * +:ns+ - (Array<String>) A set of numbers.
392
- # * +:range_key_element+ - (Hash) A range key element is treated as a
393
- # secondary key (used in conjunction with the primary key), and can
394
- # be a string or a number, and is only used for hash-and-range
395
- # primary keys. The value can be String, Number, StringSet,
396
- # NumberSet.
397
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
398
- # The maximum size is limited by the size of the primary key (1024
399
- # bytes as a range part of a key or 2048 bytes as a single part
400
- # hash key) or the item size (64k).
401
- # * +:n+ - (String) Numbers are positive or negative exact-value
402
- # decimals and integers. A number can have up to 38 digits
403
- # precision and can be between 10^-128 to 10^+126.
404
- # * +:ss+ - (Array<String>) A set of strings.
405
- # * +:ns+ - (Array<String>) A set of numbers.
406
- # * +:attributes_to_get+ - (Array<String>)
407
- # * +:consistent_read+ - (Boolean)
408
- #
409
- # === Response Structure:
410
- #
411
- # * +Item+ - (Hash<String,Hash>)
412
- # * +S+ - (String)
413
- # * +N+ - (String)
414
- # * +SS+ - (Array<String>)
415
- # * +NS+ - (Array<String>)
416
- # * +ConsumedCapacityUnits+ - (Numeric)
417
- #
343
+ # @param [Hash] options
344
+ # * +:table_name+ - *required* - (String) The name of the table in
345
+ # which you want to get an item. Allowed characters are a-z, A-Z,
346
+ # 0-9, _ (underscore), - (hyphen) and . (period).
347
+ # * +:key+ - *required* - (Hash)
348
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element is
349
+ # treated as the primary key, and can be a string or a number.
350
+ # Single attribute primary keys have one index value. The value can
351
+ # be String, Number, StringSet, NumberSet.
352
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
353
+ # The maximum size is limited by the size of the primary key
354
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
355
+ # part hash key) or the item size (64k).
356
+ # * +:n+ - (String) Numbers are positive or negative exact-value
357
+ # decimals and integers. A number can have up to 38 digits
358
+ # precision and can be between 10^-128 to 10^+126.
359
+ # * +:ss+ - (Array<String>) A set of strings.
360
+ # * +:ns+ - (Array<String>) A set of numbers.
361
+ # * +:range_key_element+ - (Hash) A range key element is treated as a
362
+ # secondary key (used in conjunction with the primary key), and can
363
+ # be a string or a number, and is only used for hash-and-range
364
+ # primary keys. The value can be String, Number, StringSet,
365
+ # NumberSet.
366
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
367
+ # The maximum size is limited by the size of the primary key
368
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
369
+ # part hash key) or the item size (64k).
370
+ # * +:n+ - (String) Numbers are positive or negative exact-value
371
+ # decimals and integers. A number can have up to 38 digits
372
+ # precision and can be between 10^-128 to 10^+126.
373
+ # * +:ss+ - (Array<String>) A set of strings.
374
+ # * +:ns+ - (Array<String>) A set of numbers.
375
+ # * +:attributes_to_get+ - (Array<String>)
376
+ # * +:consistent_read+ - (Boolean)
418
377
  # @return [Core::Response]
419
- #
378
+ # The #data method of the response object returns
379
+ # a hash with the following structure:
380
+ # * +Item+ - (Hash<String,Hash>)
381
+ # * +S+ - (String)
382
+ # * +N+ - (String)
383
+ # * +SS+ - (Array<String>)
384
+ # * +NS+ - (Array<String>)
385
+ # * +ConsumedCapacityUnits+ - (Numeric)
420
386
  define_client_method :get_item, 'GetItem'
421
387
 
422
388
  # Calls the ListTables API operation.
423
389
  # @method list_tables(options = {})
424
- #
425
- # === Options:
426
- #
427
- # * +:exclusive_start_table_name+ - (String) The name of the table that
428
- # starts the list. If you already ran a ListTables operation and
429
- # recieved a LastEvaluatedTableName value in the response, use that
430
- # value here to continue the list.
431
- # * +:limit+ - (Integer)
432
- #
433
- # === Response Structure:
434
- #
435
- # * +TableNames+ - (Array<String>)
436
- # * +LastEvaluatedTableName+ - (String)
437
- #
390
+ # @param [Hash] options
391
+ # * +:exclusive_start_table_name+ - (String) The name of the table that
392
+ # starts the list. If you already ran a ListTables operation and
393
+ # recieved a LastEvaluatedTableName value in the response, use that
394
+ # value here to continue the list.
395
+ # * +:limit+ - (Integer)
438
396
  # @return [Core::Response]
439
- #
397
+ # The #data method of the response object returns
398
+ # a hash with the following structure:
399
+ # * +TableNames+ - (Array<String>)
400
+ # * +LastEvaluatedTableName+ - (String)
440
401
  define_client_method :list_tables, 'ListTables'
441
402
 
442
403
  # Calls the PutItem API operation.
443
404
  # @method put_item(options = {})
444
- #
445
- # === Options:
446
- #
447
- # * +:table_name+ - *required* - (String) The name of the table in which
448
- # you want to put an item. Allowed characters are a-z, A-Z, 0-9, _
449
- # (underscore), - (hyphen) and . (period).
450
- # * +:item+ - *required* - (Hash<String,Hash>)
451
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding. The
452
- # maximum size is limited by the size of the primary key (1024 bytes
453
- # as a range part of a key or 2048 bytes as a single part hash key)
454
- # or the item size (64k).
455
- # * +:n+ - (String) Numbers are positive or negative exact-value
456
- # decimals and integers. A number can have up to 38 digits precision
457
- # and can be between 10^-128 to 10^+126.
458
- # * +:ss+ - (Array<String>) A set of strings.
459
- # * +:ns+ - (Array<String>) A set of numbers.
460
- # * +:expected+ - (Hash<String,Hash>)
461
- # * +:value+ - (Hash) Specify whether or not a value already exists and
462
- # has a specific content for the attribute name-value pair.
405
+ # @param [Hash] options
406
+ # * +:table_name+ - *required* - (String) The name of the table in
407
+ # which you want to put an item. Allowed characters are a-z, A-Z,
408
+ # 0-9, _ (underscore), - (hyphen) and . (period).
409
+ # * +:item+ - *required* - (Hash<String,Hash>)
463
410
  # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
464
411
  # The maximum size is limited by the size of the primary key (1024
465
412
  # bytes as a range part of a key or 2048 bytes as a single part
@@ -469,98 +416,55 @@ module AWS
469
416
  # precision and can be between 10^-128 to 10^+126.
470
417
  # * +:ss+ - (Array<String>) A set of strings.
471
418
  # * +:ns+ - (Array<String>) A set of numbers.
472
- # * +:exists+ - (Boolean) Specify whether or not a value already exists
473
- # for the attribute name-value pair.
474
- # * +:return_values+ - (String)
475
- #
476
- # === Response Structure:
477
- #
478
- # * +Attributes+ - (Hash<String,Hash>)
479
- # * +S+ - (String)
480
- # * +N+ - (String)
481
- # * +SS+ - (Array<String>)
482
- # * +NS+ - (Array<String>)
483
- # * +ConsumedCapacityUnits+ - (Numeric)
484
- #
419
+ # * +:expected+ - (Hash<String,Hash>)
420
+ # * +:value+ - (Hash) Specify whether or not a value already exists
421
+ # and has a specific content for the attribute name-value pair.
422
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
423
+ # The maximum size is limited by the size of the primary key
424
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
425
+ # part hash key) or the item size (64k).
426
+ # * +:n+ - (String) Numbers are positive or negative exact-value
427
+ # decimals and integers. A number can have up to 38 digits
428
+ # precision and can be between 10^-128 to 10^+126.
429
+ # * +:ss+ - (Array<String>) A set of strings.
430
+ # * +:ns+ - (Array<String>) A set of numbers.
431
+ # * +:exists+ - (Boolean) Specify whether or not a value already
432
+ # exists for the attribute name-value pair.
433
+ # * +:return_values+ - (String)
485
434
  # @return [Core::Response]
486
- #
435
+ # The #data method of the response object returns
436
+ # a hash with the following structure:
437
+ # * +Attributes+ - (Hash<String,Hash>)
438
+ # * +S+ - (String)
439
+ # * +N+ - (String)
440
+ # * +SS+ - (Array<String>)
441
+ # * +NS+ - (Array<String>)
442
+ # * +ConsumedCapacityUnits+ - (Numeric)
487
443
  define_client_method :put_item, 'PutItem'
488
444
 
489
445
  # Calls the Query API operation.
490
446
  # @method query(options = {})
491
- #
492
- # === Options:
493
- #
494
- # * +:table_name+ - *required* - (String) The name of the table in which
495
- # you want to query. Allowed characters are a-z, A-Z, 0-9, _
496
- # (underscore), - (hyphen) and . (period).
497
- # * +:attributes_to_get+ - (Array<String>)
498
- # * +:limit+ - (Integer) The maximum number of items to return. If Amazon
499
- # DynamoDB hits this limit while querying the table, it stops the query
500
- # and returns the matching values up to the limit, and a
501
- # LastEvaluatedKey to apply in a subsequent operation to continue the
502
- # query. Also, if the result set size exceeds 1MB before Amazon
503
- # DynamoDB hits this limit, it stops the query and returns the matching
504
- # values, and a LastEvaluatedKey to apply in a subsequent operation to
505
- # continue the query.
506
- # * +:consistent_read+ - (Boolean)
507
- # * +:count+ - (Boolean) If set to +true+ , Amazon DynamoDB returns a
508
- # total number of items that match the query parameters, instead of a
509
- # list of the matching items and their attributes. Do not set Count to
510
- # +true+ while providing a list of AttributesToGet, otherwise Amazon
511
- # DynamoDB returns a validation error.
512
- # * +:hash_key_value+ - *required* - (Hash) Attribute value of the hash
513
- # component of the composite primary key.
514
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding. The
515
- # maximum size is limited by the size of the primary key (1024 bytes
516
- # as a range part of a key or 2048 bytes as a single part hash key)
517
- # or the item size (64k).
518
- # * +:n+ - (String) Numbers are positive or negative exact-value
519
- # decimals and integers. A number can have up to 38 digits precision
520
- # and can be between 10^-128 to 10^+126.
521
- # * +:ss+ - (Array<String>) A set of strings.
522
- # * +:ns+ - (Array<String>) A set of numbers.
523
- # * +:range_key_condition+ - (Hash) A container for the attribute values
524
- # and comparison operators to use for the query.
525
- # * +:attribute_value_list+ - (Array<Hash>)
526
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
527
- # The maximum size is limited by the size of the primary key (1024
528
- # bytes as a range part of a key or 2048 bytes as a single part
529
- # hash key) or the item size (64k).
530
- # * +:n+ - (String) Numbers are positive or negative exact-value
531
- # decimals and integers. A number can have up to 38 digits
532
- # precision and can be between 10^-128 to 10^+126.
533
- # * +:ss+ - (Array<String>) A set of strings.
534
- # * +:ns+ - (Array<String>) A set of numbers.
535
- # * +:comparison_operator+ - *required* - (String)
536
- # * +:scan_index_forward+ - (Boolean) Specifies forward or backward
537
- # traversal of the index. Amazon DynamoDB returns results reflecting
538
- # the requested order, determined by the range key. Default is +true+
539
- # (forward).
540
- # * +:exclusive_start_key+ - (Hash) Primary key of the item from which to
541
- # continue an earlier query. An earlier query might provide this value
542
- # as the LastEvaluatedKey if that query operation was interrupted
543
- # before completing the query; either because of the result set size or
544
- # the Limit parameter. The LastEvaluatedKey can be passed back in a new
545
- # query request to continue the operation from that point.
546
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
547
- # treated as the primary key, and can be a string or a number. Single
548
- # attribute primary keys have one index value. The value can be
549
- # String, Number, StringSet, NumberSet.
550
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
551
- # The maximum size is limited by the size of the primary key (1024
552
- # bytes as a range part of a key or 2048 bytes as a single part
553
- # hash key) or the item size (64k).
554
- # * +:n+ - (String) Numbers are positive or negative exact-value
555
- # decimals and integers. A number can have up to 38 digits
556
- # precision and can be between 10^-128 to 10^+126.
557
- # * +:ss+ - (Array<String>) A set of strings.
558
- # * +:ns+ - (Array<String>) A set of numbers.
559
- # * +:range_key_element+ - (Hash) A range key element is treated as a
560
- # secondary key (used in conjunction with the primary key), and can
561
- # be a string or a number, and is only used for hash-and-range
562
- # primary keys. The value can be String, Number, StringSet,
563
- # NumberSet.
447
+ # @param [Hash] options
448
+ # * +:table_name+ - *required* - (String) The name of the table in
449
+ # which you want to query. Allowed characters are a-z, A-Z, 0-9, _
450
+ # (underscore), - (hyphen) and . (period).
451
+ # * +:attributes_to_get+ - (Array<String>)
452
+ # * +:limit+ - (Integer) The maximum number of items to return. If
453
+ # Amazon DynamoDB hits this limit while querying the table, it stops
454
+ # the query and returns the matching values up to the limit, and a
455
+ # LastEvaluatedKey to apply in a subsequent operation to continue the
456
+ # query. Also, if the result set size exceeds 1MB before Amazon
457
+ # DynamoDB hits this limit, it stops the query and returns the
458
+ # matching values, and a LastEvaluatedKey to apply in a subsequent
459
+ # operation to continue the query.
460
+ # * +:consistent_read+ - (Boolean)
461
+ # * +:count+ - (Boolean) If set to +true+ , Amazon DynamoDB returns a
462
+ # total number of items that match the query parameters, instead of a
463
+ # list of the matching items and their attributes. Do not set Count
464
+ # to +true+ while providing a list of AttributesToGet, otherwise
465
+ # Amazon DynamoDB returns a validation error.
466
+ # * +:hash_key_value+ - *required* - (Hash) Attribute value of the hash
467
+ # component of the composite primary key.
564
468
  # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
565
469
  # The maximum size is limited by the size of the primary key (1024
566
470
  # bytes as a range part of a key or 2048 bytes as a single part
@@ -570,245 +474,279 @@ module AWS
570
474
  # precision and can be between 10^-128 to 10^+126.
571
475
  # * +:ss+ - (Array<String>) A set of strings.
572
476
  # * +:ns+ - (Array<String>) A set of numbers.
573
- #
574
- # === Response Structure:
575
- #
576
- # * +member+ - (Hash<String,Hash>)
577
- # * +S+ - (String)
578
- # * +N+ - (String)
579
- # * +SS+ - (Array<String>)
580
- # * +NS+ - (Array<String>)
581
- # * +Count+ - (Integer)
582
- # * +LastEvaluatedKey+ - (Hash)
583
- # * +HashKeyElement+ - (Hash)
584
- # * +S+ - (String)
585
- # * +N+ - (String)
586
- # * +SS+ - (Array<String>)
587
- # * +NS+ - (Array<String>)
588
- # * +RangeKeyElement+ - (Hash)
477
+ # * +:range_key_condition+ - (Hash) A container for the attribute
478
+ # values and comparison operators to use for the query.
479
+ # * +:attribute_value_list+ - (Array<Hash>)
480
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
481
+ # The maximum size is limited by the size of the primary key
482
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
483
+ # part hash key) or the item size (64k).
484
+ # * +:n+ - (String) Numbers are positive or negative exact-value
485
+ # decimals and integers. A number can have up to 38 digits
486
+ # precision and can be between 10^-128 to 10^+126.
487
+ # * +:ss+ - (Array<String>) A set of strings.
488
+ # * +:ns+ - (Array<String>) A set of numbers.
489
+ # * +:comparison_operator+ - *required* - (String)
490
+ # * +:scan_index_forward+ - (Boolean) Specifies forward or backward
491
+ # traversal of the index. Amazon DynamoDB returns results reflecting
492
+ # the requested order, determined by the range key. Default is +true+
493
+ # (forward).
494
+ # * +:exclusive_start_key+ - (Hash) Primary key of the item from which
495
+ # to continue an earlier query. An earlier query might provide this
496
+ # value as the LastEvaluatedKey if that query operation was
497
+ # interrupted before completing the query; either because of the
498
+ # result set size or the Limit parameter. The LastEvaluatedKey can be
499
+ # passed back in a new query request to continue the operation from
500
+ # that point.
501
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element is
502
+ # treated as the primary key, and can be a string or a number.
503
+ # Single attribute primary keys have one index value. The value can
504
+ # be String, Number, StringSet, NumberSet.
505
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
506
+ # The maximum size is limited by the size of the primary key
507
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
508
+ # part hash key) or the item size (64k).
509
+ # * +:n+ - (String) Numbers are positive or negative exact-value
510
+ # decimals and integers. A number can have up to 38 digits
511
+ # precision and can be between 10^-128 to 10^+126.
512
+ # * +:ss+ - (Array<String>) A set of strings.
513
+ # * +:ns+ - (Array<String>) A set of numbers.
514
+ # * +:range_key_element+ - (Hash) A range key element is treated as a
515
+ # secondary key (used in conjunction with the primary key), and can
516
+ # be a string or a number, and is only used for hash-and-range
517
+ # primary keys. The value can be String, Number, StringSet,
518
+ # NumberSet.
519
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
520
+ # The maximum size is limited by the size of the primary key
521
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
522
+ # part hash key) or the item size (64k).
523
+ # * +:n+ - (String) Numbers are positive or negative exact-value
524
+ # decimals and integers. A number can have up to 38 digits
525
+ # precision and can be between 10^-128 to 10^+126.
526
+ # * +:ss+ - (Array<String>) A set of strings.
527
+ # * +:ns+ - (Array<String>) A set of numbers.
528
+ # @return [Core::Response]
529
+ # The #data method of the response object returns
530
+ # a hash with the following structure:
531
+ # * +member+ - (Hash<String,Hash>)
589
532
  # * +S+ - (String)
590
533
  # * +N+ - (String)
591
534
  # * +SS+ - (Array<String>)
592
535
  # * +NS+ - (Array<String>)
593
- # * +ConsumedCapacityUnits+ - (Numeric)
594
- #
595
- # @return [Core::Response]
596
- #
536
+ # * +Count+ - (Integer)
537
+ # * +LastEvaluatedKey+ - (Hash)
538
+ # * +HashKeyElement+ - (Hash)
539
+ # * +S+ - (String)
540
+ # * +N+ - (String)
541
+ # * +SS+ - (Array<String>)
542
+ # * +NS+ - (Array<String>)
543
+ # * +RangeKeyElement+ - (Hash)
544
+ # * +S+ - (String)
545
+ # * +N+ - (String)
546
+ # * +SS+ - (Array<String>)
547
+ # * +NS+ - (Array<String>)
548
+ # * +ConsumedCapacityUnits+ - (Numeric)
597
549
  define_client_method :query, 'Query'
598
550
 
599
551
  # Calls the Scan API operation.
600
552
  # @method scan(options = {})
601
- #
602
- # === Options:
603
- #
604
- # * +:table_name+ - *required* - (String) The name of the table in which
605
- # you want to scan. Allowed characters are a-z, A-Z, 0-9, _
606
- # (underscore), - (hyphen) and . (period).
607
- # * +:attributes_to_get+ - (Array<String>)
608
- # * +:limit+ - (Integer) The maximum number of items to return. If Amazon
609
- # DynamoDB hits this limit while scanning the table, it stops the scan
610
- # and returns the matching values up to the limit, and a
611
- # LastEvaluatedKey to apply in a subsequent operation to continue the
612
- # scan. Also, if the scanned data set size exceeds 1MB before Amazon
613
- # DynamoDB hits this limit, it stops the scan and returns the matching
614
- # values up to the limit, and a LastEvaluatedKey to apply in a
615
- # subsequent operation to continue the scan.
616
- # * +:count+ - (Boolean) If set to +true+ , Amazon DynamoDB returns a
617
- # total number of items for the Scan operation, even if the operation
618
- # has no matching items for the assigned filter. Do not set Count to
619
- # +true+ while providing a list of AttributesToGet, otherwise Amazon
620
- # DynamoDB returns a validation error.
621
- # * +:scan_filter+ - (Hash<String,Hash>) Evaluates the scan results and
622
- # returns only the desired values.
623
- # * +:attribute_value_list+ - (Array<Hash>)
624
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
625
- # The maximum size is limited by the size of the primary key (1024
626
- # bytes as a range part of a key or 2048 bytes as a single part
627
- # hash key) or the item size (64k).
628
- # * +:n+ - (String) Numbers are positive or negative exact-value
629
- # decimals and integers. A number can have up to 38 digits
630
- # precision and can be between 10^-128 to 10^+126.
631
- # * +:ss+ - (Array<String>) A set of strings.
632
- # * +:ns+ - (Array<String>) A set of numbers.
633
- # * +:comparison_operator+ - *required* - (String)
634
- # * +:exclusive_start_key+ - (Hash) Primary key of the item from which to
635
- # continue an earlier scan. An earlier scan might provide this value if
636
- # that scan operation was interrupted before scanning the entire table;
637
- # either because of the result set size or the Limit parameter. The
638
- # LastEvaluatedKey can be passed back in a new scan request to continue
639
- # the operation from that point.
640
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
641
- # treated as the primary key, and can be a string or a number. Single
642
- # attribute primary keys have one index value. The value can be
643
- # String, Number, StringSet, NumberSet.
644
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
645
- # The maximum size is limited by the size of the primary key (1024
646
- # bytes as a range part of a key or 2048 bytes as a single part
647
- # hash key) or the item size (64k).
648
- # * +:n+ - (String) Numbers are positive or negative exact-value
649
- # decimals and integers. A number can have up to 38 digits
650
- # precision and can be between 10^-128 to 10^+126.
651
- # * +:ss+ - (Array<String>) A set of strings.
652
- # * +:ns+ - (Array<String>) A set of numbers.
653
- # * +:range_key_element+ - (Hash) A range key element is treated as a
654
- # secondary key (used in conjunction with the primary key), and can
655
- # be a string or a number, and is only used for hash-and-range
656
- # primary keys. The value can be String, Number, StringSet,
657
- # NumberSet.
658
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
659
- # The maximum size is limited by the size of the primary key (1024
660
- # bytes as a range part of a key or 2048 bytes as a single part
661
- # hash key) or the item size (64k).
662
- # * +:n+ - (String) Numbers are positive or negative exact-value
663
- # decimals and integers. A number can have up to 38 digits
664
- # precision and can be between 10^-128 to 10^+126.
665
- # * +:ss+ - (Array<String>) A set of strings.
666
- # * +:ns+ - (Array<String>) A set of numbers.
667
- #
668
- # === Response Structure:
669
- #
670
- # * +member+ - (Hash<String,Hash>)
671
- # * +S+ - (String)
672
- # * +N+ - (String)
673
- # * +SS+ - (Array<String>)
674
- # * +NS+ - (Array<String>)
675
- # * +Count+ - (Integer)
676
- # * +ScannedCount+ - (Integer)
677
- # * +LastEvaluatedKey+ - (Hash)
678
- # * +HashKeyElement+ - (Hash)
679
- # * +S+ - (String)
680
- # * +N+ - (String)
681
- # * +SS+ - (Array<String>)
682
- # * +NS+ - (Array<String>)
683
- # * +RangeKeyElement+ - (Hash)
553
+ # @param [Hash] options
554
+ # * +:table_name+ - *required* - (String) The name of the table in
555
+ # which you want to scan. Allowed characters are a-z, A-Z, 0-9, _
556
+ # (underscore), - (hyphen) and . (period).
557
+ # * +:attributes_to_get+ - (Array<String>)
558
+ # * +:limit+ - (Integer) The maximum number of items to return. If
559
+ # Amazon DynamoDB hits this limit while scanning the table, it stops
560
+ # the scan and returns the matching values up to the limit, and a
561
+ # LastEvaluatedKey to apply in a subsequent operation to continue the
562
+ # scan. Also, if the scanned data set size exceeds 1MB before Amazon
563
+ # DynamoDB hits this limit, it stops the scan and returns the
564
+ # matching values up to the limit, and a LastEvaluatedKey to apply in
565
+ # a subsequent operation to continue the scan.
566
+ # * +:count+ - (Boolean) If set to +true+ , Amazon DynamoDB returns a
567
+ # total number of items for the Scan operation, even if the operation
568
+ # has no matching items for the assigned filter. Do not set Count to
569
+ # +true+ while providing a list of AttributesToGet, otherwise Amazon
570
+ # DynamoDB returns a validation error.
571
+ # * +:scan_filter+ - (Hash<String,Hash>) Evaluates the scan results and
572
+ # returns only the desired values.
573
+ # * +:attribute_value_list+ - (Array<Hash>)
574
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
575
+ # The maximum size is limited by the size of the primary key
576
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
577
+ # part hash key) or the item size (64k).
578
+ # * +:n+ - (String) Numbers are positive or negative exact-value
579
+ # decimals and integers. A number can have up to 38 digits
580
+ # precision and can be between 10^-128 to 10^+126.
581
+ # * +:ss+ - (Array<String>) A set of strings.
582
+ # * +:ns+ - (Array<String>) A set of numbers.
583
+ # * +:comparison_operator+ - *required* - (String)
584
+ # * +:exclusive_start_key+ - (Hash) Primary key of the item from which
585
+ # to continue an earlier scan. An earlier scan might provide this
586
+ # value if that scan operation was interrupted before scanning the
587
+ # entire table; either because of the result set size or the Limit
588
+ # parameter. The LastEvaluatedKey can be passed back in a new scan
589
+ # request to continue the operation from that point.
590
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element is
591
+ # treated as the primary key, and can be a string or a number.
592
+ # Single attribute primary keys have one index value. The value can
593
+ # be String, Number, StringSet, NumberSet.
594
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
595
+ # The maximum size is limited by the size of the primary key
596
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
597
+ # part hash key) or the item size (64k).
598
+ # * +:n+ - (String) Numbers are positive or negative exact-value
599
+ # decimals and integers. A number can have up to 38 digits
600
+ # precision and can be between 10^-128 to 10^+126.
601
+ # * +:ss+ - (Array<String>) A set of strings.
602
+ # * +:ns+ - (Array<String>) A set of numbers.
603
+ # * +:range_key_element+ - (Hash) A range key element is treated as a
604
+ # secondary key (used in conjunction with the primary key), and can
605
+ # be a string or a number, and is only used for hash-and-range
606
+ # primary keys. The value can be String, Number, StringSet,
607
+ # NumberSet.
608
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
609
+ # The maximum size is limited by the size of the primary key
610
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
611
+ # part hash key) or the item size (64k).
612
+ # * +:n+ - (String) Numbers are positive or negative exact-value
613
+ # decimals and integers. A number can have up to 38 digits
614
+ # precision and can be between 10^-128 to 10^+126.
615
+ # * +:ss+ - (Array<String>) A set of strings.
616
+ # * +:ns+ - (Array<String>) A set of numbers.
617
+ # @return [Core::Response]
618
+ # The #data method of the response object returns
619
+ # a hash with the following structure:
620
+ # * +member+ - (Hash<String,Hash>)
684
621
  # * +S+ - (String)
685
622
  # * +N+ - (String)
686
623
  # * +SS+ - (Array<String>)
687
624
  # * +NS+ - (Array<String>)
688
- # * +ConsumedCapacityUnits+ - (Numeric)
689
- #
690
- # @return [Core::Response]
691
- #
625
+ # * +Count+ - (Integer)
626
+ # * +ScannedCount+ - (Integer)
627
+ # * +LastEvaluatedKey+ - (Hash)
628
+ # * +HashKeyElement+ - (Hash)
629
+ # * +S+ - (String)
630
+ # * +N+ - (String)
631
+ # * +SS+ - (Array<String>)
632
+ # * +NS+ - (Array<String>)
633
+ # * +RangeKeyElement+ - (Hash)
634
+ # * +S+ - (String)
635
+ # * +N+ - (String)
636
+ # * +SS+ - (Array<String>)
637
+ # * +NS+ - (Array<String>)
638
+ # * +ConsumedCapacityUnits+ - (Numeric)
692
639
  define_client_method :scan, 'Scan'
693
640
 
694
641
  # Calls the UpdateItem API operation.
695
642
  # @method update_item(options = {})
696
- #
697
- # === Options:
698
- #
699
- # * +:table_name+ - *required* - (String) The name of the table in which
700
- # you want to update an item. Allowed characters are a-z, A-Z, 0-9, _
701
- # (underscore), - (hyphen) and . (period).
702
- # * +:key+ - *required* - (Hash)
703
- # * +:hash_key_element+ - *required* - (Hash) A hash key element is
704
- # treated as the primary key, and can be a string or a number. Single
705
- # attribute primary keys have one index value. The value can be
706
- # String, Number, StringSet, NumberSet.
707
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
708
- # The maximum size is limited by the size of the primary key (1024
709
- # bytes as a range part of a key or 2048 bytes as a single part
710
- # hash key) or the item size (64k).
711
- # * +:n+ - (String) Numbers are positive or negative exact-value
712
- # decimals and integers. A number can have up to 38 digits
713
- # precision and can be between 10^-128 to 10^+126.
714
- # * +:ss+ - (Array<String>) A set of strings.
715
- # * +:ns+ - (Array<String>) A set of numbers.
716
- # * +:range_key_element+ - (Hash) A range key element is treated as a
717
- # secondary key (used in conjunction with the primary key), and can
718
- # be a string or a number, and is only used for hash-and-range
719
- # primary keys. The value can be String, Number, StringSet,
720
- # NumberSet.
721
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
722
- # The maximum size is limited by the size of the primary key (1024
723
- # bytes as a range part of a key or 2048 bytes as a single part
724
- # hash key) or the item size (64k).
725
- # * +:n+ - (String) Numbers are positive or negative exact-value
726
- # decimals and integers. A number can have up to 38 digits
727
- # precision and can be between 10^-128 to 10^+126.
728
- # * +:ss+ - (Array<String>) A set of strings.
729
- # * +:ns+ - (Array<String>) A set of numbers.
730
- # * +:attribute_updates+ - *required* - (Hash<String,Hash>)
731
- # * +:value+ - (Hash)
732
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
733
- # The maximum size is limited by the size of the primary key (1024
734
- # bytes as a range part of a key or 2048 bytes as a single part
735
- # hash key) or the item size (64k).
736
- # * +:n+ - (String) Numbers are positive or negative exact-value
737
- # decimals and integers. A number can have up to 38 digits
738
- # precision and can be between 10^-128 to 10^+126.
739
- # * +:ss+ - (Array<String>) A set of strings.
740
- # * +:ns+ - (Array<String>) A set of numbers.
741
- # * +:action+ - (String)
742
- # * +:expected+ - (Hash<String,Hash>)
743
- # * +:value+ - (Hash) Specify whether or not a value already exists and
744
- # has a specific content for the attribute name-value pair.
745
- # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
746
- # The maximum size is limited by the size of the primary key (1024
747
- # bytes as a range part of a key or 2048 bytes as a single part
748
- # hash key) or the item size (64k).
749
- # * +:n+ - (String) Numbers are positive or negative exact-value
750
- # decimals and integers. A number can have up to 38 digits
751
- # precision and can be between 10^-128 to 10^+126.
752
- # * +:ss+ - (Array<String>) A set of strings.
753
- # * +:ns+ - (Array<String>) A set of numbers.
754
- # * +:exists+ - (Boolean) Specify whether or not a value already exists
755
- # for the attribute name-value pair.
756
- # * +:return_values+ - (String)
757
- #
758
- # === Response Structure:
759
- #
760
- # * +Attributes+ - (Hash<String,Hash>)
761
- # * +S+ - (String)
762
- # * +N+ - (String)
763
- # * +SS+ - (Array<String>)
764
- # * +NS+ - (Array<String>)
765
- # * +ConsumedCapacityUnits+ - (Numeric)
766
- #
643
+ # @param [Hash] options
644
+ # * +:table_name+ - *required* - (String) The name of the table in
645
+ # which you want to update an item. Allowed characters are a-z, A-Z,
646
+ # 0-9, _ (underscore), - (hyphen) and . (period).
647
+ # * +:key+ - *required* - (Hash)
648
+ # * +:hash_key_element+ - *required* - (Hash) A hash key element is
649
+ # treated as the primary key, and can be a string or a number.
650
+ # Single attribute primary keys have one index value. The value can
651
+ # be String, Number, StringSet, NumberSet.
652
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
653
+ # The maximum size is limited by the size of the primary key
654
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
655
+ # part hash key) or the item size (64k).
656
+ # * +:n+ - (String) Numbers are positive or negative exact-value
657
+ # decimals and integers. A number can have up to 38 digits
658
+ # precision and can be between 10^-128 to 10^+126.
659
+ # * +:ss+ - (Array<String>) A set of strings.
660
+ # * +:ns+ - (Array<String>) A set of numbers.
661
+ # * +:range_key_element+ - (Hash) A range key element is treated as a
662
+ # secondary key (used in conjunction with the primary key), and can
663
+ # be a string or a number, and is only used for hash-and-range
664
+ # primary keys. The value can be String, Number, StringSet,
665
+ # NumberSet.
666
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
667
+ # The maximum size is limited by the size of the primary key
668
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
669
+ # part hash key) or the item size (64k).
670
+ # * +:n+ - (String) Numbers are positive or negative exact-value
671
+ # decimals and integers. A number can have up to 38 digits
672
+ # precision and can be between 10^-128 to 10^+126.
673
+ # * +:ss+ - (Array<String>) A set of strings.
674
+ # * +:ns+ - (Array<String>) A set of numbers.
675
+ # * +:attribute_updates+ - *required* - (Hash<String,Hash>)
676
+ # * +:value+ - (Hash)
677
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
678
+ # The maximum size is limited by the size of the primary key
679
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
680
+ # part hash key) or the item size (64k).
681
+ # * +:n+ - (String) Numbers are positive or negative exact-value
682
+ # decimals and integers. A number can have up to 38 digits
683
+ # precision and can be between 10^-128 to 10^+126.
684
+ # * +:ss+ - (Array<String>) A set of strings.
685
+ # * +:ns+ - (Array<String>) A set of numbers.
686
+ # * +:action+ - (String)
687
+ # * +:expected+ - (Hash<String,Hash>)
688
+ # * +:value+ - (Hash) Specify whether or not a value already exists
689
+ # and has a specific content for the attribute name-value pair.
690
+ # * +:s+ - (String) Strings are Unicode with UTF-8 binary encoding.
691
+ # The maximum size is limited by the size of the primary key
692
+ # (1024 bytes as a range part of a key or 2048 bytes as a single
693
+ # part hash key) or the item size (64k).
694
+ # * +:n+ - (String) Numbers are positive or negative exact-value
695
+ # decimals and integers. A number can have up to 38 digits
696
+ # precision and can be between 10^-128 to 10^+126.
697
+ # * +:ss+ - (Array<String>) A set of strings.
698
+ # * +:ns+ - (Array<String>) A set of numbers.
699
+ # * +:exists+ - (Boolean) Specify whether or not a value already
700
+ # exists for the attribute name-value pair.
701
+ # * +:return_values+ - (String)
767
702
  # @return [Core::Response]
768
- #
703
+ # The #data method of the response object returns
704
+ # a hash with the following structure:
705
+ # * +Attributes+ - (Hash<String,Hash>)
706
+ # * +S+ - (String)
707
+ # * +N+ - (String)
708
+ # * +SS+ - (Array<String>)
709
+ # * +NS+ - (Array<String>)
710
+ # * +ConsumedCapacityUnits+ - (Numeric)
769
711
  define_client_method :update_item, 'UpdateItem'
770
712
 
771
713
  # Calls the UpdateTable API operation.
772
714
  # @method update_table(options = {})
773
- #
774
- # === Options:
775
- #
776
- # * +:table_name+ - *required* - (String) The name of the table you want
777
- # to update. Allowed characters are a-z, A-Z, 0-9, _ (underscore), -
778
- # (hyphen) and . (period).
779
- # * +:provisioned_throughput+ - *required* - (Hash)
780
- # * +:read_capacity_units+ - *required* - (Integer) ReadCapacityUnits
781
- # are in terms of strictly consistent reads, assuming items of 1k. 2k
782
- # items require twice the ReadCapacityUnits. Eventually-consistent
783
- # reads only require half the ReadCapacityUnits of stirctly
784
- # consistent reads.
785
- # * +:write_capacity_units+ - *required* - (Integer) WriteCapacityUnits
786
- # are in terms of strictly consistent reads, assuming items of 1k. 2k
787
- # items require twice the WriteCapacityUnits.
788
- #
789
- # === Response Structure:
790
- #
791
- # * +TableDescription+ - (Hash)
792
- # * +TableName+ - (String)
793
- # * +KeySchema+ - (Hash)
794
- # * +HashKeyElement+ - (Hash)
795
- # * +AttributeName+ - (String)
796
- # * +AttributeType+ - (String)
797
- # * +RangeKeyElement+ - (Hash)
798
- # * +AttributeName+ - (String)
799
- # * +AttributeType+ - (String)
800
- # * +TableStatus+ - (String)
801
- # * +CreationDateTime+ - (Time)
802
- # * +ProvisionedThroughput+ - (Hash)
803
- # * +LastIncreaseDateTime+ - (Time)
804
- # * +LastDecreaseDateTime+ - (Time)
805
- # * +ReadCapacityUnits+ - (Integer)
806
- # * +WriteCapacityUnits+ - (Integer)
807
- # * +TableSizeBytes+ - (Integer)
808
- # * +ItemCount+ - (Integer)
809
- #
715
+ # @param [Hash] options
716
+ # * +:table_name+ - *required* - (String) The name of the table you
717
+ # want to update. Allowed characters are a-z, A-Z, 0-9, _
718
+ # (underscore), - (hyphen) and . (period).
719
+ # * +:provisioned_throughput+ - *required* - (Hash)
720
+ # * +:read_capacity_units+ - *required* - (Integer) ReadCapacityUnits
721
+ # are in terms of strictly consistent reads, assuming items of 1k.
722
+ # 2k items require twice the ReadCapacityUnits.
723
+ # Eventually-consistent reads only require half the
724
+ # ReadCapacityUnits of stirctly consistent reads.
725
+ # * +:write_capacity_units+ - *required* - (Integer)
726
+ # WriteCapacityUnits are in terms of strictly consistent reads,
727
+ # assuming items of 1k. 2k items require twice the
728
+ # WriteCapacityUnits.
810
729
  # @return [Core::Response]
811
- #
730
+ # The #data method of the response object returns
731
+ # a hash with the following structure:
732
+ # * +TableDescription+ - (Hash)
733
+ # * +TableName+ - (String)
734
+ # * +KeySchema+ - (Hash)
735
+ # * +HashKeyElement+ - (Hash)
736
+ # * +AttributeName+ - (String)
737
+ # * +AttributeType+ - (String)
738
+ # * +RangeKeyElement+ - (Hash)
739
+ # * +AttributeName+ - (String)
740
+ # * +AttributeType+ - (String)
741
+ # * +TableStatus+ - (String)
742
+ # * +CreationDateTime+ - (Time)
743
+ # * +ProvisionedThroughput+ - (Hash)
744
+ # * +LastIncreaseDateTime+ - (Time)
745
+ # * +LastDecreaseDateTime+ - (Time)
746
+ # * +ReadCapacityUnits+ - (Integer)
747
+ # * +WriteCapacityUnits+ - (Integer)
748
+ # * +TableSizeBytes+ - (Integer)
749
+ # * +ItemCount+ - (Integer)
812
750
  define_client_method :update_table, 'UpdateTable'
813
751
 
814
752
  ## end client methods ##