aws-sdk-sqs 1.54.0 → 1.55.0
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +140 -231
- data/lib/aws-sdk-sqs/client_api.rb +51 -219
- data/lib/aws-sdk-sqs/errors.rb +0 -246
- data/lib/aws-sdk-sqs/queue.rb +23 -57
- data/lib/aws-sdk-sqs/resource.rb +24 -58
- data/lib/aws-sdk-sqs/types.rb +83 -443
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-sqs/errors.rb
CHANGED
@@ -30,20 +30,10 @@ module Aws::SQS
|
|
30
30
|
# * {BatchEntryIdsNotDistinct}
|
31
31
|
# * {BatchRequestTooLong}
|
32
32
|
# * {EmptyBatchRequest}
|
33
|
-
# * {InvalidAddress}
|
34
33
|
# * {InvalidAttributeName}
|
35
|
-
# * {InvalidAttributeValue}
|
36
34
|
# * {InvalidBatchEntryId}
|
37
35
|
# * {InvalidIdFormat}
|
38
36
|
# * {InvalidMessageContents}
|
39
|
-
# * {InvalidSecurity}
|
40
|
-
# * {KmsAccessDenied}
|
41
|
-
# * {KmsDisabled}
|
42
|
-
# * {KmsInvalidKeyUsage}
|
43
|
-
# * {KmsInvalidState}
|
44
|
-
# * {KmsNotFound}
|
45
|
-
# * {KmsOptInRequired}
|
46
|
-
# * {KmsThrottled}
|
47
37
|
# * {MessageNotInflight}
|
48
38
|
# * {OverLimit}
|
49
39
|
# * {PurgeQueueInProgress}
|
@@ -51,7 +41,6 @@ module Aws::SQS
|
|
51
41
|
# * {QueueDoesNotExist}
|
52
42
|
# * {QueueNameExists}
|
53
43
|
# * {ReceiptHandleIsInvalid}
|
54
|
-
# * {RequestThrottled}
|
55
44
|
# * {TooManyEntriesInBatchRequest}
|
56
45
|
# * {UnsupportedOperation}
|
57
46
|
#
|
@@ -69,11 +58,6 @@ module Aws::SQS
|
|
69
58
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
70
59
|
super(context, message, data)
|
71
60
|
end
|
72
|
-
|
73
|
-
# @return [String]
|
74
|
-
def message
|
75
|
-
@message || @data[:message]
|
76
|
-
end
|
77
61
|
end
|
78
62
|
|
79
63
|
class BatchRequestTooLong < ServiceError
|
@@ -84,11 +68,6 @@ module Aws::SQS
|
|
84
68
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
85
69
|
super(context, message, data)
|
86
70
|
end
|
87
|
-
|
88
|
-
# @return [String]
|
89
|
-
def message
|
90
|
-
@message || @data[:message]
|
91
|
-
end
|
92
71
|
end
|
93
72
|
|
94
73
|
class EmptyBatchRequest < ServiceError
|
@@ -99,26 +78,6 @@ module Aws::SQS
|
|
99
78
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
100
79
|
super(context, message, data)
|
101
80
|
end
|
102
|
-
|
103
|
-
# @return [String]
|
104
|
-
def message
|
105
|
-
@message || @data[:message]
|
106
|
-
end
|
107
|
-
end
|
108
|
-
|
109
|
-
class InvalidAddress < ServiceError
|
110
|
-
|
111
|
-
# @param [Seahorse::Client::RequestContext] context
|
112
|
-
# @param [String] message
|
113
|
-
# @param [Aws::SQS::Types::InvalidAddress] data
|
114
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
115
|
-
super(context, message, data)
|
116
|
-
end
|
117
|
-
|
118
|
-
# @return [String]
|
119
|
-
def message
|
120
|
-
@message || @data[:message]
|
121
|
-
end
|
122
81
|
end
|
123
82
|
|
124
83
|
class InvalidAttributeName < ServiceError
|
@@ -129,26 +88,6 @@ module Aws::SQS
|
|
129
88
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
130
89
|
super(context, message, data)
|
131
90
|
end
|
132
|
-
|
133
|
-
# @return [String]
|
134
|
-
def message
|
135
|
-
@message || @data[:message]
|
136
|
-
end
|
137
|
-
end
|
138
|
-
|
139
|
-
class InvalidAttributeValue < ServiceError
|
140
|
-
|
141
|
-
# @param [Seahorse::Client::RequestContext] context
|
142
|
-
# @param [String] message
|
143
|
-
# @param [Aws::SQS::Types::InvalidAttributeValue] data
|
144
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
145
|
-
super(context, message, data)
|
146
|
-
end
|
147
|
-
|
148
|
-
# @return [String]
|
149
|
-
def message
|
150
|
-
@message || @data[:message]
|
151
|
-
end
|
152
91
|
end
|
153
92
|
|
154
93
|
class InvalidBatchEntryId < ServiceError
|
@@ -159,11 +98,6 @@ module Aws::SQS
|
|
159
98
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
160
99
|
super(context, message, data)
|
161
100
|
end
|
162
|
-
|
163
|
-
# @return [String]
|
164
|
-
def message
|
165
|
-
@message || @data[:message]
|
166
|
-
end
|
167
101
|
end
|
168
102
|
|
169
103
|
class InvalidIdFormat < ServiceError
|
@@ -184,131 +118,6 @@ module Aws::SQS
|
|
184
118
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
185
119
|
super(context, message, data)
|
186
120
|
end
|
187
|
-
|
188
|
-
# @return [String]
|
189
|
-
def message
|
190
|
-
@message || @data[:message]
|
191
|
-
end
|
192
|
-
end
|
193
|
-
|
194
|
-
class InvalidSecurity < ServiceError
|
195
|
-
|
196
|
-
# @param [Seahorse::Client::RequestContext] context
|
197
|
-
# @param [String] message
|
198
|
-
# @param [Aws::SQS::Types::InvalidSecurity] data
|
199
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
200
|
-
super(context, message, data)
|
201
|
-
end
|
202
|
-
|
203
|
-
# @return [String]
|
204
|
-
def message
|
205
|
-
@message || @data[:message]
|
206
|
-
end
|
207
|
-
end
|
208
|
-
|
209
|
-
class KmsAccessDenied < ServiceError
|
210
|
-
|
211
|
-
# @param [Seahorse::Client::RequestContext] context
|
212
|
-
# @param [String] message
|
213
|
-
# @param [Aws::SQS::Types::KmsAccessDenied] data
|
214
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
215
|
-
super(context, message, data)
|
216
|
-
end
|
217
|
-
|
218
|
-
# @return [String]
|
219
|
-
def message
|
220
|
-
@message || @data[:message]
|
221
|
-
end
|
222
|
-
end
|
223
|
-
|
224
|
-
class KmsDisabled < ServiceError
|
225
|
-
|
226
|
-
# @param [Seahorse::Client::RequestContext] context
|
227
|
-
# @param [String] message
|
228
|
-
# @param [Aws::SQS::Types::KmsDisabled] data
|
229
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
230
|
-
super(context, message, data)
|
231
|
-
end
|
232
|
-
|
233
|
-
# @return [String]
|
234
|
-
def message
|
235
|
-
@message || @data[:message]
|
236
|
-
end
|
237
|
-
end
|
238
|
-
|
239
|
-
class KmsInvalidKeyUsage < ServiceError
|
240
|
-
|
241
|
-
# @param [Seahorse::Client::RequestContext] context
|
242
|
-
# @param [String] message
|
243
|
-
# @param [Aws::SQS::Types::KmsInvalidKeyUsage] data
|
244
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
245
|
-
super(context, message, data)
|
246
|
-
end
|
247
|
-
|
248
|
-
# @return [String]
|
249
|
-
def message
|
250
|
-
@message || @data[:message]
|
251
|
-
end
|
252
|
-
end
|
253
|
-
|
254
|
-
class KmsInvalidState < ServiceError
|
255
|
-
|
256
|
-
# @param [Seahorse::Client::RequestContext] context
|
257
|
-
# @param [String] message
|
258
|
-
# @param [Aws::SQS::Types::KmsInvalidState] data
|
259
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
260
|
-
super(context, message, data)
|
261
|
-
end
|
262
|
-
|
263
|
-
# @return [String]
|
264
|
-
def message
|
265
|
-
@message || @data[:message]
|
266
|
-
end
|
267
|
-
end
|
268
|
-
|
269
|
-
class KmsNotFound < ServiceError
|
270
|
-
|
271
|
-
# @param [Seahorse::Client::RequestContext] context
|
272
|
-
# @param [String] message
|
273
|
-
# @param [Aws::SQS::Types::KmsNotFound] data
|
274
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
275
|
-
super(context, message, data)
|
276
|
-
end
|
277
|
-
|
278
|
-
# @return [String]
|
279
|
-
def message
|
280
|
-
@message || @data[:message]
|
281
|
-
end
|
282
|
-
end
|
283
|
-
|
284
|
-
class KmsOptInRequired < ServiceError
|
285
|
-
|
286
|
-
# @param [Seahorse::Client::RequestContext] context
|
287
|
-
# @param [String] message
|
288
|
-
# @param [Aws::SQS::Types::KmsOptInRequired] data
|
289
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
290
|
-
super(context, message, data)
|
291
|
-
end
|
292
|
-
|
293
|
-
# @return [String]
|
294
|
-
def message
|
295
|
-
@message || @data[:message]
|
296
|
-
end
|
297
|
-
end
|
298
|
-
|
299
|
-
class KmsThrottled < ServiceError
|
300
|
-
|
301
|
-
# @param [Seahorse::Client::RequestContext] context
|
302
|
-
# @param [String] message
|
303
|
-
# @param [Aws::SQS::Types::KmsThrottled] data
|
304
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
305
|
-
super(context, message, data)
|
306
|
-
end
|
307
|
-
|
308
|
-
# @return [String]
|
309
|
-
def message
|
310
|
-
@message || @data[:message]
|
311
|
-
end
|
312
121
|
end
|
313
122
|
|
314
123
|
class MessageNotInflight < ServiceError
|
@@ -329,11 +138,6 @@ module Aws::SQS
|
|
329
138
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
330
139
|
super(context, message, data)
|
331
140
|
end
|
332
|
-
|
333
|
-
# @return [String]
|
334
|
-
def message
|
335
|
-
@message || @data[:message]
|
336
|
-
end
|
337
141
|
end
|
338
142
|
|
339
143
|
class PurgeQueueInProgress < ServiceError
|
@@ -344,11 +148,6 @@ module Aws::SQS
|
|
344
148
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
345
149
|
super(context, message, data)
|
346
150
|
end
|
347
|
-
|
348
|
-
# @return [String]
|
349
|
-
def message
|
350
|
-
@message || @data[:message]
|
351
|
-
end
|
352
151
|
end
|
353
152
|
|
354
153
|
class QueueDeletedRecently < ServiceError
|
@@ -359,11 +158,6 @@ module Aws::SQS
|
|
359
158
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
360
159
|
super(context, message, data)
|
361
160
|
end
|
362
|
-
|
363
|
-
# @return [String]
|
364
|
-
def message
|
365
|
-
@message || @data[:message]
|
366
|
-
end
|
367
161
|
end
|
368
162
|
|
369
163
|
class QueueDoesNotExist < ServiceError
|
@@ -374,11 +168,6 @@ module Aws::SQS
|
|
374
168
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
375
169
|
super(context, message, data)
|
376
170
|
end
|
377
|
-
|
378
|
-
# @return [String]
|
379
|
-
def message
|
380
|
-
@message || @data[:message]
|
381
|
-
end
|
382
171
|
end
|
383
172
|
|
384
173
|
class QueueNameExists < ServiceError
|
@@ -389,11 +178,6 @@ module Aws::SQS
|
|
389
178
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
390
179
|
super(context, message, data)
|
391
180
|
end
|
392
|
-
|
393
|
-
# @return [String]
|
394
|
-
def message
|
395
|
-
@message || @data[:message]
|
396
|
-
end
|
397
181
|
end
|
398
182
|
|
399
183
|
class ReceiptHandleIsInvalid < ServiceError
|
@@ -404,26 +188,6 @@ module Aws::SQS
|
|
404
188
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
405
189
|
super(context, message, data)
|
406
190
|
end
|
407
|
-
|
408
|
-
# @return [String]
|
409
|
-
def message
|
410
|
-
@message || @data[:message]
|
411
|
-
end
|
412
|
-
end
|
413
|
-
|
414
|
-
class RequestThrottled < ServiceError
|
415
|
-
|
416
|
-
# @param [Seahorse::Client::RequestContext] context
|
417
|
-
# @param [String] message
|
418
|
-
# @param [Aws::SQS::Types::RequestThrottled] data
|
419
|
-
def initialize(context, message, data = Aws::EmptyStructure.new)
|
420
|
-
super(context, message, data)
|
421
|
-
end
|
422
|
-
|
423
|
-
# @return [String]
|
424
|
-
def message
|
425
|
-
@message || @data[:message]
|
426
|
-
end
|
427
191
|
end
|
428
192
|
|
429
193
|
class TooManyEntriesInBatchRequest < ServiceError
|
@@ -434,11 +198,6 @@ module Aws::SQS
|
|
434
198
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
435
199
|
super(context, message, data)
|
436
200
|
end
|
437
|
-
|
438
|
-
# @return [String]
|
439
|
-
def message
|
440
|
-
@message || @data[:message]
|
441
|
-
end
|
442
201
|
end
|
443
202
|
|
444
203
|
class UnsupportedOperation < ServiceError
|
@@ -449,11 +208,6 @@ module Aws::SQS
|
|
449
208
|
def initialize(context, message, data = Aws::EmptyStructure.new)
|
450
209
|
super(context, message, data)
|
451
210
|
end
|
452
|
-
|
453
|
-
# @return [String]
|
454
|
-
def message
|
455
|
-
@message || @data[:message]
|
456
|
-
end
|
457
211
|
end
|
458
212
|
|
459
213
|
end
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -218,7 +218,7 @@ module Aws::SQS
|
|
218
218
|
#
|
219
219
|
# * `SenderId`
|
220
220
|
#
|
221
|
-
# * For
|
221
|
+
# * For an IAM user, returns the IAM user ID, for example
|
222
222
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
223
223
|
#
|
224
224
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -229,7 +229,7 @@ module Aws::SQS
|
|
229
229
|
#
|
230
230
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
231
231
|
# SQS owned encryption keys. Only one server-side encryption option is
|
232
|
-
# supported per queue (
|
232
|
+
# supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
|
233
233
|
#
|
234
234
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
235
235
|
# producer that calls the ` SendMessage ` action.
|
@@ -416,7 +416,7 @@ module Aws::SQS
|
|
416
416
|
# @param [Hash] options ({})
|
417
417
|
# @option options [required, String] :message_body
|
418
418
|
# The message to send. The minimum size is one character. The maximum
|
419
|
-
# size is 256
|
419
|
+
# size is 256 KB.
|
420
420
|
#
|
421
421
|
# A message can include only XML, JSON, and unformatted text. The
|
422
422
|
# following Unicode characters are allowed:
|
@@ -626,13 +626,7 @@ module Aws::SQS
|
|
626
626
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
627
627
|
# Amazon SQS retains a message. Valid values: An integer representing
|
628
628
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
629
|
-
# (4 days).
|
630
|
-
# up to 60 seconds for most of the attributes to propagate throughout
|
631
|
-
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
632
|
-
# attribute can take up to 15 minutes and will impact existing
|
633
|
-
# messages in the queue potentially causing them to be expired and
|
634
|
-
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
635
|
-
# existing messages.
|
629
|
+
# (4 days).
|
636
630
|
#
|
637
631
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
638
632
|
# For more information about policy structure, see [Overview of Amazon
|
@@ -643,59 +637,31 @@ module Aws::SQS
|
|
643
637
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
644
638
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
645
639
|
#
|
646
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
647
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
648
|
-
# Default: 30. For more information about the visibility timeout, see
|
649
|
-
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
650
|
-
#
|
651
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
652
|
-
#
|
653
640
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
654
641
|
# dead-letter queue functionality of the source queue as a JSON
|
655
|
-
# object.
|
642
|
+
# object. For more information about the redrive policy and
|
643
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
644
|
+
# the *Amazon SQS Developer Guide*.
|
656
645
|
#
|
657
646
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
658
647
|
# dead-letter queue to which Amazon SQS moves messages after the
|
659
648
|
# value of `maxReceiveCount` is exceeded.
|
660
649
|
#
|
661
650
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
662
|
-
# the source queue before being moved to the dead-letter queue.
|
663
|
-
#
|
664
|
-
#
|
665
|
-
# dead-letter-queue.
|
666
|
-
#
|
667
|
-
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
668
|
-
# the permissions for the dead-letter queue redrive permission and
|
669
|
-
# which source queues can specify dead-letter queues as a JSON object.
|
670
|
-
# The parameters are as follows:
|
671
|
-
#
|
672
|
-
# * `redrivePermission` – The permission type that defines which
|
673
|
-
# source queues can specify the current queue as the dead-letter
|
674
|
-
# queue. Valid values are:
|
675
|
-
#
|
676
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
677
|
-
# Services account in the same Region can specify this queue as
|
678
|
-
# the dead-letter queue.
|
679
|
-
#
|
680
|
-
# * `denyAll` – No source queues can specify this queue as the
|
681
|
-
# dead-letter queue.
|
682
|
-
#
|
683
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
684
|
-
# parameter can specify this queue as the dead-letter queue.
|
685
|
-
#
|
686
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
687
|
-
# queues that can specify this queue as the dead-letter queue and
|
688
|
-
# redrive messages. You can specify this parameter only when the
|
689
|
-
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
690
|
-
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
691
|
-
# specify dead-letter queues, set the `redrivePermission` parameter
|
692
|
-
# to `allowAll`.
|
693
|
-
#
|
694
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
695
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
696
|
-
# standard queue.
|
651
|
+
# the source queue before being moved to the dead-letter queue. When
|
652
|
+
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
653
|
+
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
697
654
|
#
|
698
|
-
#
|
655
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
656
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
657
|
+
# standard queue.
|
658
|
+
#
|
659
|
+
# </note>
|
660
|
+
#
|
661
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
662
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
663
|
+
# Default: 30. For more information about the visibility timeout, see
|
664
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
699
665
|
#
|
700
666
|
# The following attributes apply only to [server-side-encryption][4]:
|
701
667
|
#
|
@@ -717,7 +683,7 @@ module Aws::SQS
|
|
717
683
|
#
|
718
684
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
719
685
|
# SQS owned encryption keys. Only one server-side encryption option is
|
720
|
-
# supported per queue (
|
686
|
+
# supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
|
721
687
|
#
|
722
688
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
723
689
|
# queues][11]:
|
@@ -783,8 +749,8 @@ module Aws::SQS
|
|
783
749
|
#
|
784
750
|
#
|
785
751
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
786
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
787
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
752
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
753
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
788
754
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
789
755
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
790
756
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -76,75 +76,41 @@ module Aws::SQS
|
|
76
76
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
77
77
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
78
78
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
79
|
-
# (4 days).
|
80
|
-
# up to 60 seconds for most of the attributes to propagate throughout
|
81
|
-
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
82
|
-
# attribute can take up to 15 minutes and will impact existing
|
83
|
-
# messages in the queue potentially causing them to be expired and
|
84
|
-
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
85
|
-
# existing messages.
|
79
|
+
# (4 days).
|
86
80
|
#
|
87
81
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
88
82
|
# For more information about policy structure, see [Overview of Amazon
|
89
|
-
# Web Services IAM Policies][1] in the *IAM User Guide*.
|
83
|
+
# Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
|
90
84
|
#
|
91
85
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
92
86
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
93
87
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
94
88
|
#
|
95
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
96
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
97
|
-
# Default: 30. For more information about the visibility timeout, see
|
98
|
-
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
99
|
-
#
|
100
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
101
|
-
#
|
102
89
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
103
90
|
# dead-letter queue functionality of the source queue as a JSON
|
104
|
-
# object.
|
91
|
+
# object. For more information about the redrive policy and
|
92
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
93
|
+
# the *Amazon SQS Developer Guide*.
|
105
94
|
#
|
106
95
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
107
96
|
# dead-letter queue to which Amazon SQS moves messages after the
|
108
97
|
# value of `maxReceiveCount` is exceeded.
|
109
98
|
#
|
110
99
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
111
|
-
# the source queue before being moved to the dead-letter queue.
|
112
|
-
#
|
113
|
-
#
|
114
|
-
# dead-letter-queue.
|
115
|
-
#
|
116
|
-
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
117
|
-
# the permissions for the dead-letter queue redrive permission and
|
118
|
-
# which source queues can specify dead-letter queues as a JSON object.
|
119
|
-
# The parameters are as follows:
|
120
|
-
#
|
121
|
-
# * `redrivePermission` – The permission type that defines which
|
122
|
-
# source queues can specify the current queue as the dead-letter
|
123
|
-
# queue. Valid values are:
|
124
|
-
#
|
125
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
126
|
-
# Services account in the same Region can specify this queue as
|
127
|
-
# the dead-letter queue.
|
128
|
-
#
|
129
|
-
# * `denyAll` – No source queues can specify this queue as the
|
130
|
-
# dead-letter queue.
|
131
|
-
#
|
132
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
133
|
-
# parameter can specify this queue as the dead-letter queue.
|
134
|
-
#
|
135
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
136
|
-
# queues that can specify this queue as the dead-letter queue and
|
137
|
-
# redrive messages. You can specify this parameter only when the
|
138
|
-
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
139
|
-
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
140
|
-
# specify dead-letter queues, set the `redrivePermission` parameter
|
141
|
-
# to `allowAll`.
|
142
|
-
#
|
143
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
144
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
145
|
-
# standard queue.
|
100
|
+
# the source queue before being moved to the dead-letter queue. When
|
101
|
+
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
102
|
+
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
146
103
|
#
|
147
|
-
#
|
104
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
105
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
106
|
+
# standard queue.
|
107
|
+
#
|
108
|
+
# </note>
|
109
|
+
#
|
110
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
111
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
112
|
+
# Default: 30. For more information about the visibility timeout, see
|
113
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
148
114
|
#
|
149
115
|
# The following attributes apply only to [server-side-encryption][4]:
|
150
116
|
#
|
@@ -163,11 +129,11 @@ module Aws::SQS
|
|
163
129
|
# Default: 300 (5 minutes). A shorter time period provides better
|
164
130
|
# security but results in more calls to KMS which might incur charges
|
165
131
|
# after Free Tier. For more information, see [How Does the Data Key
|
166
|
-
# Reuse Period Work?][8]
|
132
|
+
# Reuse Period Work?][8].
|
167
133
|
#
|
168
134
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
169
135
|
# SQS owned encryption keys. Only one server-side encryption option is
|
170
|
-
# supported per queue (
|
136
|
+
# supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
|
171
137
|
#
|
172
138
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
173
139
|
# queues][11]:
|
@@ -244,8 +210,8 @@ module Aws::SQS
|
|
244
210
|
#
|
245
211
|
#
|
246
212
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
247
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
248
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
213
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
214
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
249
215
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
250
216
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
251
217
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -282,8 +248,8 @@ module Aws::SQS
|
|
282
248
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
283
249
|
#
|
284
250
|
# Cross-account permissions don't apply to this action. For more
|
285
|
-
# information, see [Grant cross-account permissions to a role and a
|
286
|
-
#
|
251
|
+
# information, see [Grant cross-account permissions to a role and a user
|
252
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
287
253
|
#
|
288
254
|
# </note>
|
289
255
|
#
|