aws-sdk-sqs 1.38.0 → 1.51.1
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 +71 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +195 -200
- data/lib/aws-sdk-sqs/message.rb +4 -3
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +17 -9
- data/lib/aws-sdk-sqs/queue.rb +61 -69
- data/lib/aws-sdk-sqs/resource.rb +46 -57
- data/lib/aws-sdk-sqs/types.rb +162 -189
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +6 -7
data/lib/aws-sdk-sqs/message.rb
CHANGED
@@ -43,7 +43,8 @@ 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 Amazon Web Services accounts for an extended period of
|
47
|
+
# time.
|
47
48
|
# @return [String]
|
48
49
|
def message_id
|
49
50
|
data[:message_id]
|
@@ -104,8 +105,8 @@ module Aws::SQS
|
|
104
105
|
end
|
105
106
|
|
106
107
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
107
|
-
# more information, see [Amazon SQS
|
108
|
-
# *Amazon
|
108
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
109
|
+
# *Amazon SQS Developer Guide*.
|
109
110
|
#
|
110
111
|
#
|
111
112
|
#
|
@@ -5,11 +5,10 @@ module Aws
|
|
5
5
|
module Plugins
|
6
6
|
# @api private
|
7
7
|
class QueueUrls < Seahorse::Client::Plugin
|
8
|
-
|
8
|
+
# Extract region from a provided queue_url
|
9
9
|
class Handler < Seahorse::Client::Handler
|
10
|
-
|
11
10
|
def call(context)
|
12
|
-
if queue_url = context.params[:queue_url]
|
11
|
+
if (queue_url = context.params[:queue_url])
|
13
12
|
update_endpoint(context, queue_url)
|
14
13
|
update_region(context, queue_url)
|
15
14
|
end
|
@@ -24,7 +23,7 @@ module Aws
|
|
24
23
|
# region, then we will modify the request to have
|
25
24
|
# a sigv4 signer for the proper region.
|
26
25
|
def update_region(context, queue_url)
|
27
|
-
if queue_region = parse_region(queue_url)
|
26
|
+
if (queue_region = parse_region(queue_url))
|
28
27
|
if queue_region != context.config.region
|
29
28
|
config = context.config.dup
|
30
29
|
config.region = queue_region
|
@@ -37,12 +36,21 @@ module Aws
|
|
37
36
|
|
38
37
|
private
|
39
38
|
|
40
|
-
# take the first component after service
|
41
|
-
#
|
42
|
-
#
|
39
|
+
# take the first component after the SQS service component
|
40
|
+
# Will return us-east-1 for:
|
41
|
+
# https://sqs.us-east-1.amazonaws.com/1234567890/demo
|
42
|
+
# https://vpce-x-y.sqs.us-east-1.vpce.amazonaws.com/1234567890/demo
|
43
|
+
# Will not return for:
|
44
|
+
# https://localstack-sqs.example.dev/queue/example
|
43
45
|
def parse_region(url)
|
44
|
-
parts = url.split('
|
45
|
-
parts
|
46
|
+
parts = URI.parse(url).host.split('.')
|
47
|
+
parts.each_with_index do |part, index|
|
48
|
+
if part == 'sqs'
|
49
|
+
# assume region is the part right after the 'sqs' part
|
50
|
+
return parts[index + 1]
|
51
|
+
end
|
52
|
+
end
|
53
|
+
nil # no region found
|
46
54
|
end
|
47
55
|
|
48
56
|
end
|
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 Amazon Web Services account numbers of the [principals][1] who are
|
98
|
+
# to receive permission. For information about locating the Amazon Web
|
99
|
+
# Services account identification, see [Your Amazon Web Services
|
100
|
+
# Identifiers][2] in the *Amazon SQS 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
|
@@ -195,7 +194,7 @@ module Aws::SQS
|
|
195
194
|
# @example Request syntax with placeholder values
|
196
195
|
#
|
197
196
|
# message = queue.receive_messages({
|
198
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
197
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
199
198
|
# message_attribute_names: ["MessageAttributeName"],
|
200
199
|
# max_number_of_messages: 1,
|
201
200
|
# visibility_timeout: 1,
|
@@ -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
|
#
|
@@ -228,6 +227,10 @@ module Aws::SQS
|
|
228
227
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
229
228
|
# ([epoch time][1] in milliseconds).
|
230
229
|
#
|
230
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
231
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
232
|
+
# supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
|
233
|
+
#
|
231
234
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
232
235
|
# producer that calls the ` SendMessage ` action.
|
233
236
|
#
|
@@ -240,6 +243,8 @@ module Aws::SQS
|
|
240
243
|
#
|
241
244
|
#
|
242
245
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
246
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
247
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
243
248
|
# @option options [Array<String>] :message_attribute_names
|
244
249
|
# The name of the message attribute, where *N* is the index.
|
245
250
|
#
|
@@ -314,7 +319,7 @@ module Aws::SQS
|
|
314
319
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
315
320
|
# handles. If a retry occurs within the deduplication interval, it
|
316
321
|
# resets the visibility timeout. For more information, see [Visibility
|
317
|
-
# Timeout][1] in the *Amazon
|
322
|
+
# Timeout][1] in the *Amazon SQS Developer Guide*.
|
318
323
|
#
|
319
324
|
# If a caller of the `ReceiveMessage` action still processes messages
|
320
325
|
# when the visibility timeout expires and messages become visible,
|
@@ -343,8 +348,8 @@ module Aws::SQS
|
|
343
348
|
# ``).
|
344
349
|
#
|
345
350
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
346
|
-
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
347
|
-
#
|
351
|
+
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
352
|
+
# Developer Guide*.
|
348
353
|
#
|
349
354
|
#
|
350
355
|
#
|
@@ -438,8 +443,8 @@ module Aws::SQS
|
|
438
443
|
# </note>
|
439
444
|
# @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
440
445
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
441
|
-
# more information, see [Amazon SQS
|
442
|
-
# *Amazon
|
446
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
447
|
+
# *Amazon SQS Developer Guide*.
|
443
448
|
#
|
444
449
|
#
|
445
450
|
#
|
@@ -450,7 +455,7 @@ module Aws::SQS
|
|
450
455
|
#
|
451
456
|
# * Currently, the only supported message system attribute is
|
452
457
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
453
|
-
# correctly formatted
|
458
|
+
# correctly formatted X-Ray trace header string.
|
454
459
|
#
|
455
460
|
# * The size of a message system attribute doesn't count towards the
|
456
461
|
# total size of a message.
|
@@ -461,8 +466,8 @@ module Aws::SQS
|
|
461
466
|
# particular `MessageDeduplicationId` is sent successfully, any messages
|
462
467
|
# sent with the same `MessageDeduplicationId` are accepted successfully
|
463
468
|
# but aren't delivered during the 5-minute deduplication interval. For
|
464
|
-
# more information, see [ Exactly-
|
465
|
-
#
|
469
|
+
# more information, see [ Exactly-once processing][1] in the *Amazon SQS
|
470
|
+
# Developer Guide*.
|
466
471
|
#
|
467
472
|
# * Every message must have a unique `MessageDeduplicationId`,
|
468
473
|
#
|
@@ -508,12 +513,12 @@ module Aws::SQS
|
|
508
513
|
# ``).
|
509
514
|
#
|
510
515
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
511
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
512
|
-
#
|
516
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
517
|
+
# Guide*.
|
513
518
|
#
|
514
519
|
#
|
515
520
|
#
|
516
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
521
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
517
522
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
518
523
|
# @option options [String] :message_group_id
|
519
524
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
@@ -539,8 +544,7 @@ module Aws::SQS
|
|
539
544
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
540
545
|
#
|
541
546
|
# For best practices of using `MessageGroupId`, see [Using the
|
542
|
-
# MessageGroupId Property][1] in the *Amazon
|
543
|
-
# Developer Guide*.
|
547
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
544
548
|
#
|
545
549
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
546
550
|
# Standard queues.
|
@@ -624,9 +628,10 @@ module Aws::SQS
|
|
624
628
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
625
629
|
# (4 days).
|
626
630
|
#
|
627
|
-
# * `Policy` – The queue's policy. A valid
|
628
|
-
# information about policy structure, see [Overview of
|
629
|
-
# Policies][1] in the *
|
631
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
632
|
+
# For more information about policy structure, see [Overview of Amazon
|
633
|
+
# Web Services IAM Policies][1] in the *Identity and Access Management
|
634
|
+
# User Guide*.
|
630
635
|
#
|
631
636
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
632
637
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -636,7 +641,7 @@ module Aws::SQS
|
|
636
641
|
# dead-letter queue functionality of the source queue as a JSON
|
637
642
|
# object. For more information about the redrive policy and
|
638
643
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
639
|
-
# the *Amazon
|
644
|
+
# the *Amazon SQS Developer Guide*.
|
640
645
|
#
|
641
646
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
642
647
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -656,33 +661,36 @@ module Aws::SQS
|
|
656
661
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
657
662
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
658
663
|
# Default: 30. For more information about the visibility timeout, see
|
659
|
-
# [Visibility Timeout][3] in the *Amazon
|
660
|
-
# Developer Guide*.
|
664
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
661
665
|
#
|
662
666
|
# The following attributes apply only to [server-side-encryption][4]\:
|
663
667
|
#
|
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*.
|
668
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
669
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
670
|
+
# information, see [Key Terms][5]. While the alias of the AWS-managed
|
671
|
+
# CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom
|
672
|
+
# CMK can, for example, be `alias/MyAlias `. For more examples, see
|
673
|
+
# [KeyId][6] in the *Key Management Service API Reference*.
|
670
674
|
#
|
671
675
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
672
676
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
673
|
-
# messages before calling
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
677
|
+
# messages before calling KMS again. An integer representing seconds,
|
678
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
679
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
680
|
+
# security but results in more calls to KMS which might incur charges
|
681
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
682
|
+
# Reuse Period Work?][8].
|
683
|
+
#
|
684
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
685
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
686
|
+
# supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
|
679
687
|
#
|
680
688
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
681
|
-
# queues][
|
689
|
+
# queues][11]\:
|
682
690
|
#
|
683
691
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
684
|
-
# For more information, see [Exactly-
|
685
|
-
# *Amazon
|
692
|
+
# For more information, see [Exactly-once processing][12] in the
|
693
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
686
694
|
#
|
687
695
|
# * Every message must have a unique `MessageDeduplicationId`.
|
688
696
|
#
|
@@ -712,15 +720,8 @@ module Aws::SQS
|
|
712
720
|
# `MessageDeduplicationId`, the two messages are treated as
|
713
721
|
# duplicates and only one copy of the message is delivered.
|
714
722
|
#
|
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:
|
723
|
+
# The following attributes apply only to [high throughput for FIFO
|
724
|
+
# queues][13]\:
|
724
725
|
#
|
725
726
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
726
727
|
# occurs at the message group or queue level. Valid values are
|
@@ -739,22 +740,11 @@ module Aws::SQS
|
|
739
740
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
740
741
|
#
|
741
742
|
# If you set these attributes to anything other than the values shown
|
742
|
-
# for enabling high throughput,
|
743
|
+
# for enabling high throughput, normal throughput is in effect and
|
743
744
|
# deduplication occurs as specified.
|
744
745
|
#
|
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*.
|
746
|
+
# For information on throughput quotas, see [Quotas related to
|
747
|
+
# messages][14] in the *Amazon SQS Developer Guide*.
|
758
748
|
#
|
759
749
|
#
|
760
750
|
#
|
@@ -766,10 +756,12 @@ module Aws::SQS
|
|
766
756
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
767
757
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
768
758
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
769
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
770
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
771
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
772
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
759
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
760
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
761
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
762
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
763
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
764
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
773
765
|
# @return [EmptyStructure]
|
774
766
|
def set_attributes(options = {})
|
775
767
|
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,29 +110,33 @@ 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
|
+
#
|
134
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
135
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
136
|
+
# supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
|
133
137
|
#
|
134
138
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
135
|
-
# queues][
|
139
|
+
# queues][11]\:
|
136
140
|
#
|
137
141
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
138
142
|
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
@@ -141,13 +145,13 @@ module Aws::SQS
|
|
141
145
|
# When you set this attribute, you must also provide the
|
142
146
|
# `MessageGroupId` for your messages explicitly.
|
143
147
|
#
|
144
|
-
# For more information, see [FIFO
|
145
|
-
#
|
148
|
+
# For more information, see [FIFO queue logic][12] in the *Amazon SQS
|
149
|
+
# Developer Guide*.
|
146
150
|
#
|
147
151
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
148
152
|
# Valid values are `true` and `false`. For more information, see
|
149
|
-
# [Exactly-
|
150
|
-
#
|
153
|
+
# [Exactly-once processing][13] in the *Amazon SQS Developer Guide*.
|
154
|
+
# Note the following:
|
151
155
|
#
|
152
156
|
# * Every message must have a unique `MessageDeduplicationId`.
|
153
157
|
#
|
@@ -177,15 +181,8 @@ module Aws::SQS
|
|
177
181
|
# `MessageDeduplicationId`, the two messages are treated as
|
178
182
|
# duplicates and only one copy of the message is delivered.
|
179
183
|
#
|
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:
|
184
|
+
# The following attributes apply only to [high throughput for FIFO
|
185
|
+
# queues][14]\:
|
189
186
|
#
|
190
187
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
191
188
|
# occurs at the message group or queue level. Valid values are
|
@@ -204,22 +201,11 @@ module Aws::SQS
|
|
204
201
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
205
202
|
#
|
206
203
|
# If you set these attributes to anything other than the values shown
|
207
|
-
# for enabling high throughput,
|
204
|
+
# for enabling high throughput, normal throughput is in effect and
|
208
205
|
# deduplication occurs as specified.
|
209
206
|
#
|
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*.
|
207
|
+
# For information on throughput quotas, see [Quotas related to
|
208
|
+
# messages][15] in the *Amazon SQS Developer Guide*.
|
223
209
|
#
|
224
210
|
#
|
225
211
|
#
|
@@ -231,15 +217,17 @@ module Aws::SQS
|
|
231
217
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
232
218
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
233
219
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
234
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
235
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
236
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
237
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
238
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
220
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
221
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
222
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
223
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
224
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
225
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
226
|
+
# [15]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
239
227
|
# @option options [Hash<String,String>] :tags
|
240
228
|
# 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
|
-
#
|
229
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
230
|
+
# Developer Guide*.
|
243
231
|
#
|
244
232
|
# When you use queue tags, keep the following guidelines in mind:
|
245
233
|
#
|
@@ -253,15 +241,15 @@ module Aws::SQS
|
|
253
241
|
# * A new tag with a key identical to that of an existing tag overwrites
|
254
242
|
# the existing tag.
|
255
243
|
#
|
256
|
-
# For a full list of tag restrictions, see [
|
257
|
-
# in the *Amazon
|
244
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
245
|
+
# in the *Amazon SQS Developer Guide*.
|
258
246
|
#
|
259
247
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
260
248
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
261
249
|
#
|
262
250
|
# Cross-account permissions don't apply to this action. For more
|
263
251
|
# information, see [Grant cross-account permissions to a role and a user
|
264
|
-
# name][3] in the *Amazon
|
252
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
265
253
|
#
|
266
254
|
# </note>
|
267
255
|
#
|
@@ -293,7 +281,8 @@ module Aws::SQS
|
|
293
281
|
#
|
294
282
|
# Queue URLs and names are case-sensitive.
|
295
283
|
# @option options [String] :queue_owner_aws_account_id
|
296
|
-
# The
|
284
|
+
# The Amazon Web Services account ID of the account that created the
|
285
|
+
# queue.
|
297
286
|
# @return [Queue]
|
298
287
|
def get_queue_by_name(options = {})
|
299
288
|
resp = @client.get_queue_url(options)
|