aws-sdk-sqs 1.72.0 → 1.74.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +65 -25
- data/lib/aws-sdk-sqs/client_api.rb +5 -1
- data/lib/aws-sdk-sqs/queue.rb +52 -8
- data/lib/aws-sdk-sqs/types.rb +59 -10
- data/lib/aws-sdk-sqs.rb +1 -1
- data/sig/client.rbs +1 -0
- data/sig/message.rbs +1 -1
- data/sig/queue.rbs +1 -0
- data/sig/types.rbs +2 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fc5187aae4f2ff8cb7afd695914df952a88b595a8c2ccb7f2c0eab41fd4fb782
|
4
|
+
data.tar.gz: 01215c3ed52f030db8bd2c6ba84501fd83d9761a920a79deca6dea6114bc86d4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0324979825cdc32f6d84aa503682af27ff99814ab18aa7823a54d205465bd985a19004e23b3e873a40aa50b280ab5d143e4881669a0025ebaf5068f2ce6c201b'
|
7
|
+
data.tar.gz: 45b5709b6b260a5e5d5c3a2af8477f1982cf4940e752ed6b17a3b9b24c07b9f4ad6dba637b85dc6886c1d3a11d00de7659bf0b31661c3ef3f999c52c5c733d4c
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.74.0 (2024-05-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.73.0 (2024-05-08)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds MessageSystemAttributeNames to ReceiveMessageRequest to replace AttributeNames.
|
13
|
+
|
4
14
|
1.72.0 (2024-04-30)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.74.0
|
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -305,8 +305,9 @@ module Aws::SQS
|
|
305
305
|
#
|
306
306
|
# @option options [String] :sdk_ua_app_id
|
307
307
|
# A unique and opaque application ID that is appended to the
|
308
|
-
# User-Agent header as app
|
309
|
-
# maximum length of 50.
|
308
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
309
|
+
# maximum length of 50. This variable is sourced from environment
|
310
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
310
311
|
#
|
311
312
|
# @option options [String] :secret_access_key
|
312
313
|
#
|
@@ -542,8 +543,6 @@ module Aws::SQS
|
|
542
543
|
# can be the original source queue (from which the messages were
|
543
544
|
# driven to the dead-letter-queue), or a custom destination queue.
|
544
545
|
#
|
545
|
-
# * Currently, only standard queues are supported.
|
546
|
-
#
|
547
546
|
# * Only one active message movement task is supported per queue at any
|
548
547
|
# given time.
|
549
548
|
#
|
@@ -1570,8 +1569,6 @@ module Aws::SQS
|
|
1570
1569
|
# can be the original source queue (from which the messages were
|
1571
1570
|
# driven to the dead-letter-queue), or a custom destination queue.
|
1572
1571
|
#
|
1573
|
-
# * Currently, only standard queues are supported.
|
1574
|
-
#
|
1575
1572
|
# * Only one active message movement task is supported per queue at any
|
1576
1573
|
# given time.
|
1577
1574
|
#
|
@@ -1833,6 +1830,54 @@ module Aws::SQS
|
|
1833
1830
|
# Queue URLs and names are case-sensitive.
|
1834
1831
|
#
|
1835
1832
|
# @option params [Array<String>] :attribute_names
|
1833
|
+
# This parameter has been deprecated but will be supported for backward
|
1834
|
+
# compatibility. To provide attribute names, you are encouraged to use
|
1835
|
+
# `MessageSystemAttributeNames`.
|
1836
|
+
#
|
1837
|
+
# A list of attributes that need to be returned along with each message.
|
1838
|
+
# These attributes include:
|
1839
|
+
#
|
1840
|
+
# * `All` – Returns all values.
|
1841
|
+
#
|
1842
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1843
|
+
# was first received from the queue ([epoch time][1] in milliseconds).
|
1844
|
+
#
|
1845
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1846
|
+
# has been received across all queues but not deleted.
|
1847
|
+
#
|
1848
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1849
|
+
#
|
1850
|
+
# * `SenderId`
|
1851
|
+
#
|
1852
|
+
# * For a user, returns the user ID, for example
|
1853
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1854
|
+
#
|
1855
|
+
# * For an IAM role, returns the IAM role ID, for example
|
1856
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1857
|
+
#
|
1858
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1859
|
+
# ([epoch time][1] in milliseconds).
|
1860
|
+
#
|
1861
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
1862
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
1863
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
1864
|
+
#
|
1865
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1866
|
+
# producer that calls the ` SendMessage ` action.
|
1867
|
+
#
|
1868
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1869
|
+
# calls the ` SendMessage ` action. Messages with the same
|
1870
|
+
# `MessageGroupId` are returned in sequence.
|
1871
|
+
#
|
1872
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1873
|
+
#
|
1874
|
+
#
|
1875
|
+
#
|
1876
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1877
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1878
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1879
|
+
#
|
1880
|
+
# @option params [Array<String>] :message_system_attribute_names
|
1836
1881
|
# A list of attributes that need to be returned along with each message.
|
1837
1882
|
# These attributes include:
|
1838
1883
|
#
|
@@ -1912,8 +1957,8 @@ module Aws::SQS
|
|
1912
1957
|
# The duration (in seconds) for which the call waits for a message to
|
1913
1958
|
# arrive in the queue before returning. If a message is available, the
|
1914
1959
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1915
|
-
# available and the wait time expires, the call
|
1916
|
-
#
|
1960
|
+
# available and the wait time expires, the call does not return a
|
1961
|
+
# message list.
|
1917
1962
|
#
|
1918
1963
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1919
1964
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1942,10 +1987,6 @@ module Aws::SQS
|
|
1942
1987
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
1943
1988
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
1944
1989
|
#
|
1945
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
1946
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1947
|
-
# `ReceiveRequestAttemptId`.
|
1948
|
-
#
|
1949
1990
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
1950
1991
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
1951
1992
|
# (deleted or had their visibility changes).
|
@@ -2000,6 +2041,7 @@ module Aws::SQS
|
|
2000
2041
|
# resp = client.receive_message({
|
2001
2042
|
# queue_url: "String", # required
|
2002
2043
|
# 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
|
2044
|
+
# message_system_attribute_names: ["All"], # accepts All, SenderId, SentTimestamp, ApproximateReceiveCount, ApproximateFirstReceiveTimestamp, SequenceNumber, MessageDeduplicationId, MessageGroupId, AWSTraceHeader, DeadLetterQueueSourceArn
|
2003
2045
|
# message_attribute_names: ["MessageAttributeName"],
|
2004
2046
|
# max_number_of_messages: 1,
|
2005
2047
|
# visibility_timeout: 1,
|
@@ -2231,8 +2273,8 @@ module Aws::SQS
|
|
2231
2273
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
2232
2274
|
# sorted by time sent. The caller can't specify a `MessageGroupId`.
|
2233
2275
|
#
|
2234
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
2235
|
-
# alphanumeric characters and punctuation ``
|
2276
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
2277
|
+
# values: alphanumeric characters and punctuation ``
|
2236
2278
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
2237
2279
|
#
|
2238
2280
|
# For best practices of using `MessageGroupId`, see [Using the
|
@@ -2399,13 +2441,14 @@ module Aws::SQS
|
|
2399
2441
|
req.send_request(options)
|
2400
2442
|
end
|
2401
2443
|
|
2402
|
-
# Sets the value of one or more queue attributes
|
2403
|
-
# queue's attributes, the change can take up to 60 seconds
|
2404
|
-
# the attributes to propagate throughout the Amazon SQS
|
2405
|
-
# made to the `MessageRetentionPeriod` attribute can
|
2406
|
-
# minutes and will impact existing messages in the queue
|
2407
|
-
# causing them to be expired and deleted if the
|
2408
|
-
# is reduced below the age of existing
|
2444
|
+
# Sets the value of one or more queue attributes, like a policy. When
|
2445
|
+
# you change a queue's attributes, the change can take up to 60 seconds
|
2446
|
+
# for most of the attributes to propagate throughout the Amazon SQS
|
2447
|
+
# system. Changes made to the `MessageRetentionPeriod` attribute can
|
2448
|
+
# take up to 15 minutes and will impact existing messages in the queue
|
2449
|
+
# potentially causing them to be expired and deleted if the
|
2450
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
2451
|
+
# messages.
|
2409
2452
|
#
|
2410
2453
|
# <note markdown="1"> * In the future, new attributes might be added. If you write code that
|
2411
2454
|
# calls this action, we recommend that you structure your code so that
|
@@ -2653,9 +2696,6 @@ module Aws::SQS
|
|
2653
2696
|
# original source queue (from which the messages were driven to the
|
2654
2697
|
# dead-letter-queue), or a custom destination queue.
|
2655
2698
|
#
|
2656
|
-
# * Currently, only standard queues support redrive. FIFO queues don't
|
2657
|
-
# support redrive.
|
2658
|
-
#
|
2659
2699
|
# * Only one active message movement task is supported per queue at any
|
2660
2700
|
# given time.
|
2661
2701
|
#
|
@@ -2820,7 +2860,7 @@ module Aws::SQS
|
|
2820
2860
|
params: params,
|
2821
2861
|
config: config)
|
2822
2862
|
context[:gem_name] = 'aws-sdk-sqs'
|
2823
|
-
context[:gem_version] = '1.
|
2863
|
+
context[:gem_version] = '1.74.0'
|
2824
2864
|
Seahorse::Client::Request.new(handlers, context)
|
2825
2865
|
end
|
2826
2866
|
|
@@ -83,6 +83,7 @@ module Aws::SQS
|
|
83
83
|
MessageBodySystemAttributeMap = Shapes::MapShape.new(name: 'MessageBodySystemAttributeMap', flattened: true)
|
84
84
|
MessageList = Shapes::ListShape.new(name: 'MessageList', flattened: true)
|
85
85
|
MessageNotInflight = Shapes::StructureShape.new(name: 'MessageNotInflight')
|
86
|
+
MessageSystemAttributeList = Shapes::ListShape.new(name: 'MessageSystemAttributeList', flattened: true)
|
86
87
|
MessageSystemAttributeMap = Shapes::MapShape.new(name: 'MessageSystemAttributeMap', flattened: true)
|
87
88
|
MessageSystemAttributeName = Shapes::StringShape.new(name: 'MessageSystemAttributeName')
|
88
89
|
MessageSystemAttributeNameForSends = Shapes::StringShape.new(name: 'MessageSystemAttributeNameForSends')
|
@@ -350,6 +351,8 @@ module Aws::SQS
|
|
350
351
|
|
351
352
|
MessageNotInflight.struct_class = Types::MessageNotInflight
|
352
353
|
|
354
|
+
MessageSystemAttributeList.member = Shapes::ShapeRef.new(shape: MessageSystemAttributeName)
|
355
|
+
|
353
356
|
MessageSystemAttributeMap.key = Shapes::ShapeRef.new(shape: MessageSystemAttributeName)
|
354
357
|
MessageSystemAttributeMap.value = Shapes::ShapeRef.new(shape: String)
|
355
358
|
|
@@ -387,7 +390,8 @@ module Aws::SQS
|
|
387
390
|
ReceiptHandleIsInvalid.struct_class = Types::ReceiptHandleIsInvalid
|
388
391
|
|
389
392
|
ReceiveMessageRequest.add_member(:queue_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "QueueUrl"))
|
390
|
-
ReceiveMessageRequest.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNameList, location_name: "AttributeNames"))
|
393
|
+
ReceiveMessageRequest.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNameList, deprecated: true, location_name: "AttributeNames", metadata: {"deprecatedMessage"=>"AttributeNames has been replaced by MessageSystemAttributeNames"}))
|
394
|
+
ReceiveMessageRequest.add_member(:message_system_attribute_names, Shapes::ShapeRef.new(shape: MessageSystemAttributeList, location_name: "MessageSystemAttributeNames"))
|
391
395
|
ReceiveMessageRequest.add_member(:message_attribute_names, Shapes::ShapeRef.new(shape: MessageAttributeNameList, location_name: "MessageAttributeNames"))
|
392
396
|
ReceiveMessageRequest.add_member(:max_number_of_messages, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "MaxNumberOfMessages"))
|
393
397
|
ReceiveMessageRequest.add_member(:visibility_timeout, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "VisibilityTimeout"))
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -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,53 @@ 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
|
+
#
|
223
|
+
# A list of attributes that need to be returned along with each message.
|
224
|
+
# These attributes include:
|
225
|
+
#
|
226
|
+
# * `All` – Returns all values.
|
227
|
+
#
|
228
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
229
|
+
# was first received from the queue ([epoch time][1] in milliseconds).
|
230
|
+
#
|
231
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
232
|
+
# has been received across all queues but not deleted.
|
233
|
+
#
|
234
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
235
|
+
#
|
236
|
+
# * `SenderId`
|
237
|
+
#
|
238
|
+
# * For a user, returns the user ID, for example
|
239
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
240
|
+
#
|
241
|
+
# * For an IAM role, returns the IAM role ID, for example
|
242
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
243
|
+
#
|
244
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
245
|
+
# ([epoch time][1] in milliseconds).
|
246
|
+
#
|
247
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
248
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
249
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
250
|
+
#
|
251
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
252
|
+
# producer that calls the ` SendMessage ` action.
|
253
|
+
#
|
254
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
255
|
+
# calls the ` SendMessage ` action. Messages with the same
|
256
|
+
# `MessageGroupId` are returned in sequence.
|
257
|
+
#
|
258
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
259
|
+
#
|
260
|
+
#
|
261
|
+
#
|
262
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
263
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
264
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
265
|
+
# @option options [Array<String>] :message_system_attribute_names
|
218
266
|
# A list of attributes that need to be returned along with each message.
|
219
267
|
# These attributes include:
|
220
268
|
#
|
@@ -290,8 +338,8 @@ module Aws::SQS
|
|
290
338
|
# The duration (in seconds) for which the call waits for a message to
|
291
339
|
# arrive in the queue before returning. If a message is available, the
|
292
340
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
293
|
-
# available and the wait time expires, the call
|
294
|
-
#
|
341
|
+
# available and the wait time expires, the call does not return a
|
342
|
+
# message list.
|
295
343
|
#
|
296
344
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
297
345
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -319,10 +367,6 @@ module Aws::SQS
|
|
319
367
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
320
368
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
321
369
|
#
|
322
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
323
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
324
|
-
# `ReceiveRequestAttemptId`.
|
325
|
-
#
|
326
370
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
327
371
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
328
372
|
# (deleted or had their visibility changes).
|
@@ -555,8 +599,8 @@ module Aws::SQS
|
|
555
599
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
556
600
|
# sorted by time sent. The caller can't specify a `MessageGroupId`.
|
557
601
|
#
|
558
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
559
|
-
# alphanumeric characters and punctuation ``
|
602
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
603
|
+
# values: alphanumeric characters and punctuation ``
|
560
604
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
561
605
|
#
|
562
606
|
# For best practices of using `MessageGroupId`, see [Using the
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -1245,8 +1245,9 @@ module Aws::SQS
|
|
1245
1245
|
#
|
1246
1246
|
# @!attribute [rw] approximate_number_of_messages_to_move
|
1247
1247
|
# 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
|
1248
|
+
# number is obtained at the time of starting the message movement task
|
1249
|
+
# and is only included after the message movement task is selected to
|
1250
|
+
# start.
|
1250
1251
|
# @return [Integer]
|
1251
1252
|
#
|
1252
1253
|
# @!attribute [rw] failure_reason
|
@@ -1657,6 +1658,57 @@ module Aws::SQS
|
|
1657
1658
|
# @return [String]
|
1658
1659
|
#
|
1659
1660
|
# @!attribute [rw] attribute_names
|
1661
|
+
# This parameter has been deprecated but will be supported for
|
1662
|
+
# backward compatibility. To provide attribute names, you are
|
1663
|
+
# encouraged to use `MessageSystemAttributeNames`.
|
1664
|
+
#
|
1665
|
+
# A list of attributes that need to be returned along with each
|
1666
|
+
# message. These attributes include:
|
1667
|
+
#
|
1668
|
+
# * `All` – Returns all values.
|
1669
|
+
#
|
1670
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1671
|
+
# was first received from the queue ([epoch time][1] in
|
1672
|
+
# milliseconds).
|
1673
|
+
#
|
1674
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1675
|
+
# has been received across all queues but not deleted.
|
1676
|
+
#
|
1677
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1678
|
+
#
|
1679
|
+
# * `SenderId`
|
1680
|
+
#
|
1681
|
+
# * For a user, returns the user ID, for example
|
1682
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1683
|
+
#
|
1684
|
+
# * For an IAM role, returns the IAM role ID, for example
|
1685
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1686
|
+
#
|
1687
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1688
|
+
# queue ([epoch time][1] in milliseconds).
|
1689
|
+
#
|
1690
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1691
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
1692
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1693
|
+
# [SSE-SQS][3]).
|
1694
|
+
#
|
1695
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1696
|
+
# producer that calls the ` SendMessage ` action.
|
1697
|
+
#
|
1698
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1699
|
+
# calls the ` SendMessage ` action. Messages with the same
|
1700
|
+
# `MessageGroupId` are returned in sequence.
|
1701
|
+
#
|
1702
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1703
|
+
#
|
1704
|
+
#
|
1705
|
+
#
|
1706
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1707
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1708
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1709
|
+
# @return [Array<String>]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] message_system_attribute_names
|
1660
1712
|
# A list of attributes that need to be returned along with each
|
1661
1713
|
# message. These attributes include:
|
1662
1714
|
#
|
@@ -1742,8 +1794,8 @@ module Aws::SQS
|
|
1742
1794
|
# The duration (in seconds) for which the call waits for a message to
|
1743
1795
|
# arrive in the queue before returning. If a message is available, the
|
1744
1796
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1745
|
-
# available and the wait time expires, the call
|
1746
|
-
#
|
1797
|
+
# available and the wait time expires, the call does not return a
|
1798
|
+
# message list.
|
1747
1799
|
#
|
1748
1800
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1749
1801
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1774,10 +1826,6 @@ module Aws::SQS
|
|
1774
1826
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
1775
1827
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
1776
1828
|
#
|
1777
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
1778
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1779
|
-
# `ReceiveRequestAttemptId`.
|
1780
|
-
#
|
1781
1829
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
1782
1830
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1783
1831
|
# modified (deleted or had their visibility changes).
|
@@ -1831,6 +1879,7 @@ module Aws::SQS
|
|
1831
1879
|
class ReceiveMessageRequest < Struct.new(
|
1832
1880
|
:queue_url,
|
1833
1881
|
:attribute_names,
|
1882
|
+
:message_system_attribute_names,
|
1834
1883
|
:message_attribute_names,
|
1835
1884
|
:max_number_of_messages,
|
1836
1885
|
:visibility_timeout,
|
@@ -2338,8 +2387,8 @@ module Aws::SQS
|
|
2338
2387
|
# are sorted by time sent. The caller can't specify a
|
2339
2388
|
# `MessageGroupId`.
|
2340
2389
|
#
|
2341
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
2342
|
-
# alphanumeric characters and punctuation ``
|
2390
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
2391
|
+
# values: alphanumeric characters and punctuation ``
|
2343
2392
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
2344
2393
|
#
|
2345
2394
|
# For best practices of using `MessageGroupId`, see [Using the
|
data/lib/aws-sdk-sqs.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -244,6 +244,7 @@ module Aws
|
|
244
244
|
def receive_message: (
|
245
245
|
queue_url: ::String,
|
246
246
|
?attribute_names: Array[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled")],
|
247
|
+
?message_system_attribute_names: Array[("All" | "SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn")],
|
247
248
|
?message_attribute_names: Array[::String],
|
248
249
|
?max_number_of_messages: ::Integer,
|
249
250
|
?visibility_timeout: ::Integer,
|
data/sig/message.rbs
CHANGED
@@ -30,7 +30,7 @@ module Aws
|
|
30
30
|
def body: () -> ::String
|
31
31
|
|
32
32
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Message.html#attributes-instance_method
|
33
|
-
def attributes: () -> ::Hash[("SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn"), ::String]
|
33
|
+
def attributes: () -> ::Hash[("All" | "SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn"), ::String]
|
34
34
|
|
35
35
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Message.html#md5_of_message_attributes-instance_method
|
36
36
|
def md5_of_message_attributes: () -> ::String
|
data/sig/queue.rbs
CHANGED
@@ -77,6 +77,7 @@ module Aws
|
|
77
77
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SQS/Queue.html#receive_messages-instance_method
|
78
78
|
def receive_messages: (
|
79
79
|
?attribute_names: Array[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled")],
|
80
|
+
?message_system_attribute_names: Array[("All" | "SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn")],
|
80
81
|
?message_attribute_names: Array[::String],
|
81
82
|
?max_number_of_messages: ::Integer,
|
82
83
|
?visibility_timeout: ::Integer,
|
data/sig/types.rbs
CHANGED
@@ -281,7 +281,7 @@ module Aws::SQS
|
|
281
281
|
attr_accessor receipt_handle: ::String
|
282
282
|
attr_accessor md5_of_body: ::String
|
283
283
|
attr_accessor body: ::String
|
284
|
-
attr_accessor attributes: ::Hash[("SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn"), ::String]
|
284
|
+
attr_accessor attributes: ::Hash[("All" | "SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn"), ::String]
|
285
285
|
attr_accessor md5_of_message_attributes: ::String
|
286
286
|
attr_accessor message_attributes: ::Hash[::String, Types::MessageAttributeValue]
|
287
287
|
SENSITIVE: []
|
@@ -346,6 +346,7 @@ module Aws::SQS
|
|
346
346
|
class ReceiveMessageRequest
|
347
347
|
attr_accessor queue_url: ::String
|
348
348
|
attr_accessor attribute_names: ::Array[("All" | "Policy" | "VisibilityTimeout" | "MaximumMessageSize" | "MessageRetentionPeriod" | "ApproximateNumberOfMessages" | "ApproximateNumberOfMessagesNotVisible" | "CreatedTimestamp" | "LastModifiedTimestamp" | "QueueArn" | "ApproximateNumberOfMessagesDelayed" | "DelaySeconds" | "ReceiveMessageWaitTimeSeconds" | "RedrivePolicy" | "FifoQueue" | "ContentBasedDeduplication" | "KmsMasterKeyId" | "KmsDataKeyReusePeriodSeconds" | "DeduplicationScope" | "FifoThroughputLimit" | "RedriveAllowPolicy" | "SqsManagedSseEnabled")]
|
349
|
+
attr_accessor message_system_attribute_names: ::Array[("All" | "SenderId" | "SentTimestamp" | "ApproximateReceiveCount" | "ApproximateFirstReceiveTimestamp" | "SequenceNumber" | "MessageDeduplicationId" | "MessageGroupId" | "AWSTraceHeader" | "DeadLetterQueueSourceArn")]
|
349
350
|
attr_accessor message_attribute_names: ::Array[::String]
|
350
351
|
attr_accessor max_number_of_messages: ::Integer
|
351
352
|
attr_accessor visibility_timeout: ::Integer
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-sqs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.74.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-05-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|