aws-sdk-sqs 1.67.0 → 1.89.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 +110 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +206 -105
- data/lib/aws-sdk-sqs/client_api.rb +8 -1
- data/lib/aws-sdk-sqs/customizations.rb +5 -1
- data/lib/aws-sdk-sqs/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-sqs/endpoints.rb +2 -320
- data/lib/aws-sdk-sqs/message.rb +3 -3
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +23 -60
- data/lib/aws-sdk-sqs/plugins/md5s.rb +84 -35
- data/lib/aws-sdk-sqs/queue.rb +72 -30
- data/lib/aws-sdk-sqs/resource.rb +3 -6
- data/lib/aws-sdk-sqs/types.rb +70 -28
- data/lib/aws-sdk-sqs.rb +17 -13
- data/sig/client.rbs +367 -0
- data/sig/errors.rbs +98 -0
- data/sig/message.rbs +73 -0
- data/sig/queue.rbs +164 -0
- data/sig/resource.rbs +108 -0
- data/sig/types.rbs +472 -0
- data/sig/waiters.rbs +13 -0
- metadata +18 -11
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -54,7 +54,7 @@ module Aws::SQS
|
|
54
54
|
#
|
55
55
|
# @return [self]
|
56
56
|
def load
|
57
|
-
resp = Aws::Plugins::UserAgent.
|
57
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
58
58
|
@client.get_queue_attributes(
|
59
59
|
queue_url: @url,
|
60
60
|
attribute_names: ["All"]
|
@@ -125,7 +125,7 @@ module Aws::SQS
|
|
125
125
|
# @return [EmptyStructure]
|
126
126
|
def add_permission(options = {})
|
127
127
|
options = options.merge(queue_url: @url)
|
128
|
-
resp = Aws::Plugins::UserAgent.
|
128
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
129
129
|
@client.add_permission(options)
|
130
130
|
end
|
131
131
|
resp.data
|
@@ -149,7 +149,7 @@ module Aws::SQS
|
|
149
149
|
# @return [Types::ChangeMessageVisibilityBatchResult]
|
150
150
|
def change_message_visibility_batch(options = {})
|
151
151
|
options = options.merge(queue_url: @url)
|
152
|
-
resp = Aws::Plugins::UserAgent.
|
152
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
153
153
|
@client.change_message_visibility_batch(options)
|
154
154
|
end
|
155
155
|
resp.data
|
@@ -162,7 +162,7 @@ module Aws::SQS
|
|
162
162
|
# @return [EmptyStructure]
|
163
163
|
def delete(options = {})
|
164
164
|
options = options.merge(queue_url: @url)
|
165
|
-
resp = Aws::Plugins::UserAgent.
|
165
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
166
166
|
@client.delete_queue(options)
|
167
167
|
end
|
168
168
|
resp.data
|
@@ -184,7 +184,7 @@ module Aws::SQS
|
|
184
184
|
# @return [Types::DeleteMessageBatchResult]
|
185
185
|
def delete_messages(options = {})
|
186
186
|
options = options.merge(queue_url: @url)
|
187
|
-
resp = Aws::Plugins::UserAgent.
|
187
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
188
188
|
@client.delete_message_batch(options)
|
189
189
|
end
|
190
190
|
resp.data
|
@@ -197,7 +197,7 @@ module Aws::SQS
|
|
197
197
|
# @return [EmptyStructure]
|
198
198
|
def purge(options = {})
|
199
199
|
options = options.merge(queue_url: @url)
|
200
|
-
resp = Aws::Plugins::UserAgent.
|
200
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
201
201
|
@client.purge_queue(options)
|
202
202
|
end
|
203
203
|
resp.data
|
@@ -207,6 +207,7 @@ module Aws::SQS
|
|
207
207
|
#
|
208
208
|
# message = queue.receive_messages({
|
209
209
|
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
210
|
+
# message_system_attribute_names: ["All"], # accepts All, SenderId, SentTimestamp, ApproximateReceiveCount, ApproximateFirstReceiveTimestamp, SequenceNumber, MessageDeduplicationId, MessageGroupId, AWSTraceHeader, DeadLetterQueueSourceArn
|
210
211
|
# message_attribute_names: ["MessageAttributeName"],
|
211
212
|
# max_number_of_messages: 1,
|
212
213
|
# visibility_timeout: 1,
|
@@ -215,6 +216,10 @@ module Aws::SQS
|
|
215
216
|
# })
|
216
217
|
# @param [Hash] options ({})
|
217
218
|
# @option options [Array<String>] :attribute_names
|
219
|
+
# This parameter has been deprecated but will be supported for backward
|
220
|
+
# compatibility. To provide attribute names, you are encouraged to use
|
221
|
+
# `MessageSystemAttributeNames`.
|
222
|
+
#
|
218
223
|
# A list of attributes that need to be returned along with each message.
|
219
224
|
# These attributes include:
|
220
225
|
#
|
@@ -235,7 +240,48 @@ module Aws::SQS
|
|
235
240
|
#
|
236
241
|
# * For an IAM role, returns the IAM role ID, for example
|
237
242
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
243
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
244
|
+
# ([epoch time][1] in milliseconds).
|
245
|
+
#
|
246
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
247
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
248
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
249
|
+
#
|
250
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
251
|
+
# producer that calls the ` SendMessage ` action.
|
252
|
+
#
|
253
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
254
|
+
# calls the ` SendMessage ` action. Messages with the same
|
255
|
+
# `MessageGroupId` are returned in sequence.
|
256
|
+
#
|
257
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
258
|
+
#
|
259
|
+
#
|
260
|
+
#
|
261
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
262
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
263
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
264
|
+
# @option options [Array<String>] :message_system_attribute_names
|
265
|
+
# A list of attributes that need to be returned along with each message.
|
266
|
+
# These attributes include:
|
267
|
+
#
|
268
|
+
# * `All` – Returns all values.
|
269
|
+
#
|
270
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
271
|
+
# was first received from the queue ([epoch time][1] in milliseconds).
|
238
272
|
#
|
273
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
274
|
+
# has been received across all queues but not deleted.
|
275
|
+
#
|
276
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
277
|
+
#
|
278
|
+
# * `SenderId`
|
279
|
+
#
|
280
|
+
# * For a user, returns the user ID, for example
|
281
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
282
|
+
#
|
283
|
+
# * For an IAM role, returns the IAM role ID, for example
|
284
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
239
285
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
240
286
|
# ([epoch time][1] in milliseconds).
|
241
287
|
#
|
@@ -290,8 +336,8 @@ module Aws::SQS
|
|
290
336
|
# The duration (in seconds) for which the call waits for a message to
|
291
337
|
# arrive in the queue before returning. If a message is available, the
|
292
338
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
293
|
-
# available and the wait time expires, the call
|
294
|
-
#
|
339
|
+
# available and the wait time expires, the call does not return a
|
340
|
+
# message list.
|
295
341
|
#
|
296
342
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
297
343
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -319,10 +365,6 @@ module Aws::SQS
|
|
319
365
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
320
366
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
321
367
|
#
|
322
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
323
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
324
|
-
# `ReceiveRequestAttemptId`.
|
325
|
-
#
|
326
368
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
327
369
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
328
370
|
# (deleted or had their visibility changes).
|
@@ -356,7 +398,7 @@ module Aws::SQS
|
|
356
398
|
#
|
357
399
|
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
358
400
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
|
359
|
-
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_
|
401
|
+
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
|
360
402
|
# ``).
|
361
403
|
#
|
362
404
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
@@ -371,7 +413,7 @@ module Aws::SQS
|
|
371
413
|
def receive_messages(options = {})
|
372
414
|
batch = []
|
373
415
|
options = options.merge(queue_url: @url)
|
374
|
-
resp = Aws::Plugins::UserAgent.
|
416
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
375
417
|
@client.receive_message(options)
|
376
418
|
end
|
377
419
|
resp.data.messages.each do |m|
|
@@ -397,7 +439,7 @@ module Aws::SQS
|
|
397
439
|
# @return [EmptyStructure]
|
398
440
|
def remove_permission(options = {})
|
399
441
|
options = options.merge(queue_url: @url)
|
400
|
-
resp = Aws::Plugins::UserAgent.
|
442
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
401
443
|
@client.remove_permission(options)
|
402
444
|
end
|
403
445
|
resp.data
|
@@ -435,13 +477,17 @@ module Aws::SQS
|
|
435
477
|
# size is 256 KiB.
|
436
478
|
#
|
437
479
|
# A message can include only XML, JSON, and unformatted text. The
|
438
|
-
# following Unicode characters are allowed
|
480
|
+
# following Unicode characters are allowed. For more information, see
|
481
|
+
# the [W3C specification for characters][1].
|
439
482
|
#
|
440
483
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
|
441
484
|
# \| `#x10000` to `#x10FFFF`
|
442
485
|
#
|
443
|
-
#
|
444
|
-
#
|
486
|
+
# Amazon SQS does not throw an exception or completely reject the
|
487
|
+
# message if it contains invalid characters. Instead, it replaces those
|
488
|
+
# invalid characters with `U+FFFD` before storing the message in the
|
489
|
+
# queue, as long as the message body contains at least one valid
|
490
|
+
# character.
|
445
491
|
#
|
446
492
|
#
|
447
493
|
#
|
@@ -500,7 +546,6 @@ module Aws::SQS
|
|
500
546
|
#
|
501
547
|
# * If the queue has `ContentBasedDeduplication` set, your
|
502
548
|
# `MessageDeduplicationId` overrides the generated one.
|
503
|
-
#
|
504
549
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
505
550
|
# identical content sent within the deduplication interval are treated
|
506
551
|
# as duplicates and only one copy of the message is delivered.
|
@@ -525,7 +570,7 @@ module Aws::SQS
|
|
525
570
|
#
|
526
571
|
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
527
572
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
528
|
-
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_
|
573
|
+
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
|
529
574
|
# ``).
|
530
575
|
#
|
531
576
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
@@ -555,9 +600,9 @@ module Aws::SQS
|
|
555
600
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
556
601
|
# sorted by time sent. The caller can't specify a `MessageGroupId`.
|
557
602
|
#
|
558
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
559
|
-
# alphanumeric characters and punctuation ``
|
560
|
-
# (!"#$%&'()*+,-./:;<=>?@[\]^_
|
603
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
604
|
+
# values: alphanumeric characters and punctuation ``
|
605
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
561
606
|
#
|
562
607
|
# For best practices of using `MessageGroupId`, see [Using the
|
563
608
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
@@ -571,7 +616,7 @@ module Aws::SQS
|
|
571
616
|
# @return [Types::SendMessageResult]
|
572
617
|
def send_message(options = {})
|
573
618
|
options = options.merge(queue_url: @url)
|
574
|
-
resp = Aws::Plugins::UserAgent.
|
619
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
575
620
|
@client.send_message(options)
|
576
621
|
end
|
577
622
|
resp.data
|
@@ -614,7 +659,7 @@ module Aws::SQS
|
|
614
659
|
# @return [Types::SendMessageBatchResult]
|
615
660
|
def send_messages(options = {})
|
616
661
|
options = options.merge(queue_url: @url)
|
617
|
-
resp = Aws::Plugins::UserAgent.
|
662
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
618
663
|
@client.send_message_batch(options)
|
619
664
|
end
|
620
665
|
resp.data
|
@@ -683,7 +728,6 @@ module Aws::SQS
|
|
683
728
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
684
729
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
685
730
|
# dead-letter-queue.
|
686
|
-
#
|
687
731
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
688
732
|
# the permissions for the dead-letter queue redrive permission and
|
689
733
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -702,7 +746,6 @@ module Aws::SQS
|
|
702
746
|
#
|
703
747
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
704
748
|
# parameter can specify this queue as the dead-letter queue.
|
705
|
-
#
|
706
749
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
707
750
|
# queues that can specify this queue as the dead-letter queue and
|
708
751
|
# redrive messages. You can specify this parameter only when the
|
@@ -762,7 +805,6 @@ module Aws::SQS
|
|
762
805
|
#
|
763
806
|
# * If the queue has `ContentBasedDeduplication` set, your
|
764
807
|
# `MessageDeduplicationId` overrides the generated one.
|
765
|
-
#
|
766
808
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
767
809
|
# identical content sent within the deduplication interval are
|
768
810
|
# treated as duplicates and only one copy of the message is
|
@@ -819,7 +861,7 @@ module Aws::SQS
|
|
819
861
|
# @return [EmptyStructure]
|
820
862
|
def set_attributes(options = {})
|
821
863
|
options = options.merge(queue_url: @url)
|
822
|
-
resp = Aws::Plugins::UserAgent.
|
864
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
823
865
|
@client.set_queue_attributes(options)
|
824
866
|
end
|
825
867
|
resp.data
|
@@ -835,7 +877,7 @@ module Aws::SQS
|
|
835
877
|
def dead_letter_source_queues(options = {})
|
836
878
|
batches = Enumerator.new do |y|
|
837
879
|
options = options.merge(queue_url: @url)
|
838
|
-
resp = Aws::Plugins::UserAgent.
|
880
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
839
881
|
@client.list_dead_letter_source_queues(options)
|
840
882
|
end
|
841
883
|
resp.each_page do |page|
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -112,7 +112,6 @@ module Aws::SQS
|
|
112
112
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
113
113
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
114
114
|
# dead-letter-queue.
|
115
|
-
#
|
116
115
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
117
116
|
# the permissions for the dead-letter queue redrive permission and
|
118
117
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -131,7 +130,6 @@ module Aws::SQS
|
|
131
130
|
#
|
132
131
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
133
132
|
# parameter can specify this queue as the dead-letter queue.
|
134
|
-
#
|
135
133
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
136
134
|
# queues that can specify this queue as the dead-letter queue and
|
137
135
|
# redrive messages. You can specify this parameter only when the
|
@@ -203,7 +201,6 @@ module Aws::SQS
|
|
203
201
|
#
|
204
202
|
# * If the queue has `ContentBasedDeduplication` set, your
|
205
203
|
# `MessageDeduplicationId` overrides the generated one.
|
206
|
-
#
|
207
204
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
208
205
|
# identical content sent within the deduplication interval are
|
209
206
|
# treated as duplicates and only one copy of the message is
|
@@ -294,7 +291,7 @@ module Aws::SQS
|
|
294
291
|
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
295
292
|
# @return [Queue]
|
296
293
|
def create_queue(options = {})
|
297
|
-
resp = Aws::Plugins::UserAgent.
|
294
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
298
295
|
@client.create_queue(options)
|
299
296
|
end
|
300
297
|
Queue.new(
|
@@ -321,7 +318,7 @@ module Aws::SQS
|
|
321
318
|
# queue.
|
322
319
|
# @return [Queue]
|
323
320
|
def get_queue_by_name(options = {})
|
324
|
-
resp = Aws::Plugins::UserAgent.
|
321
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
325
322
|
@client.get_queue_url(options)
|
326
323
|
end
|
327
324
|
Queue.new(
|
@@ -355,7 +352,7 @@ module Aws::SQS
|
|
355
352
|
# @return [Queue::Collection]
|
356
353
|
def queues(options = {})
|
357
354
|
batches = Enumerator.new do |y|
|
358
|
-
resp = Aws::Plugins::UserAgent.
|
355
|
+
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
359
356
|
@client.list_queues(options)
|
360
357
|
end
|
361
358
|
resp.each_page do |page|
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -334,7 +334,6 @@ module Aws::SQS
|
|
334
334
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
335
335
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
336
336
|
# the dead-letter-queue.
|
337
|
-
#
|
338
337
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
339
338
|
# the permissions for the dead-letter queue redrive permission and
|
340
339
|
# which source queues can specify dead-letter queues as a JSON
|
@@ -353,7 +352,6 @@ module Aws::SQS
|
|
353
352
|
#
|
354
353
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
355
354
|
# parameter can specify this queue as the dead-letter queue.
|
356
|
-
#
|
357
355
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
358
356
|
# source queues that can specify this queue as the dead-letter
|
359
357
|
# queue and redrive messages. You can specify this parameter only
|
@@ -426,7 +424,6 @@ module Aws::SQS
|
|
426
424
|
#
|
427
425
|
# * If the queue has `ContentBasedDeduplication` set, your
|
428
426
|
# `MessageDeduplicationId` overrides the generated one.
|
429
|
-
#
|
430
427
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
431
428
|
# identical content sent within the deduplication interval are
|
432
429
|
# treated as duplicates and only one copy of the message is
|
@@ -766,7 +763,6 @@ module Aws::SQS
|
|
766
763
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
767
764
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
768
765
|
# the dead-letter-queue.
|
769
|
-
#
|
770
766
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
771
767
|
# the permissions for the dead-letter queue redrive permission and
|
772
768
|
# which source queues can specify dead-letter queues as a JSON
|
@@ -785,7 +781,6 @@ module Aws::SQS
|
|
785
781
|
#
|
786
782
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
787
783
|
# parameter can specify this queue as the dead-letter queue.
|
788
|
-
#
|
789
784
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
790
785
|
# source queues that can specify this queue as the dead-letter
|
791
786
|
# queue and redrive messages. You can specify this parameter only
|
@@ -1245,8 +1240,9 @@ module Aws::SQS
|
|
1245
1240
|
#
|
1246
1241
|
# @!attribute [rw] approximate_number_of_messages_to_move
|
1247
1242
|
# The number of messages to be moved from the source queue. This
|
1248
|
-
# number is obtained at the time of starting the message movement
|
1249
|
-
# task
|
1243
|
+
# number is obtained at the time of starting the message movement task
|
1244
|
+
# and is only included after the message movement task is selected to
|
1245
|
+
# start.
|
1250
1246
|
# @return [Integer]
|
1251
1247
|
#
|
1252
1248
|
# @!attribute [rw] failure_reason
|
@@ -1657,6 +1653,10 @@ module Aws::SQS
|
|
1657
1653
|
# @return [String]
|
1658
1654
|
#
|
1659
1655
|
# @!attribute [rw] attribute_names
|
1656
|
+
# This parameter has been deprecated but will be supported for
|
1657
|
+
# backward compatibility. To provide attribute names, you are
|
1658
|
+
# encouraged to use `MessageSystemAttributeNames`.
|
1659
|
+
#
|
1660
1660
|
# A list of attributes that need to be returned along with each
|
1661
1661
|
# message. These attributes include:
|
1662
1662
|
#
|
@@ -1678,7 +1678,52 @@ module Aws::SQS
|
|
1678
1678
|
#
|
1679
1679
|
# * For an IAM role, returns the IAM role ID, for example
|
1680
1680
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1681
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1682
|
+
# queue ([epoch time][1] in milliseconds).
|
1683
|
+
#
|
1684
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1685
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
1686
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1687
|
+
# [SSE-SQS][3]).
|
1688
|
+
#
|
1689
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1690
|
+
# producer that calls the ` SendMessage ` action.
|
1691
|
+
#
|
1692
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1693
|
+
# calls the ` SendMessage ` action. Messages with the same
|
1694
|
+
# `MessageGroupId` are returned in sequence.
|
1695
|
+
#
|
1696
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1697
|
+
#
|
1681
1698
|
#
|
1699
|
+
#
|
1700
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1701
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1702
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1703
|
+
# @return [Array<String>]
|
1704
|
+
#
|
1705
|
+
# @!attribute [rw] message_system_attribute_names
|
1706
|
+
# A list of attributes that need to be returned along with each
|
1707
|
+
# message. These attributes include:
|
1708
|
+
#
|
1709
|
+
# * `All` – Returns all values.
|
1710
|
+
#
|
1711
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1712
|
+
# was first received from the queue ([epoch time][1] in
|
1713
|
+
# milliseconds).
|
1714
|
+
#
|
1715
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1716
|
+
# has been received across all queues but not deleted.
|
1717
|
+
#
|
1718
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1719
|
+
#
|
1720
|
+
# * `SenderId`
|
1721
|
+
#
|
1722
|
+
# * For a user, returns the user ID, for example
|
1723
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1724
|
+
#
|
1725
|
+
# * For an IAM role, returns the IAM role ID, for example
|
1726
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1682
1727
|
# * `SentTimestamp` – Returns the time the message was sent to the
|
1683
1728
|
# queue ([epoch time][1] in milliseconds).
|
1684
1729
|
#
|
@@ -1742,8 +1787,8 @@ module Aws::SQS
|
|
1742
1787
|
# The duration (in seconds) for which the call waits for a message to
|
1743
1788
|
# arrive in the queue before returning. If a message is available, the
|
1744
1789
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1745
|
-
# available and the wait time expires, the call
|
1746
|
-
#
|
1790
|
+
# available and the wait time expires, the call does not return a
|
1791
|
+
# message list.
|
1747
1792
|
#
|
1748
1793
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1749
1794
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1774,10 +1819,6 @@ module Aws::SQS
|
|
1774
1819
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
1775
1820
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
1776
1821
|
#
|
1777
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
1778
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1779
|
-
# `ReceiveRequestAttemptId`.
|
1780
|
-
#
|
1781
1822
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
1782
1823
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1783
1824
|
# modified (deleted or had their visibility changes).
|
@@ -1814,7 +1855,7 @@ module Aws::SQS
|
|
1814
1855
|
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1815
1856
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters
|
1816
1857
|
# (`a-z`, `A-Z`, `0-9`) and punctuation (``
|
1817
|
-
# !"#$%&'()*+,-./:;<=>?@[\]^_
|
1858
|
+
# !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~ ``).
|
1818
1859
|
#
|
1819
1860
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using
|
1820
1861
|
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
@@ -1831,6 +1872,7 @@ module Aws::SQS
|
|
1831
1872
|
class ReceiveMessageRequest < Struct.new(
|
1832
1873
|
:queue_url,
|
1833
1874
|
:attribute_names,
|
1875
|
+
:message_system_attribute_names,
|
1834
1876
|
:message_attribute_names,
|
1835
1877
|
:max_number_of_messages,
|
1836
1878
|
:visibility_timeout,
|
@@ -2013,7 +2055,6 @@ module Aws::SQS
|
|
2013
2055
|
#
|
2014
2056
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2015
2057
|
# `MessageDeduplicationId` overrides the generated one.
|
2016
|
-
#
|
2017
2058
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2018
2059
|
# identical content sent within the deduplication interval are
|
2019
2060
|
# treated as duplicates and only one copy of the message is
|
@@ -2040,7 +2081,7 @@ module Aws::SQS
|
|
2040
2081
|
#
|
2041
2082
|
# The length of `MessageDeduplicationId` is 128 characters.
|
2042
2083
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
2043
|
-
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_
|
2084
|
+
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
|
2044
2085
|
# ``).
|
2045
2086
|
#
|
2046
2087
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
@@ -2075,7 +2116,7 @@ module Aws::SQS
|
|
2075
2116
|
#
|
2076
2117
|
# The length of `MessageGroupId` is 128 characters. Valid values:
|
2077
2118
|
# alphanumeric characters and punctuation ``
|
2078
|
-
# (!"#$%&'()*+,-./:;<=>?@[\]^_
|
2119
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2079
2120
|
#
|
2080
2121
|
# For best practices of using `MessageGroupId`, see [Using the
|
2081
2122
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
@@ -2204,13 +2245,17 @@ module Aws::SQS
|
|
2204
2245
|
# size is 256 KiB.
|
2205
2246
|
#
|
2206
2247
|
# A message can include only XML, JSON, and unformatted text. The
|
2207
|
-
# following Unicode characters are allowed
|
2248
|
+
# following Unicode characters are allowed. For more information, see
|
2249
|
+
# the [W3C specification for characters][1].
|
2208
2250
|
#
|
2209
2251
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to
|
2210
2252
|
# `#xFFFD` \| `#x10000` to `#x10FFFF`
|
2211
2253
|
#
|
2212
|
-
#
|
2213
|
-
#
|
2254
|
+
# Amazon SQS does not throw an exception or completely reject the
|
2255
|
+
# message if it contains invalid characters. Instead, it replaces
|
2256
|
+
# those invalid characters with `U+FFFD` before storing the message in
|
2257
|
+
# the queue, as long as the message body contains at least one valid
|
2258
|
+
# character.
|
2214
2259
|
#
|
2215
2260
|
#
|
2216
2261
|
#
|
@@ -2278,7 +2323,6 @@ module Aws::SQS
|
|
2278
2323
|
#
|
2279
2324
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2280
2325
|
# `MessageDeduplicationId` overrides the generated one.
|
2281
|
-
#
|
2282
2326
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2283
2327
|
# identical content sent within the deduplication interval are
|
2284
2328
|
# treated as duplicates and only one copy of the message is
|
@@ -2305,7 +2349,7 @@ module Aws::SQS
|
|
2305
2349
|
#
|
2306
2350
|
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
2307
2351
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
2308
|
-
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_
|
2352
|
+
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
|
2309
2353
|
# ``).
|
2310
2354
|
#
|
2311
2355
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
@@ -2338,9 +2382,9 @@ module Aws::SQS
|
|
2338
2382
|
# are sorted by time sent. The caller can't specify a
|
2339
2383
|
# `MessageGroupId`.
|
2340
2384
|
#
|
2341
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
2342
|
-
# alphanumeric characters and punctuation ``
|
2343
|
-
# (!"#$%&'()*+,-./:;<=>?@[\]^_
|
2385
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
2386
|
+
# values: alphanumeric characters and punctuation ``
|
2387
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2344
2388
|
#
|
2345
2389
|
# For best practices of using `MessageGroupId`, see [Using the
|
2346
2390
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
@@ -2494,7 +2538,6 @@ module Aws::SQS
|
|
2494
2538
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2495
2539
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2496
2540
|
# the dead-letter-queue.
|
2497
|
-
#
|
2498
2541
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2499
2542
|
# the permissions for the dead-letter queue redrive permission and
|
2500
2543
|
# which source queues can specify dead-letter queues as a JSON
|
@@ -2513,7 +2556,6 @@ module Aws::SQS
|
|
2513
2556
|
#
|
2514
2557
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2515
2558
|
# parameter can specify this queue as the dead-letter queue.
|
2516
|
-
#
|
2517
2559
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2518
2560
|
# source queues that can specify this queue as the dead-letter
|
2519
2561
|
# queue and redrive messages. You can specify this parameter only
|
@@ -2575,7 +2617,6 @@ module Aws::SQS
|
|
2575
2617
|
#
|
2576
2618
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2577
2619
|
# `MessageDeduplicationId` overrides the generated one.
|
2578
|
-
#
|
2579
2620
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2580
2621
|
# identical content sent within the deduplication interval are
|
2581
2622
|
# treated as duplicates and only one copy of the message is
|
@@ -2750,3 +2791,4 @@ module Aws::SQS
|
|
2750
2791
|
|
2751
2792
|
end
|
2752
2793
|
end
|
2794
|
+
|
data/lib/aws-sdk-sqs.rb
CHANGED
@@ -11,18 +11,7 @@
|
|
11
11
|
require 'aws-sdk-core'
|
12
12
|
require 'aws-sigv4'
|
13
13
|
|
14
|
-
|
15
|
-
require_relative 'aws-sdk-sqs/client_api'
|
16
|
-
require_relative 'aws-sdk-sqs/plugins/endpoints.rb'
|
17
|
-
require_relative 'aws-sdk-sqs/client'
|
18
|
-
require_relative 'aws-sdk-sqs/errors'
|
19
|
-
require_relative 'aws-sdk-sqs/resource'
|
20
|
-
require_relative 'aws-sdk-sqs/endpoint_parameters'
|
21
|
-
require_relative 'aws-sdk-sqs/endpoint_provider'
|
22
|
-
require_relative 'aws-sdk-sqs/endpoints'
|
23
|
-
require_relative 'aws-sdk-sqs/message'
|
24
|
-
require_relative 'aws-sdk-sqs/queue'
|
25
|
-
require_relative 'aws-sdk-sqs/customizations'
|
14
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:sqs)
|
26
15
|
|
27
16
|
# This module provides support for Amazon Simple Queue Service. This module is available in the
|
28
17
|
# `aws-sdk-sqs` gem.
|
@@ -53,7 +42,22 @@ require_relative 'aws-sdk-sqs/customizations'
|
|
53
42
|
#
|
54
43
|
# @!group service
|
55
44
|
module Aws::SQS
|
45
|
+
autoload :Types, 'aws-sdk-sqs/types'
|
46
|
+
autoload :ClientApi, 'aws-sdk-sqs/client_api'
|
47
|
+
module Plugins
|
48
|
+
autoload :Endpoints, 'aws-sdk-sqs/plugins/endpoints.rb'
|
49
|
+
end
|
50
|
+
autoload :Client, 'aws-sdk-sqs/client'
|
51
|
+
autoload :Errors, 'aws-sdk-sqs/errors'
|
52
|
+
autoload :Resource, 'aws-sdk-sqs/resource'
|
53
|
+
autoload :EndpointParameters, 'aws-sdk-sqs/endpoint_parameters'
|
54
|
+
autoload :EndpointProvider, 'aws-sdk-sqs/endpoint_provider'
|
55
|
+
autoload :Endpoints, 'aws-sdk-sqs/endpoints'
|
56
|
+
autoload :Message, 'aws-sdk-sqs/message'
|
57
|
+
autoload :Queue, 'aws-sdk-sqs/queue'
|
56
58
|
|
57
|
-
GEM_VERSION = '1.
|
59
|
+
GEM_VERSION = '1.89.0'
|
58
60
|
|
59
61
|
end
|
62
|
+
|
63
|
+
require_relative 'aws-sdk-sqs/customizations'
|