aws-sdk-sqs 1.88.0 → 1.90.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 +86 -59
- data/lib/aws-sdk-sqs/queue.rb +38 -11
- data/lib/aws-sdk-sqs/queue_poller.rb +1 -1
- data/lib/aws-sdk-sqs/resource.rb +7 -10
- data/lib/aws-sdk-sqs/types.rb +71 -36
- data/lib/aws-sdk-sqs.rb +1 -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: c122c91aca3570ae9faf5b93a1c376363c5f05cacce7fe0c22c851bd9486d818
|
4
|
+
data.tar.gz: 3a8edebaf3fd41378cabdcd5d450d909c5f072fae9b9ec03b669e7ab77572a2d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8364bfa6a6e1452752c6c07d273853386c8ec299696f0fd16a9fc81d3118b6cd0c9371b32d08780e082e48e4c84131431ad88467e01705a0114940facab50d97
|
7
|
+
data.tar.gz: 779695b4b133442beb45aa61b6de84f19164808535dc1e9817541009ae312c7f8bf217882b67374b6d2fced97c4385d4fb1c9695d6a7972f7fead8321ad78e2d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.90.0 (2025-01-02)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - In-flight message typo fix from 20k to 120k.
|
8
|
+
|
9
|
+
1.89.0 (2024-11-18)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
4
14
|
1.88.0 (2024-11-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.90.0
|
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -652,7 +652,7 @@ module Aws::SQS
|
|
652
652
|
# increase the number of queues you use to process your messages. To
|
653
653
|
# request a limit increase, [file a support request][2].
|
654
654
|
#
|
655
|
-
# For FIFO queues, there can be a maximum of
|
655
|
+
# For FIFO queues, there can be a maximum of 120,000 in flight messages
|
656
656
|
# (received from a queue by a consumer, but not yet deleted from the
|
657
657
|
# queue). If you reach this limit, Amazon SQS returns no error messages.
|
658
658
|
#
|
@@ -795,20 +795,24 @@ module Aws::SQS
|
|
795
795
|
#
|
796
796
|
# </note>
|
797
797
|
#
|
798
|
-
# To
|
799
|
-
#
|
800
|
-
# names:
|
798
|
+
# To retrieve the URL of a queue, use the [ `GetQueueUrl` ][3] action.
|
799
|
+
# This action only requires the [ `QueueName` ][4] parameter.
|
801
800
|
#
|
802
|
-
#
|
803
|
-
# names and values of all the queue's attributes, `CreateQueue`
|
804
|
-
# returns the queue URL for the existing queue.
|
801
|
+
# When creating queues, keep the following points in mind:
|
805
802
|
#
|
806
|
-
# * If the
|
807
|
-
#
|
803
|
+
# * If you specify the name of an existing queue and provide the exact
|
804
|
+
# same names and values for all its attributes, the [ `CreateQueue`
|
805
|
+
# ][5] action will return the URL of the existing queue instead of
|
806
|
+
# creating a new one.
|
807
|
+
#
|
808
|
+
# * If you attempt to create a queue with a name that already exists but
|
809
|
+
# with different attribute names or values, the `CreateQueue` action
|
810
|
+
# will return an error. This ensures that existing queues are not
|
811
|
+
# inadvertently altered.
|
808
812
|
#
|
809
813
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
810
814
|
# information, see [Grant cross-account permissions to a role and a
|
811
|
-
# username][
|
815
|
+
# username][6] in the *Amazon SQS Developer Guide*.
|
812
816
|
#
|
813
817
|
# </note>
|
814
818
|
#
|
@@ -816,7 +820,10 @@ module Aws::SQS
|
|
816
820
|
#
|
817
821
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving
|
818
822
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html
|
819
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/
|
823
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html
|
824
|
+
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestSyntax
|
825
|
+
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html
|
826
|
+
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
820
827
|
#
|
821
828
|
# @option params [required, String] :queue_name
|
822
829
|
# The name of the new queue. The following limits apply to this name:
|
@@ -884,7 +891,6 @@ module Aws::SQS
|
|
884
891
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
885
892
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
886
893
|
# dead-letter-queue.
|
887
|
-
#
|
888
894
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
889
895
|
# the permissions for the dead-letter queue redrive permission and
|
890
896
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -903,7 +909,6 @@ module Aws::SQS
|
|
903
909
|
#
|
904
910
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
905
911
|
# parameter can specify this queue as the dead-letter queue.
|
906
|
-
#
|
907
912
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
908
913
|
# queues that can specify this queue as the dead-letter queue and
|
909
914
|
# redrive messages. You can specify this parameter only when the
|
@@ -975,7 +980,6 @@ module Aws::SQS
|
|
975
980
|
#
|
976
981
|
# * If the queue has `ContentBasedDeduplication` set, your
|
977
982
|
# `MessageDeduplicationId` overrides the generated one.
|
978
|
-
#
|
979
983
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
980
984
|
# identical content sent within the deduplication interval are
|
981
985
|
# treated as duplicates and only one copy of the message is
|
@@ -1103,12 +1107,14 @@ module Aws::SQS
|
|
1103
1107
|
# automatically deletes messages left in a queue longer than the
|
1104
1108
|
# retention period configured for the queue.
|
1105
1109
|
#
|
1106
|
-
# <note markdown="1">
|
1107
|
-
#
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
#
|
1111
|
-
#
|
1110
|
+
# <note markdown="1"> Each time you receive a message, meaning when a consumer retrieves a
|
1111
|
+
# message from the queue, it comes with a unique `ReceiptHandle`. If you
|
1112
|
+
# receive the same message more than once, you will get a different
|
1113
|
+
# `ReceiptHandle` each time. When you want to delete a message using the
|
1114
|
+
# `DeleteMessage` action, you must use the `ReceiptHandle` from the most
|
1115
|
+
# recent time you received the message. If you use an old
|
1116
|
+
# `ReceiptHandle`, the request will succeed, but the message might not
|
1117
|
+
# be deleted.
|
1112
1118
|
#
|
1113
1119
|
# For standard queues, it is possible to receive a message even after
|
1114
1120
|
# you delete it. This might happen on rare occasions if one of the
|
@@ -1348,7 +1354,6 @@ module Aws::SQS
|
|
1348
1354
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
1349
1355
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
1350
1356
|
# dead-letter-queue.
|
1351
|
-
#
|
1352
1357
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
1353
1358
|
# the permissions for the dead-letter queue redrive permission and
|
1354
1359
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -1367,7 +1372,6 @@ module Aws::SQS
|
|
1367
1372
|
#
|
1368
1373
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
1369
1374
|
# parameter can specify this queue as the dead-letter queue.
|
1370
|
-
#
|
1371
1375
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
1372
1376
|
# queues that can specify this queue as the dead-letter queue and
|
1373
1377
|
# redrive messages. You can specify this parameter only when the
|
@@ -1481,29 +1485,32 @@ module Aws::SQS
|
|
1481
1485
|
req.send_request(options)
|
1482
1486
|
end
|
1483
1487
|
|
1484
|
-
#
|
1485
|
-
#
|
1486
|
-
#
|
1487
|
-
#
|
1488
|
-
#
|
1489
|
-
# the
|
1490
|
-
#
|
1491
|
-
#
|
1488
|
+
# The `GetQueueUrl` API returns the URL of an existing Amazon SQS queue.
|
1489
|
+
# This is useful when you know the queue's name but need to retrieve
|
1490
|
+
# its URL for further operations.
|
1491
|
+
#
|
1492
|
+
# To access a queue owned by another Amazon Web Services account, use
|
1493
|
+
# the `QueueOwnerAWSAccountId` parameter to specify the account ID of
|
1494
|
+
# the queue's owner. Note that the queue owner must grant you the
|
1495
|
+
# necessary permissions to access the queue. For more information about
|
1496
|
+
# accessing shared queues, see the ` AddPermission ` API or [Allow
|
1497
|
+
# developers to write messages to a shared queue][1] in the *Amazon SQS
|
1498
|
+
# Developer Guide*.
|
1492
1499
|
#
|
1493
1500
|
#
|
1494
1501
|
#
|
1495
1502
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue
|
1496
1503
|
#
|
1497
1504
|
# @option params [required, String] :queue_name
|
1498
|
-
# The name of the queue
|
1499
|
-
#
|
1500
|
-
# underscores (
|
1501
|
-
#
|
1502
|
-
# Queue URLs and names are case-sensitive.
|
1505
|
+
# (Required) The name of the queue for which you want to fetch the URL.
|
1506
|
+
# The name can be up to 80 characters long and can include alphanumeric
|
1507
|
+
# characters, hyphens (-), and underscores (\_). Queue URLs and names
|
1508
|
+
# are case-sensitive.
|
1503
1509
|
#
|
1504
1510
|
# @option params [String] :queue_owner_aws_account_id
|
1505
|
-
# The Amazon Web Services account ID of the account that
|
1506
|
-
# queue.
|
1511
|
+
# (Optional) The Amazon Web Services account ID of the account that
|
1512
|
+
# created the queue. This is only required when you are attempting to
|
1513
|
+
# access a queue owned by another Amazon Web Services account.
|
1507
1514
|
#
|
1508
1515
|
# @return [Types::GetQueueUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1509
1516
|
#
|
@@ -1803,7 +1810,7 @@ module Aws::SQS
|
|
1803
1810
|
# Developer Guide*.
|
1804
1811
|
#
|
1805
1812
|
# Short poll is the default behavior where a weighted random set of
|
1806
|
-
# machines is sampled on a `ReceiveMessage` call.
|
1813
|
+
# machines is sampled on a `ReceiveMessage` call. Therefore, only the
|
1807
1814
|
# messages on the sampled machines are returned. If the number of
|
1808
1815
|
# messages in the queue is small (fewer than 1,000), you most likely get
|
1809
1816
|
# fewer messages than you requested per `ReceiveMessage` call. If the
|
@@ -1833,14 +1840,8 @@ module Aws::SQS
|
|
1833
1840
|
# You can provide the `VisibilityTimeout` parameter in your request. The
|
1834
1841
|
# parameter is applied to the messages that Amazon SQS returns in the
|
1835
1842
|
# response. If you don't include the parameter, the overall visibility
|
1836
|
-
# timeout for the queue is used for the returned messages.
|
1837
|
-
#
|
1838
|
-
# Guide*.
|
1839
|
-
#
|
1840
|
-
# A message that isn't deleted or a message whose visibility isn't
|
1841
|
-
# extended before the visibility timeout expires counts as a failed
|
1842
|
-
# receive. Depending on the configuration of the queue, the message
|
1843
|
-
# might be sent to the dead-letter queue.
|
1843
|
+
# timeout for the queue is used for the returned messages. The default
|
1844
|
+
# visibility timeout for a queue is 30 seconds.
|
1844
1845
|
#
|
1845
1846
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1846
1847
|
# calls this action, we recommend that you structure your code so that
|
@@ -1853,7 +1854,6 @@ module Aws::SQS
|
|
1853
1854
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html
|
1854
1855
|
# [2]: https://www.ietf.org/rfc/rfc1321.txt
|
1855
1856
|
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html
|
1856
|
-
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1857
1857
|
#
|
1858
1858
|
# @option params [required, String] :queue_url
|
1859
1859
|
# The URL of the Amazon SQS queue from which messages are received.
|
@@ -1861,9 +1861,9 @@ module Aws::SQS
|
|
1861
1861
|
# Queue URLs and names are case-sensitive.
|
1862
1862
|
#
|
1863
1863
|
# @option params [Array<String>] :attribute_names
|
1864
|
-
# This parameter has been
|
1865
|
-
# compatibility. To provide attribute names, you are encouraged
|
1866
|
-
# `MessageSystemAttributeNames`.
|
1864
|
+
# This parameter has been discontinued but will be supported for
|
1865
|
+
# backward compatibility. To provide attribute names, you are encouraged
|
1866
|
+
# to use `MessageSystemAttributeNames`.
|
1867
1867
|
#
|
1868
1868
|
# A list of attributes that need to be returned along with each message.
|
1869
1869
|
# These attributes include:
|
@@ -1885,7 +1885,6 @@ module Aws::SQS
|
|
1885
1885
|
#
|
1886
1886
|
# * For an IAM role, returns the IAM role ID, for example
|
1887
1887
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1888
|
-
#
|
1889
1888
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1890
1889
|
# ([epoch time][1] in milliseconds).
|
1891
1890
|
#
|
@@ -1929,7 +1928,6 @@ module Aws::SQS
|
|
1929
1928
|
#
|
1930
1929
|
# * For an IAM role, returns the IAM role ID, for example
|
1931
1930
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1932
|
-
#
|
1933
1931
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1934
1932
|
# ([epoch time][1] in milliseconds).
|
1935
1933
|
#
|
@@ -1982,14 +1980,47 @@ module Aws::SQS
|
|
1982
1980
|
# @option params [Integer] :visibility_timeout
|
1983
1981
|
# The duration (in seconds) that the received messages are hidden from
|
1984
1982
|
# subsequent retrieve requests after being retrieved by a
|
1985
|
-
# `ReceiveMessage` request.
|
1983
|
+
# `ReceiveMessage` request. If not specified, the default visibility
|
1984
|
+
# timeout for the queue is used, which is 30 seconds.
|
1985
|
+
#
|
1986
|
+
# Understanding `VisibilityTimeout`:
|
1987
|
+
#
|
1988
|
+
# * When a message is received from a queue, it becomes temporarily
|
1989
|
+
# invisible to other consumers for the duration of the visibility
|
1990
|
+
# timeout. This prevents multiple consumers from processing the same
|
1991
|
+
# message simultaneously. If the message is not deleted or its
|
1992
|
+
# visibility timeout is not extended before the timeout expires, it
|
1993
|
+
# becomes visible again and can be retrieved by other consumers.
|
1994
|
+
#
|
1995
|
+
# * Setting an appropriate visibility timeout is crucial. If it's too
|
1996
|
+
# short, the message might become visible again before processing is
|
1997
|
+
# complete, leading to duplicate processing. If it's too long, it
|
1998
|
+
# delays the reprocessing of messages if the initial processing fails.
|
1999
|
+
#
|
2000
|
+
# * You can adjust the visibility timeout using the
|
2001
|
+
# `--visibility-timeout` parameter in the `receive-message` command to
|
2002
|
+
# match the processing time required by your application.
|
2003
|
+
#
|
2004
|
+
# * A message that isn't deleted or a message whose visibility isn't
|
2005
|
+
# extended before the visibility timeout expires counts as a failed
|
2006
|
+
# receive. Depending on the configuration of the queue, the message
|
2007
|
+
# might be sent to the dead-letter queue.
|
2008
|
+
#
|
2009
|
+
# For more information, see [Visibility Timeout][1] in the *Amazon SQS
|
2010
|
+
# Developer Guide*.
|
2011
|
+
#
|
2012
|
+
#
|
2013
|
+
#
|
2014
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1986
2015
|
#
|
1987
2016
|
# @option params [Integer] :wait_time_seconds
|
1988
2017
|
# The duration (in seconds) for which the call waits for a message to
|
1989
2018
|
# arrive in the queue before returning. If a message is available, the
|
1990
2019
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1991
2020
|
# available and the wait time expires, the call does not return a
|
1992
|
-
# message list.
|
2021
|
+
# message list. If you are using the Java SDK, it returns a
|
2022
|
+
# `ReceiveMessageResponse` object, which has a empty list instead of a
|
2023
|
+
# Null object.
|
1993
2024
|
#
|
1994
2025
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1995
2026
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -2256,7 +2287,6 @@ module Aws::SQS
|
|
2256
2287
|
#
|
2257
2288
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2258
2289
|
# `MessageDeduplicationId` overrides the generated one.
|
2259
|
-
#
|
2260
2290
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2261
2291
|
# identical content sent within the deduplication interval are treated
|
2262
2292
|
# as duplicates and only one copy of the message is delivered.
|
@@ -2571,7 +2601,6 @@ module Aws::SQS
|
|
2571
2601
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2572
2602
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
2573
2603
|
# dead-letter-queue.
|
2574
|
-
#
|
2575
2604
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2576
2605
|
# the permissions for the dead-letter queue redrive permission and
|
2577
2606
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -2590,7 +2619,6 @@ module Aws::SQS
|
|
2590
2619
|
#
|
2591
2620
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2592
2621
|
# parameter can specify this queue as the dead-letter queue.
|
2593
|
-
#
|
2594
2622
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
2595
2623
|
# queues that can specify this queue as the dead-letter queue and
|
2596
2624
|
# redrive messages. You can specify this parameter only when the
|
@@ -2650,7 +2678,6 @@ module Aws::SQS
|
|
2650
2678
|
#
|
2651
2679
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2652
2680
|
# `MessageDeduplicationId` overrides the generated one.
|
2653
|
-
#
|
2654
2681
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2655
2682
|
# identical content sent within the deduplication interval are
|
2656
2683
|
# treated as duplicates and only one copy of the message is
|
@@ -2908,7 +2935,7 @@ module Aws::SQS
|
|
2908
2935
|
tracer: tracer
|
2909
2936
|
)
|
2910
2937
|
context[:gem_name] = 'aws-sdk-sqs'
|
2911
|
-
context[:gem_version] = '1.
|
2938
|
+
context[:gem_version] = '1.90.0'
|
2912
2939
|
Seahorse::Client::Request.new(handlers, context)
|
2913
2940
|
end
|
2914
2941
|
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -216,9 +216,9 @@ module Aws::SQS
|
|
216
216
|
# })
|
217
217
|
# @param [Hash] options ({})
|
218
218
|
# @option options [Array<String>] :attribute_names
|
219
|
-
# This parameter has been
|
220
|
-
# compatibility. To provide attribute names, you are encouraged
|
221
|
-
# `MessageSystemAttributeNames`.
|
219
|
+
# This parameter has been discontinued but will be supported for
|
220
|
+
# backward compatibility. To provide attribute names, you are encouraged
|
221
|
+
# to use `MessageSystemAttributeNames`.
|
222
222
|
#
|
223
223
|
# A list of attributes that need to be returned along with each message.
|
224
224
|
# These attributes include:
|
@@ -240,7 +240,6 @@ module Aws::SQS
|
|
240
240
|
#
|
241
241
|
# * For an IAM role, returns the IAM role ID, for example
|
242
242
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
243
|
-
#
|
244
243
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
245
244
|
# ([epoch time][1] in milliseconds).
|
246
245
|
#
|
@@ -283,7 +282,6 @@ module Aws::SQS
|
|
283
282
|
#
|
284
283
|
# * For an IAM role, returns the IAM role ID, for example
|
285
284
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
286
|
-
#
|
287
285
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
288
286
|
# ([epoch time][1] in milliseconds).
|
289
287
|
#
|
@@ -333,13 +331,46 @@ module Aws::SQS
|
|
333
331
|
# @option options [Integer] :visibility_timeout
|
334
332
|
# The duration (in seconds) that the received messages are hidden from
|
335
333
|
# subsequent retrieve requests after being retrieved by a
|
336
|
-
# `ReceiveMessage` request.
|
334
|
+
# `ReceiveMessage` request. If not specified, the default visibility
|
335
|
+
# timeout for the queue is used, which is 30 seconds.
|
336
|
+
#
|
337
|
+
# Understanding `VisibilityTimeout`:
|
338
|
+
#
|
339
|
+
# * When a message is received from a queue, it becomes temporarily
|
340
|
+
# invisible to other consumers for the duration of the visibility
|
341
|
+
# timeout. This prevents multiple consumers from processing the same
|
342
|
+
# message simultaneously. If the message is not deleted or its
|
343
|
+
# visibility timeout is not extended before the timeout expires, it
|
344
|
+
# becomes visible again and can be retrieved by other consumers.
|
345
|
+
#
|
346
|
+
# * Setting an appropriate visibility timeout is crucial. If it's too
|
347
|
+
# short, the message might become visible again before processing is
|
348
|
+
# complete, leading to duplicate processing. If it's too long, it
|
349
|
+
# delays the reprocessing of messages if the initial processing fails.
|
350
|
+
#
|
351
|
+
# * You can adjust the visibility timeout using the
|
352
|
+
# `--visibility-timeout` parameter in the `receive-message` command to
|
353
|
+
# match the processing time required by your application.
|
354
|
+
#
|
355
|
+
# * A message that isn't deleted or a message whose visibility isn't
|
356
|
+
# extended before the visibility timeout expires counts as a failed
|
357
|
+
# receive. Depending on the configuration of the queue, the message
|
358
|
+
# might be sent to the dead-letter queue.
|
359
|
+
#
|
360
|
+
# For more information, see [Visibility Timeout][1] in the *Amazon SQS
|
361
|
+
# Developer Guide*.
|
362
|
+
#
|
363
|
+
#
|
364
|
+
#
|
365
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
337
366
|
# @option options [Integer] :wait_time_seconds
|
338
367
|
# The duration (in seconds) for which the call waits for a message to
|
339
368
|
# arrive in the queue before returning. If a message is available, the
|
340
369
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
341
370
|
# available and the wait time expires, the call does not return a
|
342
|
-
# message list.
|
371
|
+
# message list. If you are using the Java SDK, it returns a
|
372
|
+
# `ReceiveMessageResponse` object, which has a empty list instead of a
|
373
|
+
# Null object.
|
343
374
|
#
|
344
375
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
345
376
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -548,7 +579,6 @@ module Aws::SQS
|
|
548
579
|
#
|
549
580
|
# * If the queue has `ContentBasedDeduplication` set, your
|
550
581
|
# `MessageDeduplicationId` overrides the generated one.
|
551
|
-
#
|
552
582
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
553
583
|
# identical content sent within the deduplication interval are treated
|
554
584
|
# as duplicates and only one copy of the message is delivered.
|
@@ -731,7 +761,6 @@ module Aws::SQS
|
|
731
761
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
732
762
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
733
763
|
# dead-letter-queue.
|
734
|
-
#
|
735
764
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
736
765
|
# the permissions for the dead-letter queue redrive permission and
|
737
766
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -750,7 +779,6 @@ module Aws::SQS
|
|
750
779
|
#
|
751
780
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
752
781
|
# parameter can specify this queue as the dead-letter queue.
|
753
|
-
#
|
754
782
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
755
783
|
# queues that can specify this queue as the dead-letter queue and
|
756
784
|
# redrive messages. You can specify this parameter only when the
|
@@ -810,7 +838,6 @@ module Aws::SQS
|
|
810
838
|
#
|
811
839
|
# * If the queue has `ContentBasedDeduplication` set, your
|
812
840
|
# `MessageDeduplicationId` overrides the generated one.
|
813
|
-
#
|
814
841
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
815
842
|
# identical content sent within the deduplication interval are
|
816
843
|
# treated as duplicates and only one copy of the message is
|
@@ -134,7 +134,7 @@ module Aws
|
|
134
134
|
# ### `:idle_timeout` Option
|
135
135
|
#
|
136
136
|
# This is a configurable, maximum number of seconds to wait for a
|
137
|
-
# new message before the polling loop
|
137
|
+
# new message before the polling loop exits. By default, there is
|
138
138
|
# no idle timeout.
|
139
139
|
#
|
140
140
|
# # stops polling after a minute of no received messages
|
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
|
@@ -311,14 +308,14 @@ module Aws::SQS
|
|
311
308
|
# })
|
312
309
|
# @param [Hash] options ({})
|
313
310
|
# @option options [required, String] :queue_name
|
314
|
-
# The name of the queue
|
315
|
-
#
|
316
|
-
# underscores (
|
317
|
-
#
|
318
|
-
# Queue URLs and names are case-sensitive.
|
311
|
+
# (Required) The name of the queue for which you want to fetch the URL.
|
312
|
+
# The name can be up to 80 characters long and can include alphanumeric
|
313
|
+
# characters, hyphens (-), and underscores (\_). Queue URLs and names
|
314
|
+
# are case-sensitive.
|
319
315
|
# @option options [String] :queue_owner_aws_account_id
|
320
|
-
# The Amazon Web Services account ID of the account that
|
321
|
-
# queue.
|
316
|
+
# (Optional) The Amazon Web Services account ID of the account that
|
317
|
+
# created the queue. This is only required when you are attempting to
|
318
|
+
# access a queue owned by another Amazon Web Services account.
|
322
319
|
# @return [Queue]
|
323
320
|
def get_queue_by_name(options = {})
|
324
321
|
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
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
|
@@ -898,17 +893,20 @@ module Aws::SQS
|
|
898
893
|
include Aws::Structure
|
899
894
|
end
|
900
895
|
|
901
|
-
#
|
902
|
-
#
|
903
|
-
# characters. Valid values: alphanumeric characters, hyphens (`-`),
|
904
|
-
# and underscores (`_`).
|
896
|
+
# Retrieves the URL of an existing queue based on its name and,
|
897
|
+
# optionally, the Amazon Web Services account ID.
|
905
898
|
#
|
906
|
-
#
|
899
|
+
# @!attribute [rw] queue_name
|
900
|
+
# (Required) The name of the queue for which you want to fetch the
|
901
|
+
# URL. The name can be up to 80 characters long and can include
|
902
|
+
# alphanumeric characters, hyphens (-), and underscores (\_). Queue
|
903
|
+
# URLs and names are case-sensitive.
|
907
904
|
# @return [String]
|
908
905
|
#
|
909
906
|
# @!attribute [rw] queue_owner_aws_account_id
|
910
|
-
# The Amazon Web Services account ID of the account that
|
911
|
-
# queue.
|
907
|
+
# (Optional) The Amazon Web Services account ID of the account that
|
908
|
+
# created the queue. This is only required when you are attempting to
|
909
|
+
# access a queue owned by another Amazon Web Services account.
|
912
910
|
# @return [String]
|
913
911
|
#
|
914
912
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
|
@@ -939,7 +937,7 @@ module Aws::SQS
|
|
939
937
|
include Aws::Structure
|
940
938
|
end
|
941
939
|
|
942
|
-
# The
|
940
|
+
# The specified ID is invalid.
|
943
941
|
#
|
944
942
|
# @!attribute [rw] message
|
945
943
|
# @return [String]
|
@@ -1011,7 +1009,7 @@ module Aws::SQS
|
|
1011
1009
|
include Aws::Structure
|
1012
1010
|
end
|
1013
1011
|
|
1014
|
-
#
|
1012
|
+
# The request was not made over HTTPS or did not use SigV4 for signing.
|
1015
1013
|
#
|
1016
1014
|
# @!attribute [rw] message
|
1017
1015
|
# @return [String]
|
@@ -1610,7 +1608,8 @@ module Aws::SQS
|
|
1610
1608
|
include Aws::Structure
|
1611
1609
|
end
|
1612
1610
|
|
1613
|
-
#
|
1611
|
+
# Ensure that the `QueueUrl` is correct and that the queue has not been
|
1612
|
+
# deleted.
|
1614
1613
|
#
|
1615
1614
|
# @!attribute [rw] message
|
1616
1615
|
# @return [String]
|
@@ -1651,6 +1650,8 @@ module Aws::SQS
|
|
1651
1650
|
include Aws::Structure
|
1652
1651
|
end
|
1653
1652
|
|
1653
|
+
# Retrieves one or more messages from a specified queue.
|
1654
|
+
#
|
1654
1655
|
# @!attribute [rw] queue_url
|
1655
1656
|
# The URL of the Amazon SQS queue from which messages are received.
|
1656
1657
|
#
|
@@ -1658,7 +1659,7 @@ module Aws::SQS
|
|
1658
1659
|
# @return [String]
|
1659
1660
|
#
|
1660
1661
|
# @!attribute [rw] attribute_names
|
1661
|
-
# This parameter has been
|
1662
|
+
# This parameter has been discontinued but will be supported for
|
1662
1663
|
# backward compatibility. To provide attribute names, you are
|
1663
1664
|
# encouraged to use `MessageSystemAttributeNames`.
|
1664
1665
|
#
|
@@ -1683,7 +1684,6 @@ module Aws::SQS
|
|
1683
1684
|
#
|
1684
1685
|
# * For an IAM role, returns the IAM role ID, for example
|
1685
1686
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1686
|
-
#
|
1687
1687
|
# * `SentTimestamp` – Returns the time the message was sent to the
|
1688
1688
|
# queue ([epoch time][1] in milliseconds).
|
1689
1689
|
#
|
@@ -1730,7 +1730,6 @@ module Aws::SQS
|
|
1730
1730
|
#
|
1731
1731
|
# * For an IAM role, returns the IAM role ID, for example
|
1732
1732
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1733
|
-
#
|
1734
1733
|
# * `SentTimestamp` – Returns the time the message was sent to the
|
1735
1734
|
# queue ([epoch time][1] in milliseconds).
|
1736
1735
|
#
|
@@ -1787,7 +1786,39 @@ module Aws::SQS
|
|
1787
1786
|
# @!attribute [rw] visibility_timeout
|
1788
1787
|
# The duration (in seconds) that the received messages are hidden from
|
1789
1788
|
# subsequent retrieve requests after being retrieved by a
|
1790
|
-
# `ReceiveMessage` request.
|
1789
|
+
# `ReceiveMessage` request. If not specified, the default visibility
|
1790
|
+
# timeout for the queue is used, which is 30 seconds.
|
1791
|
+
#
|
1792
|
+
# Understanding `VisibilityTimeout`:
|
1793
|
+
#
|
1794
|
+
# * When a message is received from a queue, it becomes temporarily
|
1795
|
+
# invisible to other consumers for the duration of the visibility
|
1796
|
+
# timeout. This prevents multiple consumers from processing the same
|
1797
|
+
# message simultaneously. If the message is not deleted or its
|
1798
|
+
# visibility timeout is not extended before the timeout expires, it
|
1799
|
+
# becomes visible again and can be retrieved by other consumers.
|
1800
|
+
#
|
1801
|
+
# * Setting an appropriate visibility timeout is crucial. If it's too
|
1802
|
+
# short, the message might become visible again before processing is
|
1803
|
+
# complete, leading to duplicate processing. If it's too long, it
|
1804
|
+
# delays the reprocessing of messages if the initial processing
|
1805
|
+
# fails.
|
1806
|
+
#
|
1807
|
+
# * You can adjust the visibility timeout using the
|
1808
|
+
# `--visibility-timeout` parameter in the `receive-message` command
|
1809
|
+
# to match the processing time required by your application.
|
1810
|
+
#
|
1811
|
+
# * A message that isn't deleted or a message whose visibility isn't
|
1812
|
+
# extended before the visibility timeout expires counts as a failed
|
1813
|
+
# receive. Depending on the configuration of the queue, the message
|
1814
|
+
# might be sent to the dead-letter queue.
|
1815
|
+
#
|
1816
|
+
# For more information, see [Visibility Timeout][1] in the *Amazon SQS
|
1817
|
+
# Developer Guide*.
|
1818
|
+
#
|
1819
|
+
#
|
1820
|
+
#
|
1821
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1791
1822
|
# @return [Integer]
|
1792
1823
|
#
|
1793
1824
|
# @!attribute [rw] wait_time_seconds
|
@@ -1795,7 +1826,9 @@ module Aws::SQS
|
|
1795
1826
|
# arrive in the queue before returning. If a message is available, the
|
1796
1827
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1797
1828
|
# available and the wait time expires, the call does not return a
|
1798
|
-
# message list.
|
1829
|
+
# message list. If you are using the Java SDK, it returns a
|
1830
|
+
# `ReceiveMessageResponse` object, which has a empty list instead of a
|
1831
|
+
# Null object.
|
1799
1832
|
#
|
1800
1833
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1801
1834
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1925,18 +1958,16 @@ module Aws::SQS
|
|
1925
1958
|
|
1926
1959
|
# The request was denied due to request throttling.
|
1927
1960
|
#
|
1928
|
-
# *
|
1929
|
-
#
|
1961
|
+
# * Exceeds the permitted request rate for the queue or for the
|
1962
|
+
# recipient of the request.
|
1930
1963
|
#
|
1931
|
-
# *
|
1932
|
-
#
|
1964
|
+
# * Ensure that the request rate is within the Amazon SQS limits for
|
1965
|
+
# sending messages. For more information, see [Amazon SQS quotas][1]
|
1966
|
+
# in the *Amazon SQS Developer Guide*.
|
1933
1967
|
#
|
1934
|
-
#
|
1935
|
-
#
|
1936
|
-
#
|
1937
|
-
# Amazon Web Services CloudHSM key store is processing numerous
|
1938
|
-
# commands, including those unrelated to the Amazon Web Services
|
1939
|
-
# CloudHSM key store.
|
1968
|
+
#
|
1969
|
+
#
|
1970
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests
|
1940
1971
|
#
|
1941
1972
|
# @!attribute [rw] message
|
1942
1973
|
# @return [String]
|
@@ -2062,7 +2093,6 @@ module Aws::SQS
|
|
2062
2093
|
#
|
2063
2094
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2064
2095
|
# `MessageDeduplicationId` overrides the generated one.
|
2065
|
-
#
|
2066
2096
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2067
2097
|
# identical content sent within the deduplication interval are
|
2068
2098
|
# treated as duplicates and only one copy of the message is
|
@@ -2331,7 +2361,6 @@ module Aws::SQS
|
|
2331
2361
|
#
|
2332
2362
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2333
2363
|
# `MessageDeduplicationId` overrides the generated one.
|
2334
|
-
#
|
2335
2364
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2336
2365
|
# identical content sent within the deduplication interval are
|
2337
2366
|
# treated as duplicates and only one copy of the message is
|
@@ -2547,7 +2576,6 @@ module Aws::SQS
|
|
2547
2576
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2548
2577
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2549
2578
|
# the dead-letter-queue.
|
2550
|
-
#
|
2551
2579
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2552
2580
|
# the permissions for the dead-letter queue redrive permission and
|
2553
2581
|
# which source queues can specify dead-letter queues as a JSON
|
@@ -2566,7 +2594,6 @@ module Aws::SQS
|
|
2566
2594
|
#
|
2567
2595
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2568
2596
|
# parameter can specify this queue as the dead-letter queue.
|
2569
|
-
#
|
2570
2597
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2571
2598
|
# source queues that can specify this queue as the dead-letter
|
2572
2599
|
# queue and redrive messages. You can specify this parameter only
|
@@ -2628,7 +2655,6 @@ module Aws::SQS
|
|
2628
2655
|
#
|
2629
2656
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2630
2657
|
# `MessageDeduplicationId` overrides the generated one.
|
2631
|
-
#
|
2632
2658
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2633
2659
|
# identical content sent within the deduplication interval are
|
2634
2660
|
# treated as duplicates and only one copy of the message is
|
@@ -2758,7 +2784,16 @@ module Aws::SQS
|
|
2758
2784
|
include Aws::Structure
|
2759
2785
|
end
|
2760
2786
|
|
2761
|
-
# The batch request contains more entries than permissible.
|
2787
|
+
# The batch request contains more entries than permissible. For Amazon
|
2788
|
+
# SQS, the maximum number of entries you can include in a single
|
2789
|
+
# [SendMessageBatch][1], [DeleteMessageBatch][2], or
|
2790
|
+
# [ChangeMessageVisibilityBatch][3] request is 10.
|
2791
|
+
#
|
2792
|
+
#
|
2793
|
+
#
|
2794
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html
|
2795
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html
|
2796
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html
|
2762
2797
|
#
|
2763
2798
|
# @!attribute [rw] message
|
2764
2799
|
# @return [String]
|
data/lib/aws-sdk-sqs.rb
CHANGED
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.90.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:
|
11
|
+
date: 2025-01-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|