aws-sdk-sqs 1.97.0 → 1.98.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 +51 -32
- data/lib/aws-sdk-sqs/queue.rb +47 -28
- data/lib/aws-sdk-sqs/types.rb +85 -49
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9ad7c6950c8442c03449e68cb819e7080239e2acc65c4618df1956d815d9a5ce
|
4
|
+
data.tar.gz: daf89897cccb890f4a5c8e4980e476e921a84a89c888b5db2c3721f775f45780
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 802fdafdab4f473a51fb8defa5d91235b5621b2347f1898bc12f12a9538d2fffe85fb91348e43d23e5d2fdc2b414fd2c543644ff169c8451b12e3240e70cb70d
|
7
|
+
data.tar.gz: ade74e5a47b7faba95695eaab3aec774e7dd2f032d5481e60fae6ac6e2c35d74c3aeec6ee4b655810826501e92761ccf0d703b9e9b82e0623d0e075af92170da
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.98.0
|
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -807,7 +807,7 @@ module Aws::SQS
|
|
807
807
|
# convert an existing standard queue into a FIFO queue. You must
|
808
808
|
# either create a new FIFO queue for your application or delete your
|
809
809
|
# existing standard queue and recreate it as a FIFO queue. For more
|
810
|
-
# information, see [Moving From a
|
810
|
+
# information, see [Moving From a standard queue to a FIFO queue][1]
|
811
811
|
# in the *Amazon SQS Developer Guide*.
|
812
812
|
#
|
813
813
|
# </note>
|
@@ -1928,8 +1928,7 @@ module Aws::SQS
|
|
1928
1928
|
# producer that calls the ` SendMessage ` action.
|
1929
1929
|
#
|
1930
1930
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
1931
|
-
# calls the ` SendMessage ` action.
|
1932
|
-
# `MessageGroupId` are returned in sequence.
|
1931
|
+
# calls the ` SendMessage ` action.
|
1933
1932
|
#
|
1934
1933
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1935
1934
|
#
|
@@ -1971,8 +1970,7 @@ module Aws::SQS
|
|
1971
1970
|
# producer that calls the ` SendMessage ` action.
|
1972
1971
|
#
|
1973
1972
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
1974
|
-
# calls the ` SendMessage ` action.
|
1975
|
-
# `MessageGroupId` are returned in sequence.
|
1973
|
+
# calls the ` SendMessage ` action.
|
1976
1974
|
#
|
1977
1975
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1978
1976
|
#
|
@@ -2105,7 +2103,8 @@ module Aws::SQS
|
|
2105
2103
|
# * While messages with a particular `MessageGroupId` are invisible, no
|
2106
2104
|
# more messages belonging to the same `MessageGroupId` are returned
|
2107
2105
|
# until the visibility timeout expires. You can still receive messages
|
2108
|
-
# with another `MessageGroupId` as long as
|
2106
|
+
# with another `MessageGroupId` from your FIFO queue as long as they
|
2107
|
+
# are visible.
|
2109
2108
|
#
|
2110
2109
|
# * If a caller of `ReceiveMessage` can't track the
|
2111
2110
|
# `ReceiveRequestAttemptId`, no retries work until the original
|
@@ -2228,7 +2227,7 @@ module Aws::SQS
|
|
2228
2227
|
#
|
2229
2228
|
# Amazon SQS does not throw an exception or completely reject the
|
2230
2229
|
# message if it contains invalid characters. Instead, it replaces those
|
2231
|
-
# invalid characters with
|
2230
|
+
# invalid characters with U+FFFD before storing the message in the
|
2232
2231
|
# queue, as long as the message body contains at least one valid
|
2233
2232
|
# character.
|
2234
2233
|
#
|
@@ -2254,7 +2253,7 @@ module Aws::SQS
|
|
2254
2253
|
#
|
2255
2254
|
# Amazon SQS does not throw an exception or completely reject the
|
2256
2255
|
# message if it contains invalid characters. Instead, it replaces those
|
2257
|
-
# invalid characters with
|
2256
|
+
# invalid characters with U+FFFD before storing the message in the
|
2258
2257
|
# queue, as long as the message body contains at least one valid
|
2259
2258
|
# character.
|
2260
2259
|
#
|
@@ -2356,34 +2355,54 @@ module Aws::SQS
|
|
2356
2355
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
2357
2356
|
#
|
2358
2357
|
# @option params [String] :message_group_id
|
2359
|
-
#
|
2360
|
-
#
|
2361
|
-
#
|
2362
|
-
#
|
2363
|
-
#
|
2364
|
-
# processed
|
2365
|
-
#
|
2366
|
-
#
|
2367
|
-
#
|
2368
|
-
#
|
2369
|
-
#
|
2370
|
-
#
|
2371
|
-
#
|
2372
|
-
#
|
2373
|
-
#
|
2358
|
+
# `MessageGroupId` is an attribute used in Amazon SQS FIFO
|
2359
|
+
# (First-In-First-Out) and standard queues. In FIFO queues,
|
2360
|
+
# `MessageGroupId` organizes messages into distinct groups. Messages
|
2361
|
+
# within the same message group are always processed one at a time, in
|
2362
|
+
# strict order, ensuring that no two messages from the same group are
|
2363
|
+
# processed simultaneously. In standard queues, using `MessageGroupId`
|
2364
|
+
# enables fair queues. It is used to identify the tenant a message
|
2365
|
+
# belongs to, helping maintain consistent message dwell time across all
|
2366
|
+
# tenants during noisy neighbor events. Unlike FIFO queues, messages
|
2367
|
+
# with the same `MessageGroupId` can be processed in parallel,
|
2368
|
+
# maintaining the high throughput of standard queues.
|
2369
|
+
#
|
2370
|
+
# * **FIFO queues:** `MessageGroupId` acts as the tag that specifies
|
2371
|
+
# that a message belongs to a specific message group. Messages that
|
2372
|
+
# belong to the same message group are processed in a FIFO manner
|
2373
|
+
# (however, messages in different message groups might be processed
|
2374
|
+
# out of order). To interleave multiple ordered streams within a
|
2375
|
+
# single queue, use `MessageGroupId` values (for example, session data
|
2376
|
+
# for multiple users). In this scenario, multiple consumers can
|
2377
|
+
# process the queue, but the session data of each user is processed in
|
2378
|
+
# a FIFO fashion.
|
2379
|
+
#
|
2380
|
+
# If you do not provide a `MessageGroupId` when sending a message to a
|
2381
|
+
# FIFO queue, the action fails.
|
2382
|
+
#
|
2383
|
+
# `ReceiveMessage` might return messages with multiple
|
2374
2384
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
2375
|
-
# sorted by time sent.
|
2376
|
-
#
|
2377
|
-
#
|
2378
|
-
#
|
2385
|
+
# sorted by time sent.
|
2386
|
+
#
|
2387
|
+
# * **Standard queues:**Use `MessageGroupId` in standard queues to
|
2388
|
+
# enable fair queues. The `MessageGroupId` identifies the tenant a
|
2389
|
+
# message belongs to. A tenant can be any entity that shares a queue
|
2390
|
+
# with others, such as your customer, a client application, or a
|
2391
|
+
# request type. When one tenant sends a disproportionately large
|
2392
|
+
# volume of messages or has messages that require longer processing
|
2393
|
+
# time, fair queues ensure other tenants' messages maintain low dwell
|
2394
|
+
# time. This preserves quality of service for all tenants while
|
2395
|
+
# maintaining the scalability and throughput of standard queues. We
|
2396
|
+
# recommend that you include a `MessageGroupId` in all messages when
|
2397
|
+
# using fair queues.
|
2398
|
+
#
|
2399
|
+
# The length of `MessageGroupId` is 128 characters. Valid values:
|
2400
|
+
# alphanumeric characters and punctuation ``
|
2379
2401
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2380
2402
|
#
|
2381
2403
|
# For best practices of using `MessageGroupId`, see [Using the
|
2382
2404
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2383
2405
|
#
|
2384
|
-
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2385
|
-
# Standard queues.
|
2386
|
-
#
|
2387
2406
|
#
|
2388
2407
|
#
|
2389
2408
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
@@ -2465,7 +2484,7 @@ module Aws::SQS
|
|
2465
2484
|
#
|
2466
2485
|
# Amazon SQS does not throw an exception or completely reject the
|
2467
2486
|
# message if it contains invalid characters. Instead, it replaces those
|
2468
|
-
# invalid characters with
|
2487
|
+
# invalid characters with U+FFFD before storing the message in the
|
2469
2488
|
# queue, as long as the message body contains at least one valid
|
2470
2489
|
# character.
|
2471
2490
|
#
|
@@ -2967,7 +2986,7 @@ module Aws::SQS
|
|
2967
2986
|
tracer: tracer
|
2968
2987
|
)
|
2969
2988
|
context[:gem_name] = 'aws-sdk-sqs'
|
2970
|
-
context[:gem_version] = '1.
|
2989
|
+
context[:gem_version] = '1.98.0'
|
2971
2990
|
Seahorse::Client::Request.new(handlers, context)
|
2972
2991
|
end
|
2973
2992
|
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -251,8 +251,7 @@ module Aws::SQS
|
|
251
251
|
# producer that calls the ` SendMessage ` action.
|
252
252
|
#
|
253
253
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
254
|
-
# calls the ` SendMessage ` action.
|
255
|
-
# `MessageGroupId` are returned in sequence.
|
254
|
+
# calls the ` SendMessage ` action.
|
256
255
|
#
|
257
256
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
258
257
|
#
|
@@ -293,8 +292,7 @@ module Aws::SQS
|
|
293
292
|
# producer that calls the ` SendMessage ` action.
|
294
293
|
#
|
295
294
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
296
|
-
# calls the ` SendMessage ` action.
|
297
|
-
# `MessageGroupId` are returned in sequence.
|
295
|
+
# calls the ` SendMessage ` action.
|
298
296
|
#
|
299
297
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
300
298
|
#
|
@@ -422,7 +420,8 @@ module Aws::SQS
|
|
422
420
|
# * While messages with a particular `MessageGroupId` are invisible, no
|
423
421
|
# more messages belonging to the same `MessageGroupId` are returned
|
424
422
|
# until the visibility timeout expires. You can still receive messages
|
425
|
-
# with another `MessageGroupId` as long as
|
423
|
+
# with another `MessageGroupId` from your FIFO queue as long as they
|
424
|
+
# are visible.
|
426
425
|
#
|
427
426
|
# * If a caller of `ReceiveMessage` can't track the
|
428
427
|
# `ReceiveRequestAttemptId`, no retries work until the original
|
@@ -518,7 +517,7 @@ module Aws::SQS
|
|
518
517
|
#
|
519
518
|
# Amazon SQS does not throw an exception or completely reject the
|
520
519
|
# message if it contains invalid characters. Instead, it replaces those
|
521
|
-
# invalid characters with
|
520
|
+
# invalid characters with U+FFFD before storing the message in the
|
522
521
|
# queue, as long as the message body contains at least one valid
|
523
522
|
# character.
|
524
523
|
#
|
@@ -615,34 +614,54 @@ module Aws::SQS
|
|
615
614
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
616
615
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
617
616
|
# @option options [String] :message_group_id
|
618
|
-
#
|
619
|
-
#
|
620
|
-
#
|
621
|
-
#
|
622
|
-
#
|
623
|
-
# processed
|
624
|
-
#
|
625
|
-
#
|
626
|
-
#
|
627
|
-
#
|
628
|
-
#
|
629
|
-
#
|
630
|
-
#
|
631
|
-
#
|
632
|
-
#
|
617
|
+
# `MessageGroupId` is an attribute used in Amazon SQS FIFO
|
618
|
+
# (First-In-First-Out) and standard queues. In FIFO queues,
|
619
|
+
# `MessageGroupId` organizes messages into distinct groups. Messages
|
620
|
+
# within the same message group are always processed one at a time, in
|
621
|
+
# strict order, ensuring that no two messages from the same group are
|
622
|
+
# processed simultaneously. In standard queues, using `MessageGroupId`
|
623
|
+
# enables fair queues. It is used to identify the tenant a message
|
624
|
+
# belongs to, helping maintain consistent message dwell time across all
|
625
|
+
# tenants during noisy neighbor events. Unlike FIFO queues, messages
|
626
|
+
# with the same `MessageGroupId` can be processed in parallel,
|
627
|
+
# maintaining the high throughput of standard queues.
|
628
|
+
#
|
629
|
+
# * **FIFO queues:** `MessageGroupId` acts as the tag that specifies
|
630
|
+
# that a message belongs to a specific message group. Messages that
|
631
|
+
# belong to the same message group are processed in a FIFO manner
|
632
|
+
# (however, messages in different message groups might be processed
|
633
|
+
# out of order). To interleave multiple ordered streams within a
|
634
|
+
# single queue, use `MessageGroupId` values (for example, session data
|
635
|
+
# for multiple users). In this scenario, multiple consumers can
|
636
|
+
# process the queue, but the session data of each user is processed in
|
637
|
+
# a FIFO fashion.
|
638
|
+
#
|
639
|
+
# If you do not provide a `MessageGroupId` when sending a message to a
|
640
|
+
# FIFO queue, the action fails.
|
641
|
+
#
|
642
|
+
# `ReceiveMessage` might return messages with multiple
|
633
643
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
634
|
-
# sorted by time sent.
|
635
|
-
#
|
636
|
-
#
|
637
|
-
#
|
644
|
+
# sorted by time sent.
|
645
|
+
#
|
646
|
+
# * **Standard queues:**Use `MessageGroupId` in standard queues to
|
647
|
+
# enable fair queues. The `MessageGroupId` identifies the tenant a
|
648
|
+
# message belongs to. A tenant can be any entity that shares a queue
|
649
|
+
# with others, such as your customer, a client application, or a
|
650
|
+
# request type. When one tenant sends a disproportionately large
|
651
|
+
# volume of messages or has messages that require longer processing
|
652
|
+
# time, fair queues ensure other tenants' messages maintain low dwell
|
653
|
+
# time. This preserves quality of service for all tenants while
|
654
|
+
# maintaining the scalability and throughput of standard queues. We
|
655
|
+
# recommend that you include a `MessageGroupId` in all messages when
|
656
|
+
# using fair queues.
|
657
|
+
#
|
658
|
+
# The length of `MessageGroupId` is 128 characters. Valid values:
|
659
|
+
# alphanumeric characters and punctuation ``
|
638
660
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
639
661
|
#
|
640
662
|
# For best practices of using `MessageGroupId`, see [Using the
|
641
663
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
642
664
|
#
|
643
|
-
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
644
|
-
# Standard queues.
|
645
|
-
#
|
646
665
|
#
|
647
666
|
#
|
648
667
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -1696,8 +1696,7 @@ module Aws::SQS
|
|
1696
1696
|
# producer that calls the ` SendMessage ` action.
|
1697
1697
|
#
|
1698
1698
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
1699
|
-
# calls the ` SendMessage ` action.
|
1700
|
-
# `MessageGroupId` are returned in sequence.
|
1699
|
+
# calls the ` SendMessage ` action.
|
1701
1700
|
#
|
1702
1701
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1703
1702
|
#
|
@@ -1742,8 +1741,7 @@ module Aws::SQS
|
|
1742
1741
|
# producer that calls the ` SendMessage ` action.
|
1743
1742
|
#
|
1744
1743
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
1745
|
-
# calls the ` SendMessage ` action.
|
1746
|
-
# `MessageGroupId` are returned in sequence.
|
1744
|
+
# calls the ` SendMessage ` action.
|
1747
1745
|
#
|
1748
1746
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1749
1747
|
#
|
@@ -1884,8 +1882,8 @@ module Aws::SQS
|
|
1884
1882
|
# * While messages with a particular `MessageGroupId` are invisible,
|
1885
1883
|
# no more messages belonging to the same `MessageGroupId` are
|
1886
1884
|
# returned until the visibility timeout expires. You can still
|
1887
|
-
# receive messages with another `MessageGroupId`
|
1888
|
-
#
|
1885
|
+
# receive messages with another `MessageGroupId` from your FIFO
|
1886
|
+
# queue as long as they are visible.
|
1889
1887
|
#
|
1890
1888
|
# * If a caller of `ReceiveMessage` can't track the
|
1891
1889
|
# `ReceiveRequestAttemptId`, no retries work until the original
|
@@ -2133,24 +2131,46 @@ module Aws::SQS
|
|
2133
2131
|
# @return [String]
|
2134
2132
|
#
|
2135
2133
|
# @!attribute [rw] message_group_id
|
2136
|
-
#
|
2137
|
-
#
|
2138
|
-
#
|
2139
|
-
#
|
2140
|
-
#
|
2141
|
-
#
|
2142
|
-
#
|
2143
|
-
#
|
2144
|
-
#
|
2145
|
-
#
|
2146
|
-
#
|
2147
|
-
#
|
2148
|
-
#
|
2149
|
-
#
|
2150
|
-
#
|
2134
|
+
# `MessageGroupId` is an attribute used in Amazon SQS FIFO
|
2135
|
+
# (First-In-First-Out) and standard queues. In FIFO queues,
|
2136
|
+
# `MessageGroupId` organizes messages into distinct groups. Messages
|
2137
|
+
# within the same message group are always processed one at a time, in
|
2138
|
+
# strict order, ensuring that no two messages from the same group are
|
2139
|
+
# processed simultaneously. In standard queues, using `MessageGroupId`
|
2140
|
+
# enables fair queues. It is used to identify the tenant a message
|
2141
|
+
# belongs to, helping maintain consistent message dwell time across
|
2142
|
+
# all tenants during noisy neighbor events. Unlike FIFO queues,
|
2143
|
+
# messages with the same `MessageGroupId` can be processed in
|
2144
|
+
# parallel, maintaining the high throughput of standard queues.
|
2145
|
+
#
|
2146
|
+
# * **FIFO queues:** `MessageGroupId` acts as the tag that specifies
|
2147
|
+
# that a message belongs to a specific message group. Messages that
|
2148
|
+
# belong to the same message group are processed in a FIFO manner
|
2149
|
+
# (however, messages in different message groups might be processed
|
2150
|
+
# out of order). To interleave multiple ordered streams within a
|
2151
|
+
# single queue, use `MessageGroupId` values (for example, session
|
2152
|
+
# data for multiple users). In this scenario, multiple consumers can
|
2153
|
+
# process the queue, but the session data of each user is processed
|
2154
|
+
# in a FIFO fashion.
|
2155
|
+
#
|
2156
|
+
# If you do not provide a `MessageGroupId` when sending a message to
|
2157
|
+
# a FIFO queue, the action fails.
|
2158
|
+
#
|
2159
|
+
# `ReceiveMessage` might return messages with multiple
|
2151
2160
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages
|
2152
|
-
# are sorted by time sent.
|
2153
|
-
#
|
2161
|
+
# are sorted by time sent.
|
2162
|
+
#
|
2163
|
+
# * **Standard queues:**Use `MessageGroupId` in standard queues to
|
2164
|
+
# enable fair queues. The `MessageGroupId` identifies the tenant a
|
2165
|
+
# message belongs to. A tenant can be any entity that shares a queue
|
2166
|
+
# with others, such as your customer, a client application, or a
|
2167
|
+
# request type. When one tenant sends a disproportionately large
|
2168
|
+
# volume of messages or has messages that require longer processing
|
2169
|
+
# time, fair queues ensure other tenants' messages maintain low
|
2170
|
+
# dwell time. This preserves quality of service for all tenants
|
2171
|
+
# while maintaining the scalability and throughput of standard
|
2172
|
+
# queues. We recommend that you include a `MessageGroupId` in all
|
2173
|
+
# messages when using fair queues.
|
2154
2174
|
#
|
2155
2175
|
# The length of `MessageGroupId` is 128 characters. Valid values:
|
2156
2176
|
# alphanumeric characters and punctuation ``
|
@@ -2159,9 +2179,6 @@ module Aws::SQS
|
|
2159
2179
|
# For best practices of using `MessageGroupId`, see [Using the
|
2160
2180
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2161
2181
|
#
|
2162
|
-
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2163
|
-
# Standard queues.
|
2164
|
-
#
|
2165
2182
|
#
|
2166
2183
|
#
|
2167
2184
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
@@ -2291,7 +2308,7 @@ module Aws::SQS
|
|
2291
2308
|
#
|
2292
2309
|
# Amazon SQS does not throw an exception or completely reject the
|
2293
2310
|
# message if it contains invalid characters. Instead, it replaces
|
2294
|
-
# those invalid characters with
|
2311
|
+
# those invalid characters with U+FFFD before storing the message in
|
2295
2312
|
# the queue, as long as the message body contains at least one valid
|
2296
2313
|
# character.
|
2297
2314
|
#
|
@@ -2401,35 +2418,54 @@ module Aws::SQS
|
|
2401
2418
|
# @return [String]
|
2402
2419
|
#
|
2403
2420
|
# @!attribute [rw] message_group_id
|
2404
|
-
#
|
2405
|
-
#
|
2406
|
-
#
|
2407
|
-
#
|
2408
|
-
#
|
2409
|
-
#
|
2410
|
-
#
|
2411
|
-
#
|
2412
|
-
#
|
2413
|
-
#
|
2414
|
-
#
|
2415
|
-
#
|
2416
|
-
#
|
2417
|
-
#
|
2418
|
-
#
|
2421
|
+
# `MessageGroupId` is an attribute used in Amazon SQS FIFO
|
2422
|
+
# (First-In-First-Out) and standard queues. In FIFO queues,
|
2423
|
+
# `MessageGroupId` organizes messages into distinct groups. Messages
|
2424
|
+
# within the same message group are always processed one at a time, in
|
2425
|
+
# strict order, ensuring that no two messages from the same group are
|
2426
|
+
# processed simultaneously. In standard queues, using `MessageGroupId`
|
2427
|
+
# enables fair queues. It is used to identify the tenant a message
|
2428
|
+
# belongs to, helping maintain consistent message dwell time across
|
2429
|
+
# all tenants during noisy neighbor events. Unlike FIFO queues,
|
2430
|
+
# messages with the same `MessageGroupId` can be processed in
|
2431
|
+
# parallel, maintaining the high throughput of standard queues.
|
2432
|
+
#
|
2433
|
+
# * **FIFO queues:** `MessageGroupId` acts as the tag that specifies
|
2434
|
+
# that a message belongs to a specific message group. Messages that
|
2435
|
+
# belong to the same message group are processed in a FIFO manner
|
2436
|
+
# (however, messages in different message groups might be processed
|
2437
|
+
# out of order). To interleave multiple ordered streams within a
|
2438
|
+
# single queue, use `MessageGroupId` values (for example, session
|
2439
|
+
# data for multiple users). In this scenario, multiple consumers can
|
2440
|
+
# process the queue, but the session data of each user is processed
|
2441
|
+
# in a FIFO fashion.
|
2442
|
+
#
|
2443
|
+
# If you do not provide a `MessageGroupId` when sending a message to
|
2444
|
+
# a FIFO queue, the action fails.
|
2445
|
+
#
|
2446
|
+
# `ReceiveMessage` might return messages with multiple
|
2419
2447
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages
|
2420
|
-
# are sorted by time sent.
|
2421
|
-
#
|
2448
|
+
# are sorted by time sent.
|
2449
|
+
#
|
2450
|
+
# * **Standard queues:**Use `MessageGroupId` in standard queues to
|
2451
|
+
# enable fair queues. The `MessageGroupId` identifies the tenant a
|
2452
|
+
# message belongs to. A tenant can be any entity that shares a queue
|
2453
|
+
# with others, such as your customer, a client application, or a
|
2454
|
+
# request type. When one tenant sends a disproportionately large
|
2455
|
+
# volume of messages or has messages that require longer processing
|
2456
|
+
# time, fair queues ensure other tenants' messages maintain low
|
2457
|
+
# dwell time. This preserves quality of service for all tenants
|
2458
|
+
# while maintaining the scalability and throughput of standard
|
2459
|
+
# queues. We recommend that you include a `MessageGroupId` in all
|
2460
|
+
# messages when using fair queues.
|
2422
2461
|
#
|
2423
|
-
# The
|
2424
|
-
#
|
2462
|
+
# The length of `MessageGroupId` is 128 characters. Valid values:
|
2463
|
+
# alphanumeric characters and punctuation ``
|
2425
2464
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2426
2465
|
#
|
2427
2466
|
# For best practices of using `MessageGroupId`, see [Using the
|
2428
2467
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2429
2468
|
#
|
2430
|
-
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2431
|
-
# Standard queues.
|
2432
|
-
#
|
2433
2469
|
#
|
2434
2470
|
#
|
2435
2471
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
data/lib/aws-sdk-sqs.rb
CHANGED