aws-sdk-sqs 1.35.0 → 1.40.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 +293 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-sqs.rb +2 -2
- data/lib/aws-sdk-sqs/client.rb +135 -190
- data/lib/aws-sdk-sqs/client_api.rb +1 -1
- data/lib/aws-sdk-sqs/errors.rb +1 -1
- data/lib/aws-sdk-sqs/message.rb +4 -4
- data/lib/aws-sdk-sqs/queue.rb +47 -67
- data/lib/aws-sdk-sqs/resource.rb +38 -56
- data/lib/aws-sdk-sqs/types.rb +133 -191
- metadata +11 -9
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-sqs/errors.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
data/lib/aws-sdk-sqs/message.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -43,7 +43,7 @@ module Aws::SQS
|
|
43
43
|
end
|
44
44
|
|
45
45
|
# A unique identifier for the message. A `MessageId`is considered unique
|
46
|
-
# across all
|
46
|
+
# across all accounts for an extended period of time.
|
47
47
|
# @return [String]
|
48
48
|
def message_id
|
49
49
|
data[:message_id]
|
@@ -104,8 +104,8 @@ module Aws::SQS
|
|
104
104
|
end
|
105
105
|
|
106
106
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
107
|
-
# more information, see [Amazon SQS
|
108
|
-
# *Amazon
|
107
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
108
|
+
# *Amazon SQS Developer Guide*.
|
109
109
|
#
|
110
110
|
#
|
111
111
|
#
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -94,11 +94,10 @@ module Aws::SQS
|
|
94
94
|
# characters include alphanumeric characters, hyphens (`-`), and
|
95
95
|
# underscores (`_`).
|
96
96
|
# @option options [required, Array<String>] :aws_account_ids
|
97
|
-
# The
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
# Queue Service Developer Guide*.
|
97
|
+
# The account numbers of the [principals][1] who are to receive
|
98
|
+
# permission. For information about locating the account identification,
|
99
|
+
# see [Your Amazon Web Services Identifiers][2] in the *Amazon SQS
|
100
|
+
# Developer Guide*.
|
102
101
|
#
|
103
102
|
#
|
104
103
|
#
|
@@ -110,7 +109,7 @@ module Aws::SQS
|
|
110
109
|
#
|
111
110
|
# For more information about these actions, see [Overview of Managing
|
112
111
|
# Access Permissions to Your Amazon Simple Queue Service Resource][1] in
|
113
|
-
# the *Amazon
|
112
|
+
# the *Amazon SQS Developer Guide*.
|
114
113
|
#
|
115
114
|
# Specifying `SendMessage`, `DeleteMessage`, or
|
116
115
|
# `ChangeMessageVisibility` for `ActionName.n` also grants permissions
|
@@ -215,7 +214,7 @@ module Aws::SQS
|
|
215
214
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
216
215
|
# has been received across all queues but not deleted.
|
217
216
|
#
|
218
|
-
# * `AWSTraceHeader` – Returns the
|
217
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
219
218
|
#
|
220
219
|
# * `SenderId`
|
221
220
|
#
|
@@ -314,7 +313,7 @@ module Aws::SQS
|
|
314
313
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
315
314
|
# handles. If a retry occurs within the deduplication interval, it
|
316
315
|
# resets the visibility timeout. For more information, see [Visibility
|
317
|
-
# Timeout][1] in the *Amazon
|
316
|
+
# Timeout][1] in the *Amazon SQS Developer Guide*.
|
318
317
|
#
|
319
318
|
# If a caller of the `ReceiveMessage` action still processes messages
|
320
319
|
# when the visibility timeout expires and messages become visible,
|
@@ -343,8 +342,8 @@ module Aws::SQS
|
|
343
342
|
# ``).
|
344
343
|
#
|
345
344
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
346
|
-
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
347
|
-
#
|
345
|
+
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
346
|
+
# Developer Guide*.
|
348
347
|
#
|
349
348
|
#
|
350
349
|
#
|
@@ -438,8 +437,8 @@ module Aws::SQS
|
|
438
437
|
# </note>
|
439
438
|
# @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
440
439
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
441
|
-
# more information, see [Amazon SQS
|
442
|
-
# *Amazon
|
440
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
441
|
+
# *Amazon SQS Developer Guide*.
|
443
442
|
#
|
444
443
|
#
|
445
444
|
#
|
@@ -450,7 +449,7 @@ module Aws::SQS
|
|
450
449
|
#
|
451
450
|
# * Currently, the only supported message system attribute is
|
452
451
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
453
|
-
# correctly formatted
|
452
|
+
# correctly formatted X-Ray trace header string.
|
454
453
|
#
|
455
454
|
# * The size of a message system attribute doesn't count towards the
|
456
455
|
# total size of a message.
|
@@ -461,8 +460,8 @@ module Aws::SQS
|
|
461
460
|
# particular `MessageDeduplicationId` is sent successfully, any messages
|
462
461
|
# sent with the same `MessageDeduplicationId` are accepted successfully
|
463
462
|
# but aren't delivered during the 5-minute deduplication interval. For
|
464
|
-
# more information, see [ Exactly-
|
465
|
-
#
|
463
|
+
# more information, see [ Exactly-once processing][1] in the *Amazon SQS
|
464
|
+
# Developer Guide*.
|
466
465
|
#
|
467
466
|
# * Every message must have a unique `MessageDeduplicationId`,
|
468
467
|
#
|
@@ -508,12 +507,12 @@ module Aws::SQS
|
|
508
507
|
# ``).
|
509
508
|
#
|
510
509
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
511
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
512
|
-
#
|
510
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
511
|
+
# Guide*.
|
513
512
|
#
|
514
513
|
#
|
515
514
|
#
|
516
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
515
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
517
516
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
518
517
|
# @option options [String] :message_group_id
|
519
518
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
@@ -539,8 +538,7 @@ module Aws::SQS
|
|
539
538
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
540
539
|
#
|
541
540
|
# For best practices of using `MessageGroupId`, see [Using the
|
542
|
-
# MessageGroupId Property][1] in the *Amazon
|
543
|
-
# Developer Guide*.
|
541
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
544
542
|
#
|
545
543
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
546
544
|
# Standard queues.
|
@@ -624,9 +622,10 @@ module Aws::SQS
|
|
624
622
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
625
623
|
# (4 days).
|
626
624
|
#
|
627
|
-
# * `Policy` – The queue's policy. A valid
|
628
|
-
# information about policy structure, see [Overview of
|
629
|
-
# Policies][1] in the *
|
625
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
626
|
+
# For more information about policy structure, see [Overview of Amazon
|
627
|
+
# Web Services IAM Policies][1] in the *Identity and Access Management
|
628
|
+
# User Guide*.
|
630
629
|
#
|
631
630
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
632
631
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -636,7 +635,7 @@ module Aws::SQS
|
|
636
635
|
# dead-letter queue functionality of the source queue as a JSON
|
637
636
|
# object. For more information about the redrive policy and
|
638
637
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
639
|
-
# the *Amazon
|
638
|
+
# the *Amazon SQS Developer Guide*.
|
640
639
|
#
|
641
640
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
642
641
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -656,33 +655,32 @@ module Aws::SQS
|
|
656
655
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
657
656
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
658
657
|
# Default: 30. For more information about the visibility timeout, see
|
659
|
-
# [Visibility Timeout][3] in the *Amazon
|
660
|
-
# Developer Guide*.
|
658
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
661
659
|
#
|
662
660
|
# The following attributes apply only to [server-side-encryption][4]\:
|
663
661
|
#
|
664
|
-
# * `KmsMasterKeyId` – The ID of an
|
665
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
666
|
-
# Terms][5]. While the alias of the AWS-managed
|
667
|
-
# always `alias/aws/sqs`, the alias of a custom
|
668
|
-
# be `alias/MyAlias `. For more examples, see
|
669
|
-
# Key Management Service API Reference*.
|
662
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
663
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
664
|
+
# information, see [Key Terms][5]. While the alias of the AWS-managed
|
665
|
+
# CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom
|
666
|
+
# CMK can, for example, be `alias/MyAlias `. For more examples, see
|
667
|
+
# [KeyId][6] in the *Key Management Service API Reference*.
|
670
668
|
#
|
671
669
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
672
670
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
673
|
-
# messages before calling
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
671
|
+
# messages before calling KMS again. An integer representing seconds,
|
672
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
673
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
674
|
+
# security but results in more calls to KMS which might incur charges
|
675
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
676
|
+
# Reuse Period Work?][8].
|
679
677
|
#
|
680
678
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
681
679
|
# queues][9]\:
|
682
680
|
#
|
683
681
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
684
|
-
# For more information, see [Exactly-
|
685
|
-
# *Amazon
|
682
|
+
# For more information, see [Exactly-once processing][10] in the
|
683
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
686
684
|
#
|
687
685
|
# * Every message must have a unique `MessageDeduplicationId`.
|
688
686
|
#
|
@@ -712,15 +710,8 @@ module Aws::SQS
|
|
712
710
|
# `MessageDeduplicationId`, the two messages are treated as
|
713
711
|
# duplicates and only one copy of the message is delivered.
|
714
712
|
#
|
715
|
-
#
|
716
|
-
#
|
717
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
718
|
-
# is subject to change.** This feature provides a high number of
|
719
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
720
|
-
# information on throughput quotas, see [Quotas related to messages][11]
|
721
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
722
|
-
#
|
723
|
-
# This preview includes two new attributes:
|
713
|
+
# The following attributes apply only to [high throughput for FIFO
|
714
|
+
# queues][11]\:
|
724
715
|
#
|
725
716
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
726
717
|
# occurs at the message group or queue level. Valid values are
|
@@ -739,22 +730,11 @@ module Aws::SQS
|
|
739
730
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
740
731
|
#
|
741
732
|
# If you set these attributes to anything other than the values shown
|
742
|
-
# for enabling high throughput,
|
733
|
+
# for enabling high throughput, normal throughput is in effect and
|
743
734
|
# deduplication occurs as specified.
|
744
735
|
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
# * US East (Ohio); us-east-2
|
748
|
-
#
|
749
|
-
# * US East (N. Virginia); us-east-1
|
750
|
-
#
|
751
|
-
# * US West (Oregon); us-west-2
|
752
|
-
#
|
753
|
-
# * Europe (Ireland); eu-west-1
|
754
|
-
#
|
755
|
-
# For more information about high throughput for FIFO queues, see
|
756
|
-
# [Preview: High throughput for FIFO queues][12] in the *Amazon Simple
|
757
|
-
# Queue Service Developer Guide*.
|
736
|
+
# For information on throughput quotas, see [Quotas related to
|
737
|
+
# messages][12] in the *Amazon SQS Developer Guide*.
|
758
738
|
#
|
759
739
|
#
|
760
740
|
#
|
@@ -767,9 +747,9 @@ module Aws::SQS
|
|
767
747
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
768
748
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
769
749
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
770
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
771
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
772
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
750
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
751
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
752
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
773
753
|
# @return [EmptyStructure]
|
774
754
|
def set_attributes(options = {})
|
775
755
|
options = options.merge(queue_url: @url)
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -78,9 +78,9 @@ module Aws::SQS
|
|
78
78
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
79
79
|
# (4 days).
|
80
80
|
#
|
81
|
-
# * `Policy` – The queue's policy. A valid
|
82
|
-
# information about policy structure, see [Overview of
|
83
|
-
# Policies][1] in the *Amazon IAM User Guide*.
|
81
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
82
|
+
# For more information about policy structure, see [Overview of Amazon
|
83
|
+
# Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
|
84
84
|
#
|
85
85
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
86
86
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -90,7 +90,7 @@ module Aws::SQS
|
|
90
90
|
# dead-letter queue functionality of the source queue as a JSON
|
91
91
|
# object. For more information about the redrive policy and
|
92
92
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
93
|
-
# the *Amazon
|
93
|
+
# the *Amazon SQS Developer Guide*.
|
94
94
|
#
|
95
95
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
96
96
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -110,26 +110,26 @@ module Aws::SQS
|
|
110
110
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
111
111
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
112
112
|
# Default: 30. For more information about the visibility timeout, see
|
113
|
-
# [Visibility Timeout][3] in the *Amazon
|
114
|
-
# Developer Guide*.
|
113
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
115
114
|
#
|
116
115
|
# The following attributes apply only to [server-side-encryption][4]\:
|
117
116
|
#
|
118
|
-
# * `KmsMasterKeyId` – The ID of an
|
119
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
120
|
-
# Terms][5]. While the alias of the
|
121
|
-
# always `alias/aws/sqs`, the
|
122
|
-
#
|
123
|
-
# Key Management Service API
|
117
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
118
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
119
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
120
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
121
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
122
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
123
|
+
# Reference*.
|
124
124
|
#
|
125
125
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
126
126
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
127
|
-
# messages before calling
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
127
|
+
# messages before calling KMS again. An integer representing seconds,
|
128
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
129
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
130
|
+
# security but results in more calls to KMS which might incur charges
|
131
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
132
|
+
# Reuse Period Work?][8].
|
133
133
|
#
|
134
134
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
135
135
|
# queues][9]\:
|
@@ -141,13 +141,13 @@ module Aws::SQS
|
|
141
141
|
# When you set this attribute, you must also provide the
|
142
142
|
# `MessageGroupId` for your messages explicitly.
|
143
143
|
#
|
144
|
-
# For more information, see [FIFO
|
145
|
-
#
|
144
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
145
|
+
# Developer Guide*.
|
146
146
|
#
|
147
147
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
148
148
|
# Valid values are `true` and `false`. For more information, see
|
149
|
-
# [Exactly-
|
150
|
-
#
|
149
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
150
|
+
# Note the following:
|
151
151
|
#
|
152
152
|
# * Every message must have a unique `MessageDeduplicationId`.
|
153
153
|
#
|
@@ -177,15 +177,8 @@ module Aws::SQS
|
|
177
177
|
# `MessageDeduplicationId`, the two messages are treated as
|
178
178
|
# duplicates and only one copy of the message is delivered.
|
179
179
|
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
183
|
-
# is subject to change.** This feature provides a high number of
|
184
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
185
|
-
# information on throughput quotas, see [Quotas related to messages][12]
|
186
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
187
|
-
#
|
188
|
-
# This preview includes two new attributes:
|
180
|
+
# The following attributes apply only to [high throughput for FIFO
|
181
|
+
# queues][12]\:
|
189
182
|
#
|
190
183
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
191
184
|
# occurs at the message group or queue level. Valid values are
|
@@ -204,22 +197,11 @@ module Aws::SQS
|
|
204
197
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
205
198
|
#
|
206
199
|
# If you set these attributes to anything other than the values shown
|
207
|
-
# for enabling high throughput,
|
200
|
+
# for enabling high throughput, normal throughput is in effect and
|
208
201
|
# deduplication occurs as specified.
|
209
202
|
#
|
210
|
-
#
|
211
|
-
#
|
212
|
-
# * US East (Ohio); us-east-2
|
213
|
-
#
|
214
|
-
# * US East (N. Virginia); us-east-1
|
215
|
-
#
|
216
|
-
# * US West (Oregon); us-west-2
|
217
|
-
#
|
218
|
-
# * Europe (Ireland); eu-west-1
|
219
|
-
#
|
220
|
-
# For more information about high throughput for FIFO queues, see
|
221
|
-
# [Preview: High throughput for FIFO queues][13] in the *Amazon Simple
|
222
|
-
# Queue Service Developer Guide*.
|
203
|
+
# For information on throughput quotas, see [Quotas related to
|
204
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
223
205
|
#
|
224
206
|
#
|
225
207
|
#
|
@@ -232,14 +214,14 @@ module Aws::SQS
|
|
232
214
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
233
215
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
234
216
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
235
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
236
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
237
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
238
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
217
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
218
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
219
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
220
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
239
221
|
# @option options [Hash<String,String>] :tags
|
240
222
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
241
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
242
|
-
#
|
223
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
224
|
+
# Developer Guide*.
|
243
225
|
#
|
244
226
|
# When you use queue tags, keep the following guidelines in mind:
|
245
227
|
#
|
@@ -253,15 +235,15 @@ module Aws::SQS
|
|
253
235
|
# * A new tag with a key identical to that of an existing tag overwrites
|
254
236
|
# the existing tag.
|
255
237
|
#
|
256
|
-
# For a full list of tag restrictions, see [
|
257
|
-
# in the *Amazon
|
238
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
239
|
+
# in the *Amazon SQS Developer Guide*.
|
258
240
|
#
|
259
241
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
260
242
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
261
243
|
#
|
262
244
|
# Cross-account permissions don't apply to this action. For more
|
263
245
|
# information, see [Grant cross-account permissions to a role and a user
|
264
|
-
# name][3] in the *Amazon
|
246
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
265
247
|
#
|
266
248
|
# </note>
|
267
249
|
#
|
@@ -293,7 +275,7 @@ module Aws::SQS
|
|
293
275
|
#
|
294
276
|
# Queue URLs and names are case-sensitive.
|
295
277
|
# @option options [String] :queue_owner_aws_account_id
|
296
|
-
# The
|
278
|
+
# The account ID of the account that created the queue.
|
297
279
|
# @return [Queue]
|
298
280
|
def get_queue_by_name(options = {})
|
299
281
|
resp = @client.get_queue_url(options)
|