aws-sdk 1.11.2 → 1.11.3

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.
@@ -486,8 +486,8 @@ module AWS
486
486
  #
487
487
  # You can also set an optional delay for all of the messages:
488
488
  #
489
- # # delay all messages 1 hour
490
- # queue.batch_send(msg1, msg2, :delay_seconds => 3600)
489
+ # # delay all messages 15 minutes
490
+ # queue.batch_send(msg1, msg2, :delay_seconds => 900)
491
491
  #
492
492
  # If you need to set a custom delay for each message you can pass
493
493
  # hashes:
@@ -25,6 +25,7 @@ module AWS
25
25
  # @!method activate_gateway(options = {})
26
26
  # Calls the ActivateGateway API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:activation_key` - *required* - (String)
29
30
  # * `:gateway_name` - *required* - (String)
30
31
  # * `:gateway_timezone` - *required* - (String) Valid values include:
@@ -72,6 +73,7 @@ module AWS
72
73
  # @!method add_cache(options = {})
73
74
  # Calls the AddCache API operation.
74
75
  # @param [Hash] options
76
+ #
75
77
  # * `:gateway_arn` - *required* - (String)
76
78
  # * `:disk_ids` - *required* - (Array<String>)
77
79
  # @return [Core::Response]
@@ -83,6 +85,7 @@ module AWS
83
85
  # @!method add_upload_buffer(options = {})
84
86
  # Calls the AddUploadBuffer API operation.
85
87
  # @param [Hash] options
88
+ #
86
89
  # * `:gateway_arn` - *required* - (String)
87
90
  # * `:disk_ids` - *required* - (Array<String>)
88
91
  # @return [Core::Response]
@@ -94,6 +97,7 @@ module AWS
94
97
  # @!method add_working_storage(options = {})
95
98
  # Calls the AddWorkingStorage API operation.
96
99
  # @param [Hash] options
100
+ #
97
101
  # * `:gateway_arn` - *required* - (String)
98
102
  # * `:disk_ids` - *required* - (Array<String>)
99
103
  # @return [Core::Response]
@@ -105,6 +109,7 @@ module AWS
105
109
  # @!method create_cachedi_scsi_volume(options = {})
106
110
  # Calls the CreateCachediSCSIVolume API operation.
107
111
  # @param [Hash] options
112
+ #
108
113
  # * `:gateway_arn` - *required* - (String)
109
114
  # * `:volume_size_in_bytes` - *required* - (Integer)
110
115
  # * `:snapshot_id` - (String)
@@ -121,6 +126,7 @@ module AWS
121
126
  # @!method create_snapshot(options = {})
122
127
  # Calls the CreateSnapshot API operation.
123
128
  # @param [Hash] options
129
+ #
124
130
  # * `:volume_arn` - *required* - (String)
125
131
  # * `:snapshot_description` - *required* - (String)
126
132
  # @return [Core::Response]
@@ -133,6 +139,7 @@ module AWS
133
139
  # @!method create_snapshot_from_volume_recovery_point(options = {})
134
140
  # Calls the CreateSnapshotFromVolumeRecoveryPoint API operation.
135
141
  # @param [Hash] options
142
+ #
136
143
  # * `:volume_arn` - *required* - (String)
137
144
  # * `:snapshot_description` - *required* - (String)
138
145
  # @return [Core::Response]
@@ -146,6 +153,7 @@ module AWS
146
153
  # @!method create_storedi_scsi_volume(options = {})
147
154
  # Calls the CreateStorediSCSIVolume API operation.
148
155
  # @param [Hash] options
156
+ #
149
157
  # * `:gateway_arn` - *required* - (String)
150
158
  # * `:disk_id` - *required* - (String)
151
159
  # * `:snapshot_id` - (String)
@@ -163,6 +171,7 @@ module AWS
163
171
  # @!method delete_bandwidth_rate_limit(options = {})
