aws-sdk-sqs 1.38.0 → 1.42.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs.rb +1 -1
- data/lib/aws-sdk-sqs/client.rb +134 -189
- data/lib/aws-sdk-sqs/message.rb +3 -3
- data/lib/aws-sdk-sqs/queue.rb +46 -66
- data/lib/aws-sdk-sqs/resource.rb +37 -55
- data/lib/aws-sdk-sqs/types.rb +124 -180
- metadata +5 -6
data/lib/aws-sdk-sqs/message.rb
CHANGED
@@ -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
@@ -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
@@ -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)
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -34,11 +34,10 @@ module Aws::SQS
|
|
34
34
|
# @return [String]
|
35
35
|
#
|
36
36
|
# @!attribute [rw] aws_account_ids
|
37
|
-
# The
|
38
|
-
# permission.
|
39
|
-
#
|
40
|
-
#
|
41
|
-
# *Amazon Simple Queue Service Developer Guide*.
|
37
|
+
# The account numbers of the [principals][1] who are to receive
|
38
|
+
# permission. For information about locating the account
|
39
|
+
# identification, see [Your Amazon Web Services Identifiers][2] in the
|
40
|
+
# *Amazon SQS Developer Guide*.
|
42
41
|
#
|
43
42
|
#
|
44
43
|
#
|
@@ -52,7 +51,7 @@ module Aws::SQS
|
|
52
51
|
#
|
53
52
|
# For more information about these actions, see [Overview of Managing
|
54
53
|
# Access Permissions to Your Amazon Simple Queue Service Resource][1]
|
55
|
-
# in the *Amazon
|
54
|
+
# in the *Amazon SQS Developer Guide*.
|
56
55
|
#
|
57
56
|
# Specifying `SendMessage`, `DeleteMessage`, or
|
58
57
|
# `ChangeMessageVisibility` for `ActionName.n` also grants permissions
|
@@ -327,9 +326,10 @@ module Aws::SQS
|
|
327
326
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
328
327
|
# 345,600 (4 days).
|
329
328
|
#
|
330
|
-
# * `Policy` – The queue's policy. A valid
|
331
|
-
# information about policy structure, see [Overview
|
332
|
-
# Policies][1] in the *Amazon IAM User
|
329
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
330
|
+
# policy. For more information about policy structure, see [Overview
|
331
|
+
# of Amazon Web Services IAM Policies][1] in the *Amazon IAM User
|
332
|
+
# Guide*.
|
333
333
|
#
|
334
334
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
335
335
|
# for which a ` ReceiveMessage ` action waits for a message to
|
@@ -340,7 +340,7 @@ module Aws::SQS
|
|
340
340
|
# dead-letter queue functionality of the source queue as a JSON
|
341
341
|
# object. For more information about the redrive policy and
|
342
342
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
-
# in the *Amazon
|
343
|
+
# in the *Amazon SQS Developer Guide*.
|
344
344
|
#
|
345
345
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
346
346
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -361,26 +361,26 @@ module Aws::SQS
|
|
361
361
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
362
362
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
363
363
|
# Default: 30. For more information about the visibility timeout,
|
364
|
-
# see [Visibility Timeout][3] in the *Amazon
|
365
|
-
# Developer Guide*.
|
364
|
+
# see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
366
365
|
#
|
367
366
|
# The following attributes apply only to [server-side-encryption][4]\:
|
368
367
|
#
|
369
|
-
# * `KmsMasterKeyId` – The ID of an
|
370
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
371
|
-
# [Key Terms][5]. While the alias of the
|
372
|
-
# SQS is always `alias/aws/sqs`, the
|
373
|
-
# example, be `alias/MyAlias `. For
|
374
|
-
# the *
|
368
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
369
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
370
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
371
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
372
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
373
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
374
|
+
# Reference*.
|
375
375
|
#
|
376
376
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
377
377
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
378
|
-
# decrypt messages before calling
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
378
|
+
# decrypt messages before calling KMS again. An integer representing
|
379
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
380
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
381
|
+
# better security but results in more calls to KMS which might incur
|
382
|
+
# charges after Free Tier. For more information, see [How Does the
|
383
|
+
# Data Key Reuse Period Work?][8].
|
384
384
|
#
|
385
385
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
386
386
|
# queues][9]\:
|
@@ -392,13 +392,13 @@ module Aws::SQS
|
|
392
392
|
# existing queue. When you set this attribute, you must also provide
|
393
393
|
# the `MessageGroupId` for your messages explicitly.
|
394
394
|
#
|
395
|
-
# For more information, see [FIFO
|
396
|
-
#
|
395
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon
|
396
|
+
# SQS Developer Guide*.
|
397
397
|
#
|
398
398
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
399
399
|
# Valid values are `true` and `false`. For more information, see
|
400
|
-
# [Exactly-
|
401
|
-
#
|
400
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
401
|
+
# Note the following:
|
402
402
|
#
|
403
403
|
# * Every message must have a unique `MessageDeduplicationId`.
|
404
404
|
#
|
@@ -428,15 +428,8 @@ module Aws::SQS
|
|
428
428
|
# `MessageDeduplicationId`, the two messages are treated as
|
429
429
|
# duplicates and only one copy of the message is delivered.
|
430
430
|
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release
|
434
|
-
# and is subject to change.** This feature provides a high number of
|
435
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
436
|
-
# information on throughput quotas, see [Quotas related to
|
437
|
-
# messages][12] in the *Amazon Simple Queue Service Developer Guide*.
|
438
|
-
#
|
439
|
-
# This preview includes two new attributes:
|
431
|
+
# The following attributes apply only to [high throughput for FIFO
|
432
|
+
# queues][12]\:
|
440
433
|
#
|
441
434
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
442
435
|
# occurs at the message group or queue level. Valid values are
|
@@ -455,22 +448,11 @@ module Aws::SQS
|
|
455
448
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
456
449
|
#
|
457
450
|
# If you set these attributes to anything other than the values shown
|
458
|
-
# for enabling high throughput,
|
451
|
+
# for enabling high throughput, normal throughput is in effect and
|
459
452
|
# deduplication occurs as specified.
|
460
453
|
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
# * US East (Ohio); us-east-2
|
464
|
-
#
|
465
|
-
# * US East (N. Virginia); us-east-1
|
466
|
-
#
|
467
|
-
# * US West (Oregon); us-west-2
|
468
|
-
#
|
469
|
-
# * Europe (Ireland); eu-west-1
|
470
|
-
#
|
471
|
-
# For more information about high throughput for FIFO queues, see
|
472
|
-
# [Preview: High throughput for FIFO queues][13] in the *Amazon Simple
|
473
|
-
# Queue Service Developer Guide*.
|
454
|
+
# For information on throughput quotas, see [Quotas related to
|
455
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
474
456
|
#
|
475
457
|
#
|
476
458
|
#
|
@@ -483,16 +465,16 @@ module Aws::SQS
|
|
483
465
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
484
466
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
485
467
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
486
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
487
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
488
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
489
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
468
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
469
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
470
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
471
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
490
472
|
# @return [Hash<String,String>]
|
491
473
|
#
|
492
474
|
# @!attribute [rw] tags
|
493
475
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
494
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
495
|
-
#
|
476
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
477
|
+
# Developer Guide*.
|
496
478
|
#
|
497
479
|
# When you use queue tags, keep the following guidelines in mind:
|
498
480
|
#
|
@@ -506,15 +488,15 @@ module Aws::SQS
|
|
506
488
|
# * A new tag with a key identical to that of an existing tag
|
507
489
|
# overwrites the existing tag.
|
508
490
|
#
|
509
|
-
# For a full list of tag restrictions, see [
|
510
|
-
#
|
491
|
+
# For a full list of tag restrictions, see [Quotas related to
|
492
|
+
# queues][2] in the *Amazon SQS Developer Guide*.
|
511
493
|
#
|
512
494
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
513
495
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
514
496
|
#
|
515
497
|
# Cross-account permissions don't apply to this action. For more
|
516
498
|
# information, see [Grant cross-account permissions to a role and a
|
517
|
-
# user name][3] in the *Amazon
|
499
|
+
# user name][3] in the *Amazon SQS Developer Guide*.
|
518
500
|
#
|
519
501
|
# </note>
|
520
502
|
#
|
@@ -724,6 +706,10 @@ module Aws::SQS
|
|
724
706
|
# @!attribute [rw] attribute_names
|
725
707
|
# A list of attributes for which to retrieve information.
|
726
708
|
#
|
709
|
+
# The `AttributeName.N` parameter is optional, but if you don't
|
710
|
+
# specify values for this parameter, the request returns empty
|
711
|
+
# results.
|
712
|
+
#
|
727
713
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
728
714
|
# calls this action, we recommend that you structure your code so that
|
729
715
|
# it can handle new attributes gracefully.
|
@@ -783,7 +769,7 @@ module Aws::SQS
|
|
783
769
|
# dead-letter queue functionality of the source queue as a JSON
|
784
770
|
# object. For more information about the redrive policy and
|
785
771
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
786
|
-
# in the *Amazon
|
772
|
+
# in the *Amazon SQS Developer Guide*.
|
787
773
|
#
|
788
774
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
789
775
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -797,26 +783,25 @@ module Aws::SQS
|
|
797
783
|
#
|
798
784
|
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
799
785
|
# queue. For more information about the visibility timeout, see
|
800
|
-
# [Visibility Timeout][3] in the *Amazon
|
801
|
-
# Developer Guide*.
|
786
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
802
787
|
#
|
803
788
|
# The following attributes apply only to [server-side-encryption][4]\:
|
804
789
|
#
|
805
|
-
# * `KmsMasterKeyId` – Returns the ID of an
|
806
|
-
# master key (CMK) for Amazon SQS or a custom CMK.
|
807
|
-
# information, see [Key Terms][5].
|
790
|
+
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
|
791
|
+
# managed customer master key (CMK) for Amazon SQS or a custom CMK.
|
792
|
+
# For more information, see [Key Terms][5].
|
808
793
|
#
|
809
794
|
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
810
795
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
811
|
-
# decrypt messages before calling
|
812
|
-
#
|
796
|
+
# decrypt messages before calling KMS again. For more information,
|
797
|
+
# see [How Does the Data Key Reuse Period Work?][6].
|
813
798
|
#
|
814
799
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
815
800
|
# queues][7]\:
|
816
801
|
#
|
817
802
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
818
|
-
# For more information, see [FIFO
|
819
|
-
#
|
803
|
+
# For more information, see [FIFO queue logic][8] in the *Amazon SQS
|
804
|
+
# Developer Guide*.
|
820
805
|
#
|
821
806
|
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
822
807
|
# `QueueName` ends with the `.fifo` suffix.
|
@@ -825,18 +810,10 @@ module Aws::SQS
|
|
825
810
|
#
|
826
811
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
827
812
|
# deduplication is enabled for the queue. For more information, see
|
828
|
-
# [Exactly-
|
829
|
-
# Developer Guide*.
|
830
|
-
#
|
831
|
-
# **Preview: High throughput for FIFO queues**
|
813
|
+
# [Exactly-once processing][9] in the *Amazon SQS Developer Guide*.
|
832
814
|
#
|
833
|
-
#
|
834
|
-
#
|
835
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
836
|
-
# information on throughput quotas, see [Quotas related to
|
837
|
-
# messages][10] in the *Amazon Simple Queue Service Developer Guide*.
|
838
|
-
#
|
839
|
-
# This preview includes two new attributes:
|
815
|
+
# The following attributes apply only to [high throughput for FIFO
|
816
|
+
# queues][10]\:
|
840
817
|
#
|
841
818
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
842
819
|
# occurs at the message group or queue level. Valid values are
|
@@ -855,22 +832,11 @@ module Aws::SQS
|
|
855
832
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
856
833
|
#
|
857
834
|
# If you set these attributes to anything other than the values shown
|
858
|
-
# for enabling high throughput,
|
835
|
+
# for enabling high throughput, normal throughput is in effect and
|
859
836
|
# deduplication occurs as specified.
|
860
837
|
#
|
861
|
-
#
|
862
|
-
#
|
863
|
-
# * US East (Ohio); us-east-2
|
864
|
-
#
|
865
|
-
# * US East (N. Virginia); us-east-1
|
866
|
-
#
|
867
|
-
# * US West (Oregon); us-west-2
|
868
|
-
#
|
869
|
-
# * Europe (Ireland); eu-west-1
|
870
|
-
#
|
871
|
-
# For more information about high throughput for FIFO queues, see
|
872
|
-
# [Preview: High throughput for FIFO queues][11] in the *Amazon Simple
|
873
|
-
# Queue Service Developer Guide*.
|
838
|
+
# For information on throughput quotas, see [Quotas related to
|
839
|
+
# messages][11] in the *Amazon SQS Developer Guide*.
|
874
840
|
#
|
875
841
|
#
|
876
842
|
#
|
@@ -881,10 +847,10 @@ module Aws::SQS
|
|
881
847
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
882
848
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
883
849
|
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
884
|
-
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
885
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
886
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
887
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
850
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
851
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
852
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
853
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
888
854
|
# @return [Array<String>]
|
889
855
|
#
|
890
856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -927,7 +893,7 @@ module Aws::SQS
|
|
927
893
|
# @return [String]
|
928
894
|
#
|
929
895
|
# @!attribute [rw] queue_owner_aws_account_id
|
930
|
-
# The
|
896
|
+
# The account ID of the account that created the queue.
|
931
897
|
# @return [String]
|
932
898
|
#
|
933
899
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
|
@@ -940,7 +906,7 @@ module Aws::SQS
|
|
940
906
|
end
|
941
907
|
|
942
908
|
# For more information, see [Interpreting Responses][1] in the *Amazon
|
943
|
-
#
|
909
|
+
# SQS Developer Guide*.
|
944
910
|
#
|
945
911
|
#
|
946
912
|
#
|
@@ -1133,7 +1099,7 @@ module Aws::SQS
|
|
1133
1099
|
#
|
1134
1100
|
# @!attribute [rw] message_id
|
1135
1101
|
# A unique identifier for the message. A `MessageId`is considered
|
1136
|
-
# unique across all
|
1102
|
+
# unique across all accounts for an extended period of time.
|
1137
1103
|
# @return [String]
|
1138
1104
|
#
|
1139
1105
|
# @!attribute [rw] receipt_handle
|
@@ -1192,8 +1158,8 @@ module Aws::SQS
|
|
1192
1158
|
#
|
1193
1159
|
# @!attribute [rw] message_attributes
|
1194
1160
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
1195
|
-
# For more information, see [Amazon SQS
|
1196
|
-
# *Amazon
|
1161
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
1162
|
+
# *Amazon SQS Developer Guide*.
|
1197
1163
|
#
|
1198
1164
|
#
|
1199
1165
|
#
|
@@ -1262,8 +1228,7 @@ module Aws::SQS
|
|
1262
1228
|
# `StringValue`.
|
1263
1229
|
#
|
1264
1230
|
# You can also append custom labels. For more information, see [Amazon
|
1265
|
-
# SQS Message Attributes][1] in the *Amazon
|
1266
|
-
# Developer Guide*.
|
1231
|
+
# SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
|
1267
1232
|
#
|
1268
1233
|
#
|
1269
1234
|
#
|
@@ -1334,8 +1299,7 @@ module Aws::SQS
|
|
1334
1299
|
# `StringValue`.
|
1335
1300
|
#
|
1336
1301
|
# You can also append custom labels. For more information, see [Amazon
|
1337
|
-
# SQS Message Attributes][1] in the *Amazon
|
1338
|
-
# Developer Guide*.
|
1302
|
+
# SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
|
1339
1303
|
#
|
1340
1304
|
#
|
1341
1305
|
#
|
@@ -1452,7 +1416,7 @@ module Aws::SQS
|
|
1452
1416
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1453
1417
|
# has been received across all queues but not deleted.
|
1454
1418
|
#
|
1455
|
-
# * `AWSTraceHeader` – Returns the
|
1419
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1456
1420
|
#
|
1457
1421
|
# * `SenderId`
|
1458
1422
|
#
|
@@ -1562,8 +1526,7 @@ module Aws::SQS
|
|
1562
1526
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
1563
1527
|
# handles. If a retry occurs within the deduplication interval, it
|
1564
1528
|
# resets the visibility timeout. For more information, see
|
1565
|
-
# [Visibility Timeout][1] in the *Amazon
|
1566
|
-
# Developer Guide*.
|
1529
|
+
# [Visibility Timeout][1] in the *Amazon SQS Developer Guide*.
|
1567
1530
|
#
|
1568
1531
|
# If a caller of the `ReceiveMessage` action still processes
|
1569
1532
|
# messages when the visibility timeout expires and messages become
|
@@ -1594,8 +1557,8 @@ module Aws::SQS
|
|
1594
1557
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
1595
1558
|
#
|
1596
1559
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using
|
1597
|
-
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
1598
|
-
#
|
1560
|
+
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
1561
|
+
# Developer Guide*.
|
1599
1562
|
#
|
1600
1563
|
#
|
1601
1564
|
#
|
@@ -1776,8 +1739,8 @@ module Aws::SQS
|
|
1776
1739
|
#
|
1777
1740
|
# @!attribute [rw] message_attributes
|
1778
1741
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
1779
|
-
# For more information, see [Amazon SQS
|
1780
|
-
# *Amazon
|
1742
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
1743
|
+
# *Amazon SQS Developer Guide*.
|
1781
1744
|
#
|
1782
1745
|
#
|
1783
1746
|
#
|
@@ -1790,7 +1753,7 @@ module Aws::SQS
|
|
1790
1753
|
#
|
1791
1754
|
# * Currently, the only supported message system attribute is
|
1792
1755
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1793
|
-
# a correctly formatted
|
1756
|
+
# a correctly formatted X-Ray trace header string.
|
1794
1757
|
#
|
1795
1758
|
# * The size of a message system attribute doesn't count towards the
|
1796
1759
|
# total size of a message.
|
@@ -1803,8 +1766,8 @@ module Aws::SQS
|
|
1803
1766
|
# minimum deduplication interval. If a message with a particular
|
1804
1767
|
# `MessageDeduplicationId` is sent successfully, subsequent messages
|
1805
1768
|
# with the same `MessageDeduplicationId` are accepted successfully but
|
1806
|
-
# aren't delivered. For more information, see [ Exactly-
|
1807
|
-
#
|
1769
|
+
# aren't delivered. For more information, see [ Exactly-once
|
1770
|
+
# processing][1] in the *Amazon SQS Developer Guide*.
|
1808
1771
|
#
|
1809
1772
|
# * Every message must have a unique `MessageDeduplicationId`,
|
1810
1773
|
#
|
@@ -1853,12 +1816,12 @@ module Aws::SQS
|
|
1853
1816
|
# ``).
|
1854
1817
|
#
|
1855
1818
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
1856
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
1857
|
-
#
|
1819
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
1820
|
+
# Guide*.
|
1858
1821
|
#
|
1859
1822
|
#
|
1860
1823
|
#
|
1861
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
1824
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
1862
1825
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
1863
1826
|
# @return [String]
|
1864
1827
|
#
|
@@ -1887,8 +1850,7 @@ module Aws::SQS
|
|
1887
1850
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1888
1851
|
#
|
1889
1852
|
# For best practices of using `MessageGroupId`, see [Using the
|
1890
|
-
# MessageGroupId Property][1] in the *Amazon
|
1891
|
-
# Developer Guide*.
|
1853
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
1892
1854
|
#
|
1893
1855
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
1894
1856
|
# Standard queues.
|
@@ -2071,8 +2033,8 @@ module Aws::SQS
|
|
2071
2033
|
#
|
2072
2034
|
# @!attribute [rw] message_attributes
|
2073
2035
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
2074
|
-
# For more information, see [Amazon SQS
|
2075
|
-
# *Amazon
|
2036
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
2037
|
+
# *Amazon SQS Developer Guide*.
|
2076
2038
|
#
|
2077
2039
|
#
|
2078
2040
|
#
|
@@ -2085,7 +2047,7 @@ module Aws::SQS
|
|
2085
2047
|
#
|
2086
2048
|
# * Currently, the only supported message system attribute is
|
2087
2049
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
2088
|
-
# a correctly formatted
|
2050
|
+
# a correctly formatted X-Ray trace header string.
|
2089
2051
|
#
|
2090
2052
|
# * The size of a message system attribute doesn't count towards the
|
2091
2053
|
# total size of a message.
|
@@ -2098,8 +2060,8 @@ module Aws::SQS
|
|
2098
2060
|
# a particular `MessageDeduplicationId` is sent successfully, any
|
2099
2061
|
# messages sent with the same `MessageDeduplicationId` are accepted
|
2100
2062
|
# successfully but aren't delivered during the 5-minute deduplication
|
2101
|
-
# interval. For more information, see [ Exactly-
|
2102
|
-
# the *Amazon
|
2063
|
+
# interval. For more information, see [ Exactly-once processing][1] in
|
2064
|
+
# the *Amazon SQS Developer Guide*.
|
2103
2065
|
#
|
2104
2066
|
# * Every message must have a unique `MessageDeduplicationId`,
|
2105
2067
|
#
|
@@ -2148,12 +2110,12 @@ module Aws::SQS
|
|
2148
2110
|
# ``).
|
2149
2111
|
#
|
2150
2112
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
2151
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
2152
|
-
#
|
2113
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
2114
|
+
# Guide*.
|
2153
2115
|
#
|
2154
2116
|
#
|
2155
2117
|
#
|
2156
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
2118
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
2157
2119
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
2158
2120
|
# @return [String]
|
2159
2121
|
#
|
@@ -2182,8 +2144,7 @@ module Aws::SQS
|
|
2182
2144
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
2183
2145
|
#
|
2184
2146
|
# For best practices of using `MessageGroupId`, see [Using the
|
2185
|
-
# MessageGroupId Property][1] in the *Amazon
|
2186
|
-
# Developer Guide*.
|
2147
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2187
2148
|
#
|
2188
2149
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2189
2150
|
# Standard queues.
|
@@ -2242,7 +2203,7 @@ module Aws::SQS
|
|
2242
2203
|
# @!attribute [rw] message_id
|
2243
2204
|
# An attribute containing the `MessageId` of the message sent to the
|
2244
2205
|
# queue. For more information, see [Queue and Message Identifiers][1]
|
2245
|
-
# in the *Amazon
|
2206
|
+
# in the *Amazon SQS Developer Guide*.
|
2246
2207
|
#
|
2247
2208
|
#
|
2248
2209
|
#
|
@@ -2308,9 +2269,10 @@ module Aws::SQS
|
|
2308
2269
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2309
2270
|
# Default: 345,600 (4 days).
|
2310
2271
|
#
|
2311
|
-
# * `Policy` – The queue's policy. A valid
|
2312
|
-
# information about policy structure, see [Overview
|
2313
|
-
# Policies][1] in the *
|
2272
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2273
|
+
# policy. For more information about policy structure, see [Overview
|
2274
|
+
# of Amazon Web Services IAM Policies][1] in the *Identity and
|
2275
|
+
# Access Management User Guide*.
|
2314
2276
|
#
|
2315
2277
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2316
2278
|
# for which a ` ReceiveMessage ` action waits for a message to
|
@@ -2321,7 +2283,7 @@ module Aws::SQS
|
|
2321
2283
|
# dead-letter queue functionality of the source queue as a JSON
|
2322
2284
|
# object. For more information about the redrive policy and
|
2323
2285
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2324
|
-
# in the *Amazon
|
2286
|
+
# in the *Amazon SQS Developer Guide*.
|
2325
2287
|
#
|
2326
2288
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2327
2289
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2342,33 +2304,33 @@ module Aws::SQS
|
|
2342
2304
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2343
2305
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2344
2306
|
# Default: 30. For more information about the visibility timeout,
|
2345
|
-
# see [Visibility Timeout][3] in the *Amazon
|
2346
|
-
# Developer Guide*.
|
2307
|
+
# see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2347
2308
|
#
|
2348
2309
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2349
2310
|
#
|
2350
|
-
# * `KmsMasterKeyId` – The ID of an
|
2351
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
2352
|
-
# [Key Terms][5]. While the alias of the
|
2353
|
-
# SQS is always `alias/aws/sqs`, the
|
2354
|
-
# example, be `alias/MyAlias `. For
|
2355
|
-
# the *
|
2311
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
2312
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
2313
|
+
# information, see [Key Terms][5]. While the alias of the
|
2314
|
+
# AWS-managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
2315
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
2316
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
2317
|
+
# Reference*.
|
2356
2318
|
#
|
2357
2319
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
2358
2320
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
2359
|
-
# decrypt messages before calling
|
2360
|
-
#
|
2361
|
-
#
|
2362
|
-
#
|
2363
|
-
#
|
2364
|
-
#
|
2321
|
+
# decrypt messages before calling KMS again. An integer representing
|
2322
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
2323
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
2324
|
+
# better security but results in more calls to KMS which might incur
|
2325
|
+
# charges after Free Tier. For more information, see [How Does the
|
2326
|
+
# Data Key Reuse Period Work?][8].
|
2365
2327
|
#
|
2366
2328
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2367
2329
|
# queues][9]\:
|
2368
2330
|
#
|
2369
2331
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2370
|
-
# For more information, see [Exactly-
|
2371
|
-
# *Amazon
|
2332
|
+
# For more information, see [Exactly-once processing][10] in the
|
2333
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
2372
2334
|
#
|
2373
2335
|
# * Every message must have a unique `MessageDeduplicationId`.
|
2374
2336
|
#
|
@@ -2398,15 +2360,8 @@ module Aws::SQS
|
|
2398
2360
|
# `MessageDeduplicationId`, the two messages are treated as
|
2399
2361
|
# duplicates and only one copy of the message is delivered.
|
2400
2362
|
#
|
2401
|
-
#
|
2402
|
-
#
|
2403
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release
|
2404
|
-
# and is subject to change.** This feature provides a high number of
|
2405
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
2406
|
-
# information on throughput quotas, see [Quotas related to
|
2407
|
-
# messages][11] in the *Amazon Simple Queue Service Developer Guide*.
|
2408
|
-
#
|
2409
|
-
# This preview includes two new attributes:
|
2363
|
+
# The following attributes apply only to [high throughput for FIFO
|
2364
|
+
# queues][11]\:
|
2410
2365
|
#
|
2411
2366
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2412
2367
|
# occurs at the message group or queue level. Valid values are
|
@@ -2425,22 +2380,11 @@ module Aws::SQS
|
|
2425
2380
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
2426
2381
|
#
|
2427
2382
|
# If you set these attributes to anything other than the values shown
|
2428
|
-
# for enabling high throughput,
|
2383
|
+
# for enabling high throughput, normal throughput is in effect and
|
2429
2384
|
# deduplication occurs as specified.
|
2430
2385
|
#
|
2431
|
-
#
|
2432
|
-
#
|
2433
|
-
# * US East (Ohio); us-east-2
|
2434
|
-
#
|
2435
|
-
# * US East (N. Virginia); us-east-1
|
2436
|
-
#
|
2437
|
-
# * US West (Oregon); us-west-2
|
2438
|
-
#
|
2439
|
-
# * Europe (Ireland); eu-west-1
|
2440
|
-
#
|
2441
|
-
# For more information about high throughput for FIFO queues, see
|
2442
|
-
# [Preview: High throughput for FIFO queues][12] in the *Amazon Simple
|
2443
|
-
# Queue Service Developer Guide*.
|
2386
|
+
# For information on throughput quotas, see [Quotas related to
|
2387
|
+
# messages][12] in the *Amazon SQS Developer Guide*.
|
2444
2388
|
#
|
2445
2389
|
#
|
2446
2390
|
#
|
@@ -2453,9 +2397,9 @@ module Aws::SQS
|
|
2453
2397
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
2454
2398
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2455
2399
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2456
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
2457
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2458
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2400
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
2401
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2402
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2459
2403
|
# @return [Hash<String,String>]
|
2460
2404
|
#
|
2461
2405
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation
|