aws-sdk-simpledb 1.0.0.rc1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,25 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module SimpleDB
10
+ class Resource
11
+
12
+ # @param options ({})
13
+ # @option options [Client] :client
14
+ def initialize(options = {})
15
+ @client = options[:client] || Client.new(options)
16
+ end
17
+
18
+ # @return [Client]
19
+ def client
20
+ @client
21
+ end
22
+
23
+ end
24
+ end
25
+ end
@@ -0,0 +1,530 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing for info on making contributions:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws
9
+ module SimpleDB
10
+ module Types
11
+
12
+ # @note When making an API call, pass Attribute
13
+ # data as a hash:
14
+ #
15
+ # {
16
+ # name: "String", # required
17
+ # alternate_name_encoding: "String",
18
+ # value: "String", # required
19
+ # alternate_value_encoding: "String",
20
+ # }
21
+ # @!attribute [rw] name
22
+ # The name of the attribute.
23
+ # @return [String]
24
+ #
25
+ # @!attribute [rw] alternate_name_encoding
26
+ # @return [String]
27
+ #
28
+ # @!attribute [rw] value
29
+ # The value of the attribute.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] alternate_value_encoding
33
+ # @return [String]
34
+ class Attribute < Struct.new(
35
+ :name,
36
+ :alternate_name_encoding,
37
+ :value,
38
+ :alternate_value_encoding)
39
+ include Aws::Structure
40
+ end
41
+
42
+ # @note When making an API call, pass BatchDeleteAttributesRequest
43
+ # data as a hash:
44
+ #
45
+ # {
46
+ # domain_name: "String", # required
47
+ # items: [ # required
48
+ # {
49
+ # name: "String", # required
50
+ # attributes: [
51
+ # {
52
+ # name: "String", # required
53
+ # alternate_name_encoding: "String",
54
+ # value: "String", # required
55
+ # alternate_value_encoding: "String",
56
+ # },
57
+ # ],
58
+ # },
59
+ # ],
60
+ # }
61
+ # @!attribute [rw] domain_name
62
+ # The name of the domain in which the attributes are being deleted.
63
+ # @return [String]
64
+ #
65
+ # @!attribute [rw] items
66
+ # A list of items on which to perform the operation.
67
+ # @return [Array<Types::DeletableItem>]
68
+ class BatchDeleteAttributesRequest < Struct.new(
69
+ :domain_name,
70
+ :items)
71
+ include Aws::Structure
72
+ end
73
+
74
+ # @note When making an API call, pass BatchPutAttributesRequest
75
+ # data as a hash:
76
+ #
77
+ # {
78
+ # domain_name: "String", # required
79
+ # items: [ # required
80
+ # {
81
+ # name: "String", # required
82
+ # attributes: [ # required
83
+ # {
84
+ # name: "String", # required
85
+ # value: "String", # required
86
+ # replace: false,
87
+ # },
88
+ # ],
89
+ # },
90
+ # ],
91
+ # }
92
+ # @!attribute [rw] domain_name
93
+ # The name of the domain in which the attributes are being stored.
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] items
97
+ # A list of items on which to perform the operation.
98
+ # @return [Array<Types::ReplaceableItem>]
99
+ class BatchPutAttributesRequest < Struct.new(
100
+ :domain_name,
101
+ :items)
102
+ include Aws::Structure
103
+ end
104
+
105
+ # @note When making an API call, pass CreateDomainRequest
106
+ # data as a hash:
107
+ #
108
+ # {
109
+ # domain_name: "String", # required
110
+ # }
111
+ # @!attribute [rw] domain_name
112
+ # The name of the domain to create. The name can range between 3 and
113
+ # 255 characters and can contain the following characters: a-z, A-Z,
114
+ # 0-9, '\_', '-', and '.'.
115
+ # @return [String]
116
+ class CreateDomainRequest < Struct.new(
117
+ :domain_name)
118
+ include Aws::Structure
119
+ end
120
+
121
+ # @note When making an API call, pass DeletableItem
122
+ # data as a hash:
123
+ #
124
+ # {
125
+ # name: "String", # required
126
+ # attributes: [
127
+ # {
128
+ # name: "String", # required
129
+ # alternate_name_encoding: "String",
130
+ # value: "String", # required
131
+ # alternate_value_encoding: "String",
132
+ # },
133
+ # ],
134
+ # }
135
+ # @!attribute [rw] name
136
+ # @return [String]
137
+ #
138
+ # @!attribute [rw] attributes
139
+ # @return [Array<Types::Attribute>]
140
+ class DeletableItem < Struct.new(
141
+ :name,
142
+ :attributes)
143
+ include Aws::Structure
144
+ end
145
+
146
+ # @note When making an API call, pass DeleteAttributesRequest
147
+ # data as a hash:
148
+ #
149
+ # {
150
+ # domain_name: "String", # required
151
+ # item_name: "String", # required
152
+ # attributes: [
153
+ # {
154
+ # name: "String", # required
155
+ # alternate_name_encoding: "String",
156
+ # value: "String", # required
157
+ # alternate_value_encoding: "String",
158
+ # },
159
+ # ],
160
+ # expected: {
161
+ # name: "String",
162
+ # value: "String",
163
+ # exists: false,
164
+ # },
165
+ # }
166
+ # @!attribute [rw] domain_name
167
+ # The name of the domain in which to perform the operation.
168
+ # @return [String]
169
+ #
170
+ # @!attribute [rw] item_name
171
+ # The name of the item. Similar to rows on a spreadsheet, items
172
+ # represent individual objects that contain one or more
173
+ # value-attribute pairs.
174
+ # @return [String]
175
+ #
176
+ # @!attribute [rw] attributes
177
+ # A list of Attributes. Similar to columns on a spreadsheet,
178
+ # attributes represent categories of data that can be assigned to
179
+ # items.
180
+ # @return [Array<Types::Attribute>]
181
+ #
182
+ # @!attribute [rw] expected
183
+ # The update condition which, if specified, determines whether the
184
+ # specified attributes will be deleted or not. The update condition
185
+ # must be satisfied in order for this request to be processed and the
186
+ # attributes to be deleted.
187
+ # @return [Types::UpdateCondition]
188
+ class DeleteAttributesRequest < Struct.new(
189
+ :domain_name,
190
+ :item_name,
191
+ :attributes,
192
+ :expected)
193
+ include Aws::Structure
194
+ end
195
+
196
+ # @note When making an API call, pass DeleteDomainRequest
197
+ # data as a hash:
198
+ #
199
+ # {
200
+ # domain_name: "String", # required
201
+ # }
202
+ # @!attribute [rw] domain_name
203
+ # The name of the domain to delete.
204
+ # @return [String]
205
+ class DeleteDomainRequest < Struct.new(
206
+ :domain_name)
207
+ include Aws::Structure
208
+ end
209
+
210
+ # @note When making an API call, pass DomainMetadataRequest
211
+ # data as a hash:
212
+ #
213
+ # {
214
+ # domain_name: "String", # required
215
+ # }
216
+ # @!attribute [rw] domain_name
217
+ # The name of the domain for which to display the metadata of.
218
+ # @return [String]
219
+ class DomainMetadataRequest < Struct.new(
220
+ :domain_name)
221
+ include Aws::Structure
222
+ end
223
+
224
+ # @!attribute [rw] item_count
225
+ # The number of all items in the domain.
226
+ # @return [Integer]
227
+ #
228
+ # @!attribute [rw] item_names_size_bytes
229
+ # The total size of all item names in the domain, in bytes.
230
+ # @return [Integer]
231
+ #
232
+ # @!attribute [rw] attribute_name_count
233
+ # The number of unique attribute names in the domain.
234
+ # @return [Integer]
235
+ #
236
+ # @!attribute [rw] attribute_names_size_bytes
237
+ # The total size of all unique attribute names in the domain, in
238
+ # bytes.
239
+ # @return [Integer]
240
+ #
241
+ # @!attribute [rw] attribute_value_count
242
+ # The number of all attribute name/value pairs in the domain.
243
+ # @return [Integer]
244
+ #
245
+ # @!attribute [rw] attribute_values_size_bytes
246
+ # The total size of all attribute values in the domain, in bytes.
247
+ # @return [Integer]
248
+ #
249
+ # @!attribute [rw] timestamp
250
+ # The data and time when metadata was calculated, in Epoch (UNIX)
251
+ # seconds.
252
+ # @return [Integer]
253
+ class DomainMetadataResult < Struct.new(
254
+ :item_count,
255
+ :item_names_size_bytes,
256
+ :attribute_name_count,
257
+ :attribute_names_size_bytes,
258
+ :attribute_value_count,
259
+ :attribute_values_size_bytes,
260
+ :timestamp)
261
+ include Aws::Structure
262
+ end
263
+
264
+ # @note When making an API call, pass GetAttributesRequest
265
+ # data as a hash:
266
+ #
267
+ # {
268
+ # domain_name: "String", # required
269
+ # item_name: "String", # required
270
+ # attribute_names: ["String"],
271
+ # consistent_read: false,
272
+ # }
273
+ # @!attribute [rw] domain_name
274
+ # The name of the domain in which to perform the operation.
275
+ # @return [String]
276
+ #
277
+ # @!attribute [rw] item_name
278
+ # The name of the item.
279
+ # @return [String]
280
+ #
281
+ # @!attribute [rw] attribute_names
282
+ # The names of the attributes.
283
+ # @return [Array<String>]
284
+ #
285
+ # @!attribute [rw] consistent_read
286
+ # Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If `true`, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.
287
+ # @return [Boolean]
288
+ class GetAttributesRequest < Struct.new(
289
+ :domain_name,
290
+ :item_name,
291
+ :attribute_names,
292
+ :consistent_read)
293
+ include Aws::Structure
294
+ end
295
+
296
+ # @!attribute [rw] attributes
297
+ # The list of attributes returned by the operation.
298
+ # @return [Array<Types::Attribute>]
299
+ class GetAttributesResult < Struct.new(
300
+ :attributes)
301
+ include Aws::Structure
302
+ end
303
+
304
+ # @!attribute [rw] name
305
+ # The name of the item.
306
+ # @return [String]
307
+ #
308
+ # @!attribute [rw] alternate_name_encoding
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] attributes
312
+ # A list of attributes.
313
+ # @return [Array<Types::Attribute>]
314
+ class Item < Struct.new(
315
+ :name,
316
+ :alternate_name_encoding,
317
+ :attributes)
318
+ include Aws::Structure
319
+ end
320
+
321
+ # @note When making an API call, pass ListDomainsRequest
322
+ # data as a hash:
323
+ #
324
+ # {
325
+ # max_number_of_domains: 1,
326
+ # next_token: "String",
327
+ # }
328
+ # @!attribute [rw] max_number_of_domains
329
+ # The maximum number of domain names you want returned. The range is 1
330
+ # to 100. The default setting is 100.
331
+ # @return [Integer]
332
+ #
333
+ # @!attribute [rw] next_token
334
+ # A string informing Amazon SimpleDB where to start the next list of
335
+ # domain names.
336
+ # @return [String]
337
+ class ListDomainsRequest < Struct.new(
338
+ :max_number_of_domains,
339
+ :next_token)
340
+ include Aws::Structure
341
+ end
342
+
343
+ # @!attribute [rw] domain_names
344
+ # A list of domain names that match the expression.
345
+ # @return [Array<String>]
346
+ #
347
+ # @!attribute [rw] next_token
348
+ # An opaque token indicating that there are more domains than the specified `MaxNumberOfDomains` still available.
349
+ # @return [String]
350
+ class ListDomainsResult < Struct.new(
351
+ :domain_names,
352
+ :next_token)
353
+ include Aws::Structure
354
+ end
355
+
356
+ # @note When making an API call, pass PutAttributesRequest
357
+ # data as a hash:
358
+ #
359
+ # {
360
+ # domain_name: "String", # required
361
+ # item_name: "String", # required
362
+ # attributes: [ # required
363
+ # {
364
+ # name: "String", # required
365
+ # value: "String", # required
366
+ # replace: false,
367
+ # },
368
+ # ],
369
+ # expected: {
370
+ # name: "String",
371
+ # value: "String",
372
+ # exists: false,
373
+ # },
374
+ # }
375
+ # @!attribute [rw] domain_name
376
+ # The name of the domain in which to perform the operation.
377
+ # @return [String]
378
+ #
379
+ # @!attribute [rw] item_name
380
+ # The name of the item.
381
+ # @return [String]
382
+ #
383
+ # @!attribute [rw] attributes
384
+ # The list of attributes.
385
+ # @return [Array<Types::ReplaceableAttribute>]
386
+ #
387
+ # @!attribute [rw] expected
388
+ # The update condition which, if specified, determines whether the
389
+ # specified attributes will be updated or not. The update condition
390
+ # must be satisfied in order for this request to be processed and the
391
+ # attributes to be updated.
392
+ # @return [Types::UpdateCondition]
393
+ class PutAttributesRequest < Struct.new(
394
+ :domain_name,
395
+ :item_name,
396
+ :attributes,
397
+ :expected)
398
+ include Aws::Structure
399
+ end
400
+
401
+ # @note When making an API call, pass ReplaceableAttribute
402
+ # data as a hash:
403
+ #
404
+ # {
405
+ # name: "String", # required
406
+ # value: "String", # required
407
+ # replace: false,
408
+ # }
409
+ # @!attribute [rw] name
410
+ # The name of the replaceable attribute.
411
+ # @return [String]
412
+ #
413
+ # @!attribute [rw] value
414
+ # The value of the replaceable attribute.
415
+ # @return [String]
416
+ #
417
+ # @!attribute [rw] replace
418
+ # A flag specifying whether or not to replace the attribute/value pair or to add a new attribute/value pair. The default setting is `false`.
419
+ # @return [Boolean]
420
+ class ReplaceableAttribute < Struct.new(
421
+ :name,
422
+ :value,
423
+ :replace)
424
+ include Aws::Structure
425
+ end
426
+
427
+ # @note When making an API call, pass ReplaceableItem
428
+ # data as a hash:
429
+ #
430
+ # {
431
+ # name: "String", # required
432
+ # attributes: [ # required
433
+ # {
434
+ # name: "String", # required
435
+ # value: "String", # required
436
+ # replace: false,
437
+ # },
438
+ # ],
439
+ # }
440
+ # @!attribute [rw] name
441
+ # The name of the replaceable item.
442
+ # @return [String]
443
+ #
444
+ # @!attribute [rw] attributes
445
+ # The list of attributes for a replaceable item.
446
+ # @return [Array<Types::ReplaceableAttribute>]
447
+ class ReplaceableItem < Struct.new(
448
+ :name,
449
+ :attributes)
450
+ include Aws::Structure
451
+ end
452
+
453
+ # @note When making an API call, pass SelectRequest
454
+ # data as a hash:
455
+ #
456
+ # {
457
+ # select_expression: "String", # required
458
+ # next_token: "String",
459
+ # consistent_read: false,
460
+ # }
461
+ # @!attribute [rw] select_expression
462
+ # The expression used to query the domain.
463
+ # @return [String]
464
+ #
465
+ # @!attribute [rw] next_token
466
+ # A string informing Amazon SimpleDB where to start the next list of `ItemNames`.
467
+ # @return [String]
468
+ #
469
+ # @!attribute [rw] consistent_read
470
+ # Determines whether or not strong consistency should be enforced when data is read from SimpleDB. If `true`, any data previously written to SimpleDB will be returned. Otherwise, results will be consistent eventually, and the client may not see data that was written immediately before your read.
471
+ # @return [Boolean]
472
+ class SelectRequest < Struct.new(
473
+ :select_expression,
474
+ :next_token,
475
+ :consistent_read)
476
+ include Aws::Structure
477
+ end
478
+
479
+ # @!attribute [rw] items
480
+ # A list of items that match the select expression.
481
+ # @return [Array<Types::Item>]
482
+ #
483
+ # @!attribute [rw] next_token
484
+ # An opaque token indicating that more items than `MaxNumberOfItems` were matched, the response size exceeded 1 megabyte, or the execution time exceeded 5 seconds.
485
+ # @return [String]
486
+ class SelectResult < Struct.new(
487
+ :items,
488
+ :next_token)
489
+ include Aws::Structure
490
+ end
491
+
492
+ # Specifies the conditions under which data should be updated. If an
493
+ # update condition is specified for a request, the data will only be
494
+ # updated if the condition is satisfied. For example, if an attribute
495
+ # with a specific name and value exists, or if a specific attribute
496
+ # doesn't exist.
497
+ # @note When making an API call, pass UpdateCondition
498
+ # data as a hash:
499
+ #
500
+ # {
501
+ # name: "String",
502
+ # value: "String",
503
+ # exists: false,
504
+ # }
505
+ # @!attribute [rw] name
506
+ # The name of the attribute involved in the condition.
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] value
510
+ # The value of an attribute. This value can only be specified when the
511
+ # `Exists` parameter is equal to `true`.
512
+ # @return [String]
513
+ #
514
+ # @!attribute [rw] exists
515
+ # A value specifying whether or not the specified attribute must exist
516
+ # with the specified value in order for the update condition to be
517
+ # satisfied. Specify `true` if the attribute must exist for the update
518
+ # condition to be satisfied. Specify `false` if the attribute should
519
+ # not exist in order for the update condition to be satisfied.
520
+ # @return [Boolean]
521
+ class UpdateCondition < Struct.new(
522
+ :name,
523
+ :value,
524
+ :exists)
525
+ include Aws::Structure
526
+ end
527
+
528
+ end
529
+ end
530
+ end