164
172
  # Calls the DeleteBandwidthRateLimit API operation.
165
173
  # @param [Hash] options
174
+ #
166
175
  # * `:gateway_arn` - *required* - (String)
167
176
  # * `:bandwidth_type` - *required* - (String) Valid values include:
168
177
  # * `UPLOAD`
@@ -177,6 +186,7 @@ module AWS
177
186
  # @!method delete_chap_credentials(options = {})
178
187
  # Calls the DeleteChapCredentials API operation.
179
188
  # @param [Hash] options
189
+ #
180
190
  # * `:target_arn` - *required* - (String)
181
191
  # * `:initiator_name` - *required* - (String)
182
192
  # @return [Core::Response]
@@ -189,6 +199,7 @@ module AWS
189
199
  # @!method delete_gateway(options = {})
190
200
  # Calls the DeleteGateway API operation.
191
201
  # @param [Hash] options
202
+ #
192
203
  # * `:gateway_arn` - *required* - (String)
193
204
  # @return [Core::Response]
194
205
  # The #data method of the response object returns
@@ -199,6 +210,7 @@ module AWS
199
210
  # @!method delete_snapshot_schedule(options = {})
200
211
  # Calls the DeleteSnapshotSchedule API operation.
201
212
  # @param [Hash] options
213
+ #
202
214
  # * `:volume_arn` - *required* - (String)
203
215
  # @return [Core::Response]
204
216
  # The #data method of the response object returns
@@ -209,6 +221,7 @@ module AWS
209
221
  # @!method delete_volume(options = {})
210
222
  # Calls the DeleteVolume API operation.
211
223
  # @param [Hash] options
224
+ #
212
225
  # * `:volume_arn` - *required* - (String)
213
226
  # @return [Core::Response]
214
227
  # The #data method of the response object returns
@@ -219,6 +232,7 @@ module AWS
219
232
  # @!method describe_bandwidth_rate_limit(options = {})
220
233
  # Calls the DescribeBandwidthRateLimit API operation.
221
234
  # @param [Hash] options
235
+ #
222
236
  # * `:gateway_arn` - *required* - (String)
223
237
  # @return [Core::Response]
224
238
  # The #data method of the response object returns
@@ -231,6 +245,7 @@ module AWS
231
245
  # @!method describe_cache(options = {})
232
246
  # Calls the DescribeCache API operation.
233
247
  # @param [Hash] options
248
+ #
234
249
  # * `:gateway_arn` - *required* - (String)
235
250
  # @return [Core::Response]
236
251
  # The #data method of the response object returns
@@ -247,6 +262,7 @@ module AWS
247
262
  # @!method describe_cachedi_scsi_volumes(options = {})
248
263
  # Calls the DescribeCachediSCSIVolumes API operation.
249
264
  # @param [Hash] options
265
+ #
250
266
  # * `:volume_ar_ns` - *required* - (Array<String>)
251
267
  # @return [Core::Response]
252
268
  # The #data method of the response object returns
@@ -270,6 +286,7 @@ module AWS
270
286
  # @!method describe_chap_credentials(options = {})
271
287
  # Calls the DescribeChapCredentials API operation.
272
288
  # @param [Hash] options
289
+ #
273
290
  # * `:target_arn` - *required* - (String)
274
291
  # @return [Core::Response]
275
292
  # The #data method of the response object returns
@@ -284,6 +301,7 @@ module AWS
284
301
  # @!method describe_gateway_information(options = {})
285
302
  # Calls the DescribeGatewayInformation API operation.
286
303
  # @param [Hash] options
304
+ #
287
305
  # * `:gateway_arn` - *required* - (String)
288
306
  # @return [Core::Response]
289
307
  # The #data method of the response object returns
@@ -303,6 +321,7 @@ module AWS
303
321
  # @!method describe_maintenance_start_time(options = {})
304
322
  # Calls the DescribeMaintenanceStartTime API operation.
