aws-sdk-sqs 1.1.0 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sqs.rb +1 -1
- data/lib/aws-sdk-sqs/client.rb +74 -46
- data/lib/aws-sdk-sqs/queue.rb +20 -10
- data/lib/aws-sdk-sqs/resource.rb +17 -9
- data/lib/aws-sdk-sqs/types.rb +61 -33
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b832bd080b632c8a3ae7e358b5b372e19f688773
|
4
|
+
data.tar.gz: 5e29312576aa3f12d403bfcedd3219147355407e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 474a3d65117fb1e5c7a6546b4adb272cdbb917420fff8ecc992cf4308751ea114f13d6ad2b5b5e2affb2f71eb593ae6d613efb1b0d89812509947c171295b53d
|
7
|
+
data.tar.gz: a9f635c4cbb2b35e1b329d99bf466e0fce34cbd86e34e6d447ee2bcffc81e20c8143274882ef26ac69fb650b0ac352bc82503d0c4be68f3bc11ba88b80b8e100
|
data/lib/aws-sdk-sqs.rb
CHANGED
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -264,12 +264,12 @@ module Aws::SQS
|
|
264
264
|
# than a total visibility timeout of 12 hours. For more information, see
|
265
265
|
# [Visibility Timeout][1] in the *Amazon SQS Developer Guide*.
|
266
266
|
#
|
267
|
-
# For example, you have a message
|
268
|
-
#
|
269
|
-
#
|
270
|
-
#
|
271
|
-
#
|
272
|
-
#
|
267
|
+
# For example, you have a message with a visibility timeout of 5
|
268
|
+
# minutes. After 3 minutes, you call `ChangeMessageVisiblity` with a
|
269
|
+
# timeout of 10 minutes. At that time, the timeout for the message is
|
270
|
+
# extended by 10 minutes beyond the time of the
|
271
|
+
# `ChangeMessageVisibility` action. This results in a total visibility
|
272
|
+
# timeout of 13 minutes. You can continue to call the
|
273
273
|
# `ChangeMessageVisibility` to extend the visibility timeout to a
|
274
274
|
# maximum of 12 hours. If you try to extend the visibility timeout
|
275
275
|
# beyond 12 hours, your request is rejected.
|
@@ -497,13 +497,21 @@ module Aws::SQS
|
|
497
497
|
# Valid values: An integer from 0 to 20 (seconds). The default is 0
|
498
498
|
# (zero).
|
499
499
|
#
|
500
|
-
# * `RedrivePolicy` - The
|
501
|
-
# functionality of the source queue. For more
|
502
|
-
# redrive policy and dead
|
503
|
-
# Letter Queues][2] in the *Amazon SQS
|
500
|
+
# * `RedrivePolicy` - The string that includes the parameters for the
|
501
|
+
# dead-letter queue functionality of the source queue. For more
|
502
|
+
# information about the redrive policy and dead-letter queues, see
|
503
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon SQS
|
504
|
+
# Developer Guide*.
|
505
|
+
#
|
506
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
507
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
508
|
+
# value of `maxReceiveCount` is exceeded.
|
509
|
+
#
|
510
|
+
# * `maxReceiveCount` - The number of times a message is delivered to
|
511
|
+
# the source queue before being moved to the dead-letter queue.
|
504
512
|
#
|
505
|
-
# <note markdown="1"> The dead
|
506
|
-
# Similarly, the dead
|
513
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
514
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
507
515
|
# standard queue.
|
508
516
|
#
|
509
517
|
# </note>
|
@@ -519,7 +527,7 @@ module Aws::SQS
|
|
519
527
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
520
528
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
521
529
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
522
|
-
# be `alias/
|
530
|
+
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
523
531
|
# Key Management Service API Reference*.
|
524
532
|
#
|
525
533
|
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
|
@@ -528,8 +536,8 @@ module Aws::SQS
|
|
528
536
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
529
537
|
# hours). The default is 300 (5 minutes). A shorter time period
|
530
538
|
# provides better security but results in more calls to KMS which
|
531
|
-
# incur charges after Free Tier. For more information, see [How
|
532
|
-
# the Data Key Reuse Period Work?][8].
|
539
|
+
# might incur charges after Free Tier. For more information, see [How
|
540
|
+
# Does the Data Key Reuse Period Work?][8].
|
533
541
|
#
|
534
542
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
535
543
|
# queues][9]\:
|
@@ -743,9 +751,9 @@ module Aws::SQS
|
|
743
751
|
req.send_request(options)
|
744
752
|
end
|
745
753
|
|
746
|
-
# Deletes the queue specified by the `QueueUrl`,
|
747
|
-
#
|
748
|
-
# successful response.
|
754
|
+
# Deletes the queue specified by the `QueueUrl`, regardless of the
|
755
|
+
# queue's contents. If the specified queue doesn't exist, Amazon SQS
|
756
|
+
# returns a successful response.
|
749
757
|
#
|
750
758
|
# Be careful with the `DeleteQueue` action: When you delete a queue, any
|
751
759
|
# messages in the queue are no longer available.
|
@@ -855,10 +863,18 @@ module Aws::SQS
|
|
855
863
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
856
864
|
# to arrive.
|
857
865
|
#
|
858
|
-
# * `RedrivePolicy` - Returns the
|
859
|
-
# functionality of the source queue. For more
|
860
|
-
# redrive policy and dead
|
861
|
-
# Letter Queues][3] in the *Amazon SQS
|
866
|
+
# * `RedrivePolicy` - Returns the string that includes the parameters
|
867
|
+
# for dead-letter queue functionality of the source queue. For more
|
868
|
+
# information about the redrive policy and dead-letter queues, see
|
869
|
+
# [Using Amazon SQS Dead-Letter Queues][3] in the *Amazon SQS
|
870
|
+
# Developer Guide*.
|
871
|
+
#
|
872
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
873
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
874
|
+
# value of `maxReceiveCount` is exceeded.
|
875
|
+
#
|
876
|
+
# * `maxReceiveCount` - The number of times a message is delivered to
|
877
|
+
# the source queue before being moved to the dead-letter queue.
|
862
878
|
#
|
863
879
|
# * `VisibilityTimeout` - Returns the visibility timeout for the queue.
|
864
880
|
# For more information about the visibility timeout, see [Visibility
|
@@ -872,23 +888,24 @@ module Aws::SQS
|
|
872
888
|
#
|
873
889
|
# * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
|
874
890
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
875
|
-
# decrypt messages before calling AWS KMS again.
|
891
|
+
# decrypt messages before calling AWS KMS again. For more information,
|
892
|
+
# see [How Does the Data Key Reuse Period Work?][7].
|
876
893
|
#
|
877
894
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
878
|
-
# queues][
|
895
|
+
# queues][8]\:
|
879
896
|
#
|
880
897
|
# * `FifoQueue` - Returns whether the queue is FIFO. For more
|
881
|
-
# information, see [FIFO Queue Logic][
|
898
|
+
# information, see [FIFO Queue Logic][9] in the *Amazon SQS Developer
|
882
899
|
# Guide*.
|
883
900
|
#
|
884
|
-
# <note markdown="1"> To determine whether a queue is [FIFO][
|
901
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][8], you can check whether
|
885
902
|
# `QueueName` ends with the `.fifo` suffix.
|
886
903
|
#
|
887
904
|
# </note>
|
888
905
|
#
|
889
906
|
# * `ContentBasedDeduplication` - Returns whether content-based
|
890
907
|
# deduplication is enabled for the queue. For more information, see
|
891
|
-
# [Exactly-Once Processing][
|
908
|
+
# [Exactly-Once Processing][10] in the *Amazon SQS Developer Guide*.
|
892
909
|
#
|
893
910
|
#
|
894
911
|
#
|
@@ -898,9 +915,10 @@ module Aws::SQS
|
|
898
915
|
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
899
916
|
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
900
917
|
# [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
901
|
-
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
902
|
-
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
903
|
-
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-
|
918
|
+
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
919
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
920
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
921
|
+
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
904
922
|
#
|
905
923
|
# @return [Types::GetQueueAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
906
924
|
#
|
@@ -976,17 +994,17 @@ module Aws::SQS
|
|
976
994
|
end
|
977
995
|
|
978
996
|
# Returns a list of your queues that have the `RedrivePolicy` queue
|
979
|
-
# attribute configured with a dead
|
997
|
+
# attribute configured with a dead-letter queue.
|
980
998
|
#
|
981
|
-
# For more information about using dead
|
982
|
-
# SQS Dead
|
999
|
+
# For more information about using dead-letter queues, see [Using Amazon
|
1000
|
+
# SQS Dead-Letter Queues][1] in the *Amazon SQS Developer Guide*.
|
983
1001
|
#
|
984
1002
|
#
|
985
1003
|
#
|
986
1004
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
987
1005
|
#
|
988
1006
|
# @option params [required, String] :queue_url
|
989
|
-
# The URL of a dead
|
1007
|
+
# The URL of a dead-letter queue.
|
990
1008
|
#
|
991
1009
|
# Queue URLs are case-sensitive.
|
992
1010
|
#
|
@@ -1127,7 +1145,7 @@ module Aws::SQS
|
|
1127
1145
|
# A message that isn't deleted or a message whose visibility isn't
|
1128
1146
|
# extended before the visibility timeout expires counts as a failed
|
1129
1147
|
# receive. Depending on the configuration of the queue, the message
|
1130
|
-
# might be sent to the dead
|
1148
|
+
# might be sent to the dead-letter queue.
|
1131
1149
|
#
|
1132
1150
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1133
1151
|
# calls this action, we recommend that you structure your code so that
|
@@ -1251,7 +1269,9 @@ module Aws::SQS
|
|
1251
1269
|
# @option params [Integer] :wait_time_seconds
|
1252
1270
|
# The duration (in seconds) for which the call waits for a message to
|
1253
1271
|
# arrive in the queue before returning. If a message is available, the
|
1254
|
-
# call returns sooner than `WaitTimeSeconds`.
|
1272
|
+
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1273
|
+
# available and the wait time expires, the call returns successfully
|
1274
|
+
# with an empty list of messages.
|
1255
1275
|
#
|
1256
1276
|
# @option params [String] :receive_request_attempt_id
|
1257
1277
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
@@ -1729,13 +1749,21 @@ module Aws::SQS
|
|
1729
1749
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
1730
1750
|
# Valid values: an integer from 0 to 20 (seconds). The default is 0.
|
1731
1751
|
#
|
1732
|
-
# * `RedrivePolicy` - The
|
1733
|
-
# functionality of the source queue. For more
|
1734
|
-
# redrive policy and dead
|
1735
|
-
# Letter Queues][2] in the *Amazon SQS
|
1752
|
+
# * `RedrivePolicy` - The string that includes the parameters for the
|
1753
|
+
# dead-letter queue functionality of the source queue. For more
|
1754
|
+
# information about the redrive policy and dead-letter queues, see
|
1755
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon SQS
|
1756
|
+
# Developer Guide*.
|
1757
|
+
#
|
1758
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
1759
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
1760
|
+
# value of `maxReceiveCount` is exceeded.
|
1761
|
+
#
|
1762
|
+
# * `maxReceiveCount` - The number of times a message is delivered to
|
1763
|
+
# the source queue before being moved to the dead-letter queue.
|
1736
1764
|
#
|
1737
|
-
# <note markdown="1"> The dead
|
1738
|
-
# Similarly, the dead
|
1765
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
1766
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
1739
1767
|
# standard queue.
|
1740
1768
|
#
|
1741
1769
|
# </note>
|
@@ -1751,7 +1779,7 @@ module Aws::SQS
|
|
1751
1779
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
1752
1780
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
1753
1781
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
1754
|
-
# be `alias/
|
1782
|
+
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
1755
1783
|
# Key Management Service API Reference*.
|
1756
1784
|
#
|
1757
1785
|
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
|
@@ -1760,8 +1788,8 @@ module Aws::SQS
|
|
1760
1788
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
1761
1789
|
# hours). The default is 300 (5 minutes). A shorter time period
|
1762
1790
|
# provides better security but results in more calls to KMS which
|
1763
|
-
# incur charges after Free Tier. For more information, see [How
|
1764
|
-
# the Data Key Reuse Period Work?][8].
|
1791
|
+
# might incur charges after Free Tier. For more information, see [How
|
1792
|
+
# Does the Data Key Reuse Period Work?][8].
|
1765
1793
|
#
|
1766
1794
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
1767
1795
|
# queues][9]\:
|
@@ -1859,7 +1887,7 @@ module Aws::SQS
|
|
1859
1887
|
params: params,
|
1860
1888
|
config: config)
|
1861
1889
|
context[:gem_name] = 'aws-sdk-sqs'
|
1862
|
-
context[:gem_version] = '1.
|
1890
|
+
context[:gem_version] = '1.2.0'
|
1863
1891
|
Seahorse::Client::Request.new(handlers, context)
|
1864
1892
|
end
|
1865
1893
|
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -312,7 +312,9 @@ module Aws::SQS
|
|
312
312
|
# @option options [Integer] :wait_time_seconds
|
313
313
|
# The duration (in seconds) for which the call waits for a message to
|
314
314
|
# arrive in the queue before returning. If a message is available, the
|
315
|
-
# call returns sooner than `WaitTimeSeconds`.
|
315
|
+
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
316
|
+
# available and the wait time expires, the call returns successfully
|
317
|
+
# with an empty list of messages.
|
316
318
|
# @option options [String] :receive_request_attempt_id
|
317
319
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
318
320
|
#
|
@@ -628,13 +630,21 @@ module Aws::SQS
|
|
628
630
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
629
631
|
# Valid values: an integer from 0 to 20 (seconds). The default is 0.
|
630
632
|
#
|
631
|
-
# * `RedrivePolicy` - The
|
632
|
-
# functionality of the source queue. For more
|
633
|
-
# redrive policy and dead
|
634
|
-
# Letter Queues][2] in the *Amazon SQS
|
633
|
+
# * `RedrivePolicy` - The string that includes the parameters for the
|
634
|
+
# dead-letter queue functionality of the source queue. For more
|
635
|
+
# information about the redrive policy and dead-letter queues, see
|
636
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon SQS
|
637
|
+
# Developer Guide*.
|
635
638
|
#
|
636
|
-
#
|
637
|
-
#
|
639
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
640
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
641
|
+
# value of `maxReceiveCount` is exceeded.
|
642
|
+
#
|
643
|
+
# * `maxReceiveCount` - The number of times a message is delivered to
|
644
|
+
# the source queue before being moved to the dead-letter queue.
|
645
|
+
#
|
646
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
647
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
638
648
|
# standard queue.
|
639
649
|
#
|
640
650
|
# </note>
|
@@ -650,7 +660,7 @@ module Aws::SQS
|
|
650
660
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
651
661
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
652
662
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
653
|
-
# be `alias/
|
663
|
+
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
654
664
|
# Key Management Service API Reference*.
|
655
665
|
#
|
656
666
|
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
|
@@ -659,8 +669,8 @@ module Aws::SQS
|
|
659
669
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
660
670
|
# hours). The default is 300 (5 minutes). A shorter time period
|
661
671
|
# provides better security but results in more calls to KMS which
|
662
|
-
# incur charges after Free Tier. For more information, see [How
|
663
|
-
# the Data Key Reuse Period Work?][8].
|
672
|
+
# might incur charges after Free Tier. For more information, see [How
|
673
|
+
# Does the Data Key Reuse Period Work?][8].
|
664
674
|
#
|
665
675
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
666
676
|
# queues][9]\:
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -70,13 +70,21 @@ module Aws::SQS
|
|
70
70
|
# Valid values: An integer from 0 to 20 (seconds). The default is 0
|
71
71
|
# (zero).
|
72
72
|
#
|
73
|
-
# * `RedrivePolicy` - The
|
74
|
-
# functionality of the source queue. For more
|
75
|
-
# redrive policy and dead
|
76
|
-
# Letter Queues][2] in the *Amazon SQS
|
73
|
+
# * `RedrivePolicy` - The string that includes the parameters for the
|
74
|
+
# dead-letter queue functionality of the source queue. For more
|
75
|
+
# information about the redrive policy and dead-letter queues, see
|
76
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon SQS
|
77
|
+
# Developer Guide*.
|
78
|
+
#
|
79
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
80
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
81
|
+
# value of `maxReceiveCount` is exceeded.
|
82
|
+
#
|
83
|
+
# * `maxReceiveCount` - The number of times a message is delivered to
|
84
|
+
# the source queue before being moved to the dead-letter queue.
|
77
85
|
#
|
78
|
-
# <note markdown="1"> The dead
|
79
|
-
# Similarly, the dead
|
86
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
87
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
80
88
|
# standard queue.
|
81
89
|
#
|
82
90
|
# </note>
|
@@ -92,7 +100,7 @@ module Aws::SQS
|
|
92
100
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
93
101
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
94
102
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
95
|
-
# be `alias/
|
103
|
+
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
96
104
|
# Key Management Service API Reference*.
|
97
105
|
#
|
98
106
|
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
|
@@ -101,8 +109,8 @@ module Aws::SQS
|
|
101
109
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
102
110
|
# hours). The default is 300 (5 minutes). A shorter time period
|
103
111
|
# provides better security but results in more calls to KMS which
|
104
|
-
# incur charges after Free Tier. For more information, see [How
|
105
|
-
# the Data Key Reuse Period Work?][8].
|
112
|
+
# might incur charges after Free Tier. For more information, see [How
|
113
|
+
# Does the Data Key Reuse Period Work?][8].
|
106
114
|
#
|
107
115
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
108
116
|
# queues][9]\:
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -321,13 +321,21 @@ module Aws::SQS
|
|
321
321
|
# arrive. Valid values: An integer from 0 to 20 (seconds). The
|
322
322
|
# default is 0 (zero).
|
323
323
|
#
|
324
|
-
# * `RedrivePolicy` - The
|
325
|
-
# functionality of the source queue. For more
|
326
|
-
# redrive policy and dead
|
327
|
-
# Letter Queues][2] in the *Amazon SQS
|
324
|
+
# * `RedrivePolicy` - The string that includes the parameters for the
|
325
|
+
# dead-letter queue functionality of the source queue. For more
|
326
|
+
# information about the redrive policy and dead-letter queues, see
|
327
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon SQS
|
328
|
+
# Developer Guide*.
|
329
|
+
#
|
330
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
331
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
332
|
+
# value of `maxReceiveCount` is exceeded.
|
333
|
+
#
|
334
|
+
# * `maxReceiveCount` - The number of times a message is delivered
|
335
|
+
# to the source queue before being moved to the dead-letter queue.
|
328
336
|
#
|
329
|
-
# <note markdown="1"> The dead
|
330
|
-
# Similarly, the dead
|
337
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
338
|
+
# Similarly, the dead-letter queue of a standard queue must also be
|
331
339
|
# a standard queue.
|
332
340
|
#
|
333
341
|
# </note>
|
@@ -343,7 +351,7 @@ module Aws::SQS
|
|
343
351
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
344
352
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
345
353
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
346
|
-
# example, be `alias/
|
354
|
+
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
347
355
|
# the *AWS Key Management Service API Reference*.
|
348
356
|
#
|
349
357
|
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
|
@@ -352,8 +360,8 @@ module Aws::SQS
|
|
352
360
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
353
361
|
# seconds (24 hours). The default is 300 (5 minutes). A shorter time
|
354
362
|
# period provides better security but results in more calls to KMS
|
355
|
-
# which incur charges after Free Tier. For more information,
|
356
|
-
# [How Does the Data Key Reuse Period Work?][8].
|
363
|
+
# which might incur charges after Free Tier. For more information,
|
364
|
+
# see [How Does the Data Key Reuse Period Work?][8].
|
357
365
|
#
|
358
366
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
359
367
|
# queues][9]\:
|
@@ -655,10 +663,18 @@ module Aws::SQS
|
|
655
663
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
656
664
|
# to arrive.
|
657
665
|
#
|
658
|
-
# * `RedrivePolicy` - Returns the
|
659
|
-
# functionality of the source queue. For more
|
660
|
-
# redrive policy and dead
|
661
|
-
# Letter Queues][3] in the *Amazon SQS
|
666
|
+
# * `RedrivePolicy` - Returns the string that includes the parameters
|
667
|
+
# for dead-letter queue functionality of the source queue. For more
|
668
|
+
# information about the redrive policy and dead-letter queues, see
|
669
|
+
# [Using Amazon SQS Dead-Letter Queues][3] in the *Amazon SQS
|
670
|
+
# Developer Guide*.
|
671
|
+
#
|
672
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
673
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
674
|
+
# value of `maxReceiveCount` is exceeded.
|
675
|
+
#
|
676
|
+
# * `maxReceiveCount` - The number of times a message is delivered
|
677
|
+
# to the source queue before being moved to the dead-letter queue.
|
662
678
|
#
|
663
679
|
# * `VisibilityTimeout` - Returns the visibility timeout for the
|
664
680
|
# queue. For more information about the visibility timeout, see
|
@@ -672,23 +688,24 @@ module Aws::SQS
|
|
672
688
|
#
|
673
689
|
# * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
|
674
690
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
675
|
-
# decrypt messages before calling AWS KMS again.
|
691
|
+
# decrypt messages before calling AWS KMS again. For more
|
692
|
+
# information, see [How Does the Data Key Reuse Period Work?][7].
|
676
693
|
#
|
677
694
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
678
|
-
# queues][
|
695
|
+
# queues][8]\:
|
679
696
|
#
|
680
697
|
# * `FifoQueue` - Returns whether the queue is FIFO. For more
|
681
|
-
# information, see [FIFO Queue Logic][
|
698
|
+
# information, see [FIFO Queue Logic][9] in the *Amazon SQS
|
682
699
|
# Developer Guide*.
|
683
700
|
#
|
684
|
-
# <note markdown="1"> To determine whether a queue is [FIFO][
|
701
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][8], you can check whether
|
685
702
|
# `QueueName` ends with the `.fifo` suffix.
|
686
703
|
#
|
687
704
|
# </note>
|
688
705
|
#
|
689
706
|
# * `ContentBasedDeduplication` - Returns whether content-based
|
690
707
|
# deduplication is enabled for the queue. For more information, see
|
691
|
-
# [Exactly-Once Processing][
|
708
|
+
# [Exactly-Once Processing][10] in the *Amazon SQS Developer Guide*.
|
692
709
|
#
|
693
710
|
#
|
694
711
|
#
|
@@ -698,9 +715,10 @@ module Aws::SQS
|
|
698
715
|
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
699
716
|
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
700
717
|
# [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
701
|
-
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
702
|
-
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
703
|
-
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-
|
718
|
+
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
719
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
720
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
721
|
+
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
704
722
|
# @return [Array<String>]
|
705
723
|
#
|
706
724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -778,7 +796,7 @@ module Aws::SQS
|
|
778
796
|
# }
|
779
797
|
#
|
780
798
|
# @!attribute [rw] queue_url
|
781
|
-
# The URL of a dead
|
799
|
+
# The URL of a dead-letter queue.
|
782
800
|
#
|
783
801
|
# Queue URLs are case-sensitive.
|
784
802
|
# @return [String]
|
@@ -794,7 +812,7 @@ module Aws::SQS
|
|
794
812
|
#
|
795
813
|
# @!attribute [rw] queue_urls
|
796
814
|
# A list of source queue URLs that have the `RedrivePolicy` queue
|
797
|
-
# attribute configured with a dead
|
815
|
+
# attribute configured with a dead-letter queue.
|
798
816
|
# @return [Array<String>]
|
799
817
|
#
|
800
818
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
|
@@ -1122,7 +1140,9 @@ module Aws::SQS
|
|
1122
1140
|
# @!attribute [rw] wait_time_seconds
|
1123
1141
|
# The duration (in seconds) for which the call waits for a message to
|
1124
1142
|
# arrive in the queue before returning. If a message is available, the
|
1125
|
-
# call returns sooner than `WaitTimeSeconds`.
|
1143
|
+
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1144
|
+
# available and the wait time expires, the call returns successfully
|
1145
|
+
# with an empty list of messages.
|
1126
1146
|
# @return [Integer]
|
1127
1147
|
#
|
1128
1148
|
# @!attribute [rw] receive_request_attempt_id
|
@@ -1816,13 +1836,21 @@ module Aws::SQS
|
|
1816
1836
|
# arrive. Valid values: an integer from 0 to 20 (seconds). The
|
1817
1837
|
# default is 0.
|
1818
1838
|
#
|
1819
|
-
# * `RedrivePolicy` - The
|
1820
|
-
# functionality of the source queue. For more
|
1821
|
-
# redrive policy and dead
|
1822
|
-
# Letter Queues][2] in the *Amazon SQS
|
1839
|
+
# * `RedrivePolicy` - The string that includes the parameters for the
|
1840
|
+
# dead-letter queue functionality of the source queue. For more
|
1841
|
+
# information about the redrive policy and dead-letter queues, see
|
1842
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon SQS
|
1843
|
+
# Developer Guide*.
|
1844
|
+
#
|
1845
|
+
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
1846
|
+
# dead-letter queue to which Amazon SQS moves messages after the
|
1847
|
+
# value of `maxReceiveCount` is exceeded.
|
1848
|
+
#
|
1849
|
+
# * `maxReceiveCount` - The number of times a message is delivered
|
1850
|
+
# to the source queue before being moved to the dead-letter queue.
|
1823
1851
|
#
|
1824
|
-
# <note markdown="1"> The dead
|
1825
|
-
# Similarly, the dead
|
1852
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
1853
|
+
# Similarly, the dead-letter queue of a standard queue must also be
|
1826
1854
|
# a standard queue.
|
1827
1855
|
#
|
1828
1856
|
# </note>
|
@@ -1838,7 +1866,7 @@ module Aws::SQS
|
|
1838
1866
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1839
1867
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
1840
1868
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
1841
|
-
# example, be `alias/
|
1869
|
+
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
1842
1870
|
# the *AWS Key Management Service API Reference*.
|
1843
1871
|
#
|
1844
1872
|
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
|
@@ -1847,8 +1875,8 @@ module Aws::SQS
|
|
1847
1875
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
1848
1876
|
# seconds (24 hours). The default is 300 (5 minutes). A shorter time
|
1849
1877
|
# period provides better security but results in more calls to KMS
|
1850
|
-
# which incur charges after Free Tier. For more information,
|
1851
|
-
# [How Does the Data Key Reuse Period Work?][8].
|
1878
|
+
# which might incur charges after Free Tier. For more information,
|
1879
|
+
# see [How Does the Data Key Reuse Period Work?][8].
|
1852
1880
|
#
|
1853
1881
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
1854
1882
|
# queues][9]\:
|
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.2.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: 2017-
|
11
|
+
date: 2017-10-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|