aws-sdk-sqs 1.89.0 → 1.90.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +86 -48
- data/lib/aws-sdk-sqs/queue.rb +38 -5
- data/lib/aws-sdk-sqs/queue_poller.rb +1 -1
- data/lib/aws-sdk-sqs/resource.rb +7 -7
- data/lib/aws-sdk-sqs/types.rb +71 -24
- 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
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:
|
@@ -1100,12 +1107,14 @@ module Aws::SQS
|
|
1100
1107
|
# automatically deletes messages left in a queue longer than the
|
1101
1108
|
# retention period configured for the queue.
|
1102
1109
|
#
|
1103
|
-
# <note markdown="1">
|
1104
|
-
#
|
1105
|
-
#
|
1106
|
-
#
|
1107
|
-
#
|
1108
|
-
#
|
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.
|
1109
1118
|
#
|
1110
1119
|
# For standard queues, it is possible to receive a message even after
|
1111
1120
|
# you delete it. This might happen on rare occasions if one of the
|
@@ -1476,29 +1485,32 @@ module Aws::SQS
|
|
1476
1485
|
req.send_request(options)
|
1477
1486
|
end
|
1478
1487
|
|
1479
|
-
#
|
1480
|
-
#
|
1481
|
-
#
|
1482
|
-
#
|
1483
|
-
#
|
1484
|
-
# the
|
1485
|
-
#
|
1486
|
-
#
|
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*.
|
1487
1499
|
#
|
1488
1500
|
#
|
1489
1501
|
#
|
1490
1502
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue
|
1491
1503
|
#
|
1492
1504
|
# @option params [required, String] :queue_name
|
1493
|
-
# The name of the queue
|
1494
|
-
#
|
1495
|
-
# underscores (
|
1496
|
-
#
|
1497
|
-
# 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.
|
1498
1509
|
#
|
1499
1510
|
# @option params [String] :queue_owner_aws_account_id
|
1500
|
-
# The Amazon Web Services account ID of the account that
|
1501
|
-
# 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.
|
1502
1514
|
#
|
1503
1515
|
# @return [Types::GetQueueUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1504
1516
|
#
|
@@ -1798,7 +1810,7 @@ module Aws::SQS
|
|
1798
1810
|
# Developer Guide*.
|
1799
1811
|
#
|
1800
1812
|
# Short poll is the default behavior where a weighted random set of
|
1801
|
-
# machines is sampled on a `ReceiveMessage` call.
|
1813
|
+
# machines is sampled on a `ReceiveMessage` call. Therefore, only the
|
1802
1814
|
# messages on the sampled machines are returned. If the number of
|
1803
1815
|
# messages in the queue is small (fewer than 1,000), you most likely get
|
1804
1816
|
# fewer messages than you requested per `ReceiveMessage` call. If the
|
@@ -1828,14 +1840,8 @@ module Aws::SQS
|
|
1828
1840
|
# You can provide the `VisibilityTimeout` parameter in your request. The
|
1829
1841
|
# parameter is applied to the messages that Amazon SQS returns in the
|
1830
1842
|
# response. If you don't include the parameter, the overall visibility
|
1831
|
-
# timeout for the queue is used for the returned messages.
|
1832
|
-
#
|
1833
|
-
# Guide*.
|
1834
|
-
#
|
1835
|
-
# A message that isn't deleted or a message whose visibility isn't
|
1836
|
-
# extended before the visibility timeout expires counts as a failed
|
1837
|
-
# receive. Depending on the configuration of the queue, the message
|
1838
|
-
# 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.
|
1839
1845
|
#
|
1840
1846
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1841
1847
|
# calls this action, we recommend that you structure your code so that
|
@@ -1848,7 +1854,6 @@ module Aws::SQS
|
|
1848
1854
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html
|
1849
1855
|
# [2]: https://www.ietf.org/rfc/rfc1321.txt
|
1850
1856
|
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html
|
1851
|
-
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1852
1857
|
#
|
1853
1858
|
# @option params [required, String] :queue_url
|
1854
1859
|
# The URL of the Amazon SQS queue from which messages are received.
|
@@ -1856,9 +1861,9 @@ module Aws::SQS
|
|
1856
1861
|
# Queue URLs and names are case-sensitive.
|
1857
1862
|
#
|
1858
1863
|
# @option params [Array<String>] :attribute_names
|
1859
|
-
# This parameter has been
|
1860
|
-
# compatibility. To provide attribute names, you are encouraged
|
1861
|
-
# `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`.
|
1862
1867
|
#
|
1863
1868
|
# A list of attributes that need to be returned along with each message.
|
1864
1869
|
# These attributes include:
|
@@ -1975,14 +1980,47 @@ module Aws::SQS
|
|
1975
1980
|
# @option params [Integer] :visibility_timeout
|
1976
1981
|
# The duration (in seconds) that the received messages are hidden from
|
1977
1982
|
# subsequent retrieve requests after being retrieved by a
|
1978
|
-
# `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
|
1979
2015
|
#
|
1980
2016
|
# @option params [Integer] :wait_time_seconds
|
1981
2017
|
# The duration (in seconds) for which the call waits for a message to
|
1982
2018
|
# arrive in the queue before returning. If a message is available, the
|
1983
2019
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1984
2020
|
# available and the wait time expires, the call does not return a
|
1985
|
-
# 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.
|
1986
2024
|
#
|
1987
2025
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1988
2026
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -2897,7 +2935,7 @@ module Aws::SQS
|
|
2897
2935
|
tracer: tracer
|
2898
2936
|
)
|
2899
2937
|
context[:gem_name] = 'aws-sdk-sqs'
|
2900
|
-
context[:gem_version] = '1.
|
2938
|
+
context[:gem_version] = '1.90.0'
|
2901
2939
|
Seahorse::Client::Request.new(handlers, context)
|
2902
2940
|
end
|
2903
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:
|
@@ -331,13 +331,46 @@ module Aws::SQS
|
|
331
331
|
# @option options [Integer] :visibility_timeout
|
332
332
|
# The duration (in seconds) that the received messages are hidden from
|
333
333
|
# subsequent retrieve requests after being retrieved by a
|
334
|
-
# `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
|
335
366
|
# @option options [Integer] :wait_time_seconds
|
336
367
|
# The duration (in seconds) for which the call waits for a message to
|
337
368
|
# arrive in the queue before returning. If a message is available, the
|
338
369
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
339
370
|
# available and the wait time expires, the call does not return a
|
340
|
-
# 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.
|
341
374
|
#
|
342
375
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
343
376
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -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
@@ -308,14 +308,14 @@ module Aws::SQS
|
|
308
308
|
# })
|
309
309
|
# @param [Hash] options ({})
|
310
310
|
# @option options [required, String] :queue_name
|
311
|
-
# The name of the queue
|
312
|
-
#
|
313
|
-
# underscores (
|
314
|
-
#
|
315
|
-
# 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.
|
316
315
|
# @option options [String] :queue_owner_aws_account_id
|
317
|
-
# The Amazon Web Services account ID of the account that
|
318
|
-
# 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.
|
319
319
|
# @return [Queue]
|
320
320
|
def get_queue_by_name(options = {})
|
321
321
|
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -893,17 +893,20 @@ module Aws::SQS
|
|
893
893
|
include Aws::Structure
|
894
894
|
end
|
895
895
|
|
896
|
-
#
|
897
|
-
#
|
898
|
-
# characters. Valid values: alphanumeric characters, hyphens (`-`),
|
899
|
-
# and underscores (`_`).
|
896
|
+
# Retrieves the URL of an existing queue based on its name and,
|
897
|
+
# optionally, the Amazon Web Services account ID.
|
900
898
|
#
|
901
|
-
#
|
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.
|
902
904
|
# @return [String]
|
903
905
|
#
|
904
906
|
# @!attribute [rw] queue_owner_aws_account_id
|
905
|
-
# The Amazon Web Services account ID of the account that
|
906
|
-
# 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.
|
907
910
|
# @return [String]
|
908
911
|
#
|
909
912
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
|
@@ -934,7 +937,7 @@ module Aws::SQS
|
|
934
937
|
include Aws::Structure
|
935
938
|
end
|
936
939
|
|
937
|
-
# The
|
940
|
+
# The specified ID is invalid.
|
938
941
|
#
|
939
942
|
# @!attribute [rw] message
|
940
943
|
# @return [String]
|
@@ -1006,7 +1009,7 @@ module Aws::SQS
|
|
1006
1009
|
include Aws::Structure
|
1007
1010
|
end
|
1008
1011
|
|
1009
|
-
#
|
1012
|
+
# The request was not made over HTTPS or did not use SigV4 for signing.
|
1010
1013
|
#
|
1011
1014
|
# @!attribute [rw] message
|
1012
1015
|
# @return [String]
|
@@ -1605,7 +1608,8 @@ module Aws::SQS
|
|
1605
1608
|
include Aws::Structure
|
1606
1609
|
end
|
1607
1610
|
|
1608
|
-
#
|
1611
|
+
# Ensure that the `QueueUrl` is correct and that the queue has not been
|
1612
|
+
# deleted.
|
1609
1613
|
#
|
1610
1614
|
# @!attribute [rw] message
|
1611
1615
|
# @return [String]
|
@@ -1646,6 +1650,8 @@ module Aws::SQS
|
|
1646
1650
|
include Aws::Structure
|
1647
1651
|
end
|
1648
1652
|
|
1653
|
+
# Retrieves one or more messages from a specified queue.
|
1654
|
+
#
|
1649
1655
|
# @!attribute [rw] queue_url
|
1650
1656
|
# The URL of the Amazon SQS queue from which messages are received.
|
1651
1657
|
#
|
@@ -1653,7 +1659,7 @@ module Aws::SQS
|
|
1653
1659
|
# @return [String]
|
1654
1660
|
#
|
1655
1661
|
# @!attribute [rw] attribute_names
|
1656
|
-
# This parameter has been
|
1662
|
+
# This parameter has been discontinued but will be supported for
|
1657
1663
|
# backward compatibility. To provide attribute names, you are
|
1658
1664
|
# encouraged to use `MessageSystemAttributeNames`.
|
1659
1665
|
#
|
@@ -1780,7 +1786,39 @@ module Aws::SQS
|
|
1780
1786
|
# @!attribute [rw] visibility_timeout
|
1781
1787
|
# The duration (in seconds) that the received messages are hidden from
|
1782
1788
|
# subsequent retrieve requests after being retrieved by a
|
1783
|
-
# `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
|
1784
1822
|
# @return [Integer]
|
1785
1823
|
#
|
1786
1824
|
# @!attribute [rw] wait_time_seconds
|
@@ -1788,7 +1826,9 @@ module Aws::SQS
|
|
1788
1826
|
# arrive in the queue before returning. If a message is available, the
|
1789
1827
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1790
1828
|
# available and the wait time expires, the call does not return a
|
1791
|
-
# 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.
|
1792
1832
|
#
|
1793
1833
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1794
1834
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1918,18 +1958,16 @@ module Aws::SQS
|
|
1918
1958
|
|
1919
1959
|
# The request was denied due to request throttling.
|
1920
1960
|
#
|
1921
|
-
# *
|
1922
|
-
#
|
1961
|
+
# * Exceeds the permitted request rate for the queue or for the
|
1962
|
+
# recipient of the request.
|
1963
|
+
#
|
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*.
|
1967
|
+
#
|
1923
1968
|
#
|
1924
|
-
# * A burst or sustained high rate of requests to change the state of
|
1925
|
-
# the same KMS key. This condition is often known as a "hot key."
|
1926
1969
|
#
|
1927
|
-
#
|
1928
|
-
# CloudHSM key store might be throttled at a lower-than-expected rate
|
1929
|
-
# when the Amazon Web Services CloudHSM cluster associated with the
|
1930
|
-
# Amazon Web Services CloudHSM key store is processing numerous
|
1931
|
-
# commands, including those unrelated to the Amazon Web Services
|
1932
|
-
# CloudHSM key store.
|
1970
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests
|
1933
1971
|
#
|
1934
1972
|
# @!attribute [rw] message
|
1935
1973
|
# @return [String]
|
@@ -2746,7 +2784,16 @@ module Aws::SQS
|
|
2746
2784
|
include Aws::Structure
|
2747
2785
|
end
|
2748
2786
|
|
2749
|
-
# 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
|
2750
2797
|
#
|
2751
2798
|
# @!attribute [rw] message
|
2752
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
|