305
323
  # @param [Hash] options
324
+ #
306
325
  # * `:gateway_arn` - *required* - (String)
307
326
  # @return [Core::Response]
308
327
  # The #data method of the response object returns
@@ -317,6 +336,7 @@ module AWS
317
336
  # @!method describe_snapshot_schedule(options = {})
318
337
  # Calls the DescribeSnapshotSchedule API operation.
319
338
  # @param [Hash] options
339
+ #
320
340
  # * `:volume_arn` - *required* - (String)
321
341
  # @return [Core::Response]
322
342
  # The #data method of the response object returns
@@ -331,6 +351,7 @@ module AWS
331
351
  # @!method describe_storedi_scsi_volumes(options = {})
332
352
  # Calls the DescribeStorediSCSIVolumes API operation.
333
353
  # @param [Hash] options
354
+ #
334
355
  # * `:volume_ar_ns` - *required* - (Array<String>)
335
356
  # @return [Core::Response]
336
357
  # The #data method of the response object returns
@@ -356,6 +377,7 @@ module AWS
356
377
  # @!method describe_upload_buffer(options = {})
357
378
  # Calls the DescribeUploadBuffer API operation.
358
379
  # @param [Hash] options
380
+ #
359
381
  # * `:gateway_arn` - *required* - (String)
360
382
  # @return [Core::Response]
361
383
  # The #data method of the response object returns
@@ -369,6 +391,7 @@ module AWS
369
391
  # @!method describe_working_storage(options = {})
370
392
  # Calls the DescribeWorkingStorage API operation.
371
393
  # @param [Hash] options
394
+ #
372
395
  # * `:gateway_arn` - *required* - (String)
373
396
  # @return [Core::Response]
374
397
  # The #data method of the response object returns
@@ -382,6 +405,7 @@ module AWS
382
405
  # @!method list_gateways(options = {})
383
406
  # Calls the ListGateways API operation.
384
407
  # @param [Hash] options
408
+ #
385
409
  # * `:marker` - (String)
386
410
  # * `:limit` - (Integer)
387
411
  # @return [Core::Response]
@@ -395,6 +419,7 @@ module AWS
395
419
  # @!method list_local_disks(options = {})
396
420
  # Calls the ListLocalDisks API operation.
397
421
  # @param [Hash] options
422
+ #
398
423
  # * `:gateway_arn` - *required* - (String)
399
424
  # @return [Core::Response]
400
425
  # The #data method of the response object returns
@@ -412,6 +437,7 @@ module AWS
412
437
  # @!method list_volume_recovery_points(options = {})
413
438
  # Calls the ListVolumeRecoveryPoints API operation.
414
439
  # @param [Hash] options
440
+ #
415
441
  # * `:gateway_arn` - *required* - (String)
416
442
  # @return [Core::Response]
417
443
  # The #data method of the response object returns
@@ -427,6 +453,7 @@ module AWS
427
453
  # @!method list_volumes(options = {})
428
454
  # Calls the ListVolumes API operation.
429
455
  # @param [Hash] options
456
+ #
430
457
  # * `:gateway_arn` - *required* - (String)
431
458
  # * `:marker` - (String)
432
459
  # * `:limit` - (Integer)
@@ -443,6 +470,7 @@ module AWS
443
470
  # @!method shutdown_gateway(options = {})
444
471
  # Calls the ShutdownGateway API operation.
445
472
  # @param [Hash] options
473
+ #
446
474
  # * `:gateway_arn` - *required* - (String)
447
475
  # @return [Core::Response]
448
476
  # The #data method of the response object returns
@@ -453,6 +481,7 @@ module AWS
453
481
  # @!method start_gateway(options = {})
454
482
  # Calls the StartGateway API operation.
455
483
  # @param [Hash] options
484
+ #
456
485
  # * `:gateway_arn` - *required* - (String)
457
486
  # @return [Core::Response]
458
487
  # The #data method of the response object returns
@@ -463,6 +492,7 @@ module AWS
463
492
  # @!method update_bandwidth_rate_limit(options = {})
464
493
  # Calls the UpdateBandwidthRateLimit API operation.
465
494
  # @param [Hash] options
495
+ #
466
496
  # * `:gateway_arn` - *required* - (String)
467
497
  # * `:average_upload_rate_limit_in_bits_per_sec` - (Integer)
468
498
  # * `:average_download_rate_limit_in_bits_per_sec` - (Integer)
@@ -475,6 +505,7 @@ module AWS
475
505
  # @!method update_chap_credentials(options = {})
476
506
  # Calls the UpdateChapCredentials API operation.
477
507
  # @param [Hash] options
508
+ #
478
509
  # * `:target_arn` - *required* - (String)
479
510
  # * `:secret_to_authenticate_initiator` - *required* - (String)
480
511
  # * `:initiator_name` - *required* - (String)
@@ -489,6 +520,7 @@ module AWS
489
520
  # @!method update_gateway_information(options = {})
490
521
  # Calls the UpdateGatewayInformation API operation.
491
522
  # @param [Hash] options
523
+ #
492
524
  # * `:gateway_arn` - *required* - (String)
493
525
  # * `:gateway_name` - (String)
494
526
  # * `:gateway_timezone` - (String) Valid values include:
@@ -532,6 +564,7 @@ module AWS
532
564
  # @!method update_gateway_software_now(options = {})
533
565
  # Calls the UpdateGatewaySoftwareNow API operation.
534
566
  # @param [Hash] options
567
+ #
535
568
  # * `:gateway_arn` - *required* - (String)
536
569
  # @return [Core::Response]
537
570
  # The #data method of the response object returns
@@ -542,6 +575,7 @@ module AWS
542
575
  # @!method update_maintenance_start_time(options = {})
543
576
  # Calls the UpdateMaintenanceStartTime API operation.
544
577
  # @param [Hash] options
578
+ #
545
579
  # * `:gateway_arn` - *required* - (String)
546
580
  # * `:hour_of_day` - *required* - (Integer)
547
581
  # * `:minute_of_hour` - *required* - (Integer)
@@ -555,6 +589,7 @@ module AWS
555
589
  # @!method update_snapshot_schedule(options = {})
556
590
  # Calls the UpdateSnapshotSchedule API operation.
557
591
  # @param [Hash] options
592
+ #
558
593
  # * `:volume_arn` - *required* - (String)
559
594
  # * `:start_at` - *required* - (Integer)
560
595
  # * `:recurrence_in_hours` - *required* - (Integer)
@@ -36,6 +36,7 @@ module AWS
36
36
  # @!method assume_role(options = {})
37
37
  # Calls the AssumeRole API operation.
38
38
  # @param [Hash] options
39
+ #
39
40
  # * `:role_arn` - *required* - (String) The Amazon Resource Name (ARN)
40
41
  # of the role that the caller is assuming.
41
42
  # * `:role_session_name` - *required* - (String) An identifier for the
@@ -77,6 +78,7 @@ module AWS
77
78
  # @!method assume_role_with_web_identity(options = {})
78
79
  # Calls the AssumeRoleWithWebIdentity API operation.
79
80
  # @param [Hash] options
81
+ #
80
82
  # * `:role_arn` - *required* - (String) The Amazon Resource Name (ARN)
81
83
  # of the role that the caller is assuming.
82
84
  # * `:role_session_name` - *required* - (String) An identifier for the
@@ -126,6 +128,7 @@ module AWS
126
128
  # @!method get_federation_token(options = {})
127
129
  # Calls the GetFederationToken API operation.
128
130
  # @param [Hash] options
131
+ #
129
132
  # * `:name` - *required* - (String) The name of the federated user. The
130
133
  # name is used as an identifier for the temporary security
131
134
  # credentials (such as Bob). For example, you can reference the
@@ -163,6 +166,7 @@ module AWS
163
166
  # @!method get_session_token(options = {})
164
167
  # Calls the GetSessionToken API operation.
165
168
  # @param [Hash] options
169
+ #
166
170
  # * `:duration_seconds` - (Integer) The duration, in seconds, that the
167
171
  # credentials should remain valid. Acceptable durations for IAM user
168
172
  # sessions range from 900s (15 minutes) to 129600s (36 hours), with
@@ -25,17 +25,20 @@ module AWS
25
25
  # @!method add_communication_to_case(options = {})
26
26
  # Calls the AddCommunicationToCase API operation.
27
27
  # @param [Hash] options
28
+ #
28
29
  # * `:case_id` - (String)
29
30
  # * `:communication_body` - *required* - (String)
30
31
  # * `:cc_email_addresses` - (Array<String>)
31
32
  # @return [Core::Response]
32
33
  # The #data method of the response object returns
33
34
  # a hash with the following structure:
35
+ #
34
36
  # * `:result` - (Boolean)
35
37
 
36
38
  # @!method create_case(options = {})
37
39
  # Calls the CreateCase API operation.
38
40
  # @param [Hash] options
41
+ #
39
42
  # * `:subject` - *required* - (String)
40
43
  # * `:service_code` - *required* - (String)
41
44
  # * `:severity_code` - (String)
@@ -47,11 +50,13 @@ module AWS
47
50
  # @return [Core::Response]
48
51
  # The #data method of the response object returns
49
52
  # a hash with the following structure:
53
+ #
50
54
  # * `:case_id` - (String)
51
55
 
52
56
  # @!method describe_cases(options = {})
53
57
  # Calls the DescribeCases API operation.
54
58
  # @param [Hash] options
59
+ #
55
60
  # * `:case_id_list` - (Array<String>)
56
61
  # * `:display_id` - (String)
57
62
  # * `:after_time` - (String)
@@ -63,6 +68,7 @@ module AWS
63
68
  # @return [Core::Response]
64
69
  # The #data method of the response object returns
65
70
  # a hash with the following structure:
71
+ #
66
72
  # * `:cases` - (Array<Hash>)
67
73
  # * `:case_id` - (String)
68
74
  # * `:display_id` - (String)
@@ -87,6 +93,7 @@ module AWS
87
93
  # @!method describe_communications(options = {})
88
94
  # Calls the DescribeCommunications API operation.
89
95
  # @param [Hash] options
96
+ #
90
97
  # * `:case_id` - *required* - (String)
91
98
  # * `:before_time` - (String)
92
99
  # * `:after_time` - (String)
@@ -95,6 +102,7 @@ module AWS
95
102
  # @return [Core::Response]
96
103
  # The #data method of the response object returns
97
104
  # a hash with the following structure:
105
+ #
98
106
  # * `:communications` - (Array<Hash>)
99
107
  # * `:case_id` - (String)
100
108
  # * `:body` - (String)
@@ -105,11 +113,13 @@ module AWS
105
113
  # @!method describe_services(options = {})
106
114
  # Calls the DescribeServices API operation.
107
115
  # @param [Hash] options
116
+ #
108
117
  # * `:service_code_list` - (Array<String>)
109
118
  # * `:language` - (String)
110
119
  # @return [Core::Response]
111
120
  # The #data method of the response object returns
112
121
  # a hash with the following structure:
122
+ #
113
123
  # * `:services` - (Array<Hash>)
114
124
  # * `:code` - (String)
115
125
  # * `:name` - (String)
@@ -120,10 +130,12 @@ module AWS
120
130
  # @!method describe_severity_levels(options = {})
121
131
  # Calls the DescribeSeverityLevels API operation.
122
132
  # @param [Hash] options
133
+ #
123
134
  # * `:language` - (String)
124
135
  # @return [Core::Response]
125
136
  # The #data method of the response object returns
126
137
  # a hash with the following structure:
138
+ #
127
139
  # * `:severity_levels` - (Array<Hash>)
128
140
  # * `:code` - (String)
129
141
  # * `:name` - (String)
@@ -131,10 +143,12 @@ module AWS
131
143
  # @!method describe_trusted_advisor_check_refresh_statuses(options = {})
132
144
  # Calls the DescribeTrustedAdvisorCheckRefreshStatuses API operation.
133
145
  # @param [Hash] options
146
+ #
134
147
  # * `:check_ids` - *required* - (Array<String>)
135
148
  # @return [Core::Response]
136
149
  # The #data method of the response object returns
137
150
  # a hash with the following structure:
151
+ #
138
152
  # * `:statuses` - (Array<Hash>)
139
153
  # * `:check_id` - (String)
140
154
  # * `:status` - (String)
@@ -143,11 +157,13 @@ module AWS
143
157
  # @!method describe_trusted_advisor_check_result(options = {})
144
158
  # Calls the DescribeTrustedAdvisorCheckResult API operation.
145
159
  # @param [Hash] options
160
+ #
146
161
  # * `:check_id` - *required* - (String)
147
162
  # * `:language` - (String)
148
163
  # @return [Core::Response]
149
164
  # The #data method of the response object returns
150
165
  # a hash with the following structure:
166
+ #
151
167
  # * `:result` - (Hash)
152
168
  # * `:check_id` - (String)
153
169
  # * `:timestamp` - (String)
@@ -171,10 +187,12 @@ module AWS
171
187
  # @!method describe_trusted_advisor_check_summaries(options = {})
172
188
  # Calls the DescribeTrustedAdvisorCheckSummaries API operation.
173
189
  # @param [Hash] options
190
+ #
174
191
  # * `:check_ids` - *required* - (Array<String>)
175
192
  # @return [Core::Response]
176
193
  # The #data method of the response object returns
177
194
  # a hash with the following structure:
195
+ #
178
196
  # * `:summaries` - (Array<Hash>)
179
197
  # * `:check_id` - (String)
180
198
  # * `:timestamp` - (String)
@@ -193,10 +211,12 @@ module AWS
193
211
  # @!method describe_trusted_advisor_checks(options = {})
194
212
  # Calls the DescribeTrustedAdvisorChecks API operation.
195
213
  # @param [Hash] options
214
+ #
196
215
  # * `:language` - *required* - (String)
197
216
  # @return [Core::Response]
198
217
  # The #data method of the response object returns
199
218
  # a hash with the following structure:
219
+ #
200
220
  # * `:checks` - (Array<Hash>)
201
221
  # * `:id` - (String)
202
222
  # * `:name` - (String)
@@ -207,10 +227,12 @@ module AWS
207
227
  # @!method refresh_trusted_advisor_check(options = {})
208
228
  # Calls the RefreshTrustedAdvisorCheck API operation.
209
229
  # @param [Hash] options
230
+ #
210
231
  # * `:check_id` - *required* - (String)
211
232
  # @return [Core::Response]
212
233
  # The #data method of the response object returns
213
234
  # a hash with the following structure:
235
+ #
214
236
  # * `:status` - (Hash)
215
237
  # * `:check_id` - (String)
216
238
  # * `:status` - (String)
@@ -219,10 +241,12 @@ module AWS
219
241
  # @!method resolve_case(options = {})
220
242
  # Calls the ResolveCase API operation.
221
243
  # @param [Hash] options
244
+ #
222
245
  # * `:case_id` - (String)
223
246
  # @return [Core::Response]
224
247
  # The #data method of the response object returns
225
248
  # a hash with the following structure:
249
+ #
226
250
  # * `:initial_case_status` - (String)
227
251
  # * `:final_case_status` - (String)
228
252