aws-sdk-sqs 1.39.0 → 1.43.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +226 -140
- data/lib/aws-sdk-sqs/message.rb +3 -3
- data/lib/aws-sdk-sqs/queue.rb +76 -51
- data/lib/aws-sdk-sqs/resource.rb +67 -40
- data/lib/aws-sdk-sqs/types.rb +212 -127
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
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
|
@@ -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
|
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
|
#
|
@@ -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-once processing][1] in the *Amazon
|
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,8 +507,8 @@ 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
|
#
|
@@ -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,19 +622,25 @@ 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.
|
633
632
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
634
633
|
#
|
634
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
635
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
636
|
+
# Default: 30. For more information about the visibility timeout, see
|
637
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
638
|
+
#
|
639
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
640
|
+
#
|
635
641
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
636
642
|
# dead-letter queue functionality of the source queue as a JSON
|
637
|
-
# object.
|
638
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
639
|
-
# the *Amazon Simple Queue Service Developer Guide*.
|
643
|
+
# object. The parameters are as follows:
|
640
644
|
#
|
641
645
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
642
646
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -647,42 +651,63 @@ module Aws::SQS
|
|
647
651
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
648
652
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
649
653
|
#
|
650
|
-
#
|
651
|
-
#
|
652
|
-
#
|
654
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
655
|
+
# the permissions for the dead-letter queue redrive permission and
|
656
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
657
|
+
# The parameters are as follows:
|
653
658
|
#
|
654
|
-
#
|
659
|
+
# * `redrivePermission` – The permission type that defines which
|
660
|
+
# source queues can specify the current queue as the dead-letter
|
661
|
+
# queue. Valid values are:
|
655
662
|
#
|
656
|
-
#
|
657
|
-
#
|
658
|
-
#
|
659
|
-
#
|
660
|
-
#
|
663
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
664
|
+
# Services account in the same Region can specify this queue as
|
665
|
+
# the dead-letter queue.
|
666
|
+
#
|
667
|
+
# * `denyAll` – No source queues can specify this queue as the
|
668
|
+
# dead-letter queue.
|
669
|
+
#
|
670
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
671
|
+
# parameter can specify this queue as the dead-letter queue.
|
672
|
+
#
|
673
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
674
|
+
# queues that can specify this queue as the dead-letter queue and
|
675
|
+
# redrive messages. You can specify this parameter only when the
|
676
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
677
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
678
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
679
|
+
# to `allowAll`.
|
680
|
+
#
|
681
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
682
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
683
|
+
# standard queue.
|
684
|
+
#
|
685
|
+
# </note>
|
661
686
|
#
|
662
687
|
# The following attributes apply only to [server-side-encryption][4]\:
|
663
688
|
#
|
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*.
|
689
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
690
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
691
|
+
# information, see [Key Terms][5]. While the alias of the AWS-managed
|
692
|
+
# CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom
|
693
|
+
# CMK can, for example, be `alias/MyAlias `. For more examples, see
|
694
|
+
# [KeyId][6] in the *Key Management Service API Reference*.
|
670
695
|
#
|
671
696
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
672
697
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
673
|
-
# messages before calling
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
678
|
-
#
|
698
|
+
# messages before calling KMS again. An integer representing seconds,
|
699
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
700
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
701
|
+
# security but results in more calls to KMS which might incur charges
|
702
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
703
|
+
# Reuse Period Work?][8].
|
679
704
|
#
|
680
705
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
681
706
|
# queues][9]\:
|
682
707
|
#
|
683
708
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
684
709
|
# For more information, see [Exactly-once processing][10] in the
|
685
|
-
# *Amazon
|
710
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
686
711
|
#
|
687
712
|
# * Every message must have a unique `MessageDeduplicationId`.
|
688
713
|
#
|
@@ -736,13 +761,13 @@ module Aws::SQS
|
|
736
761
|
# deduplication occurs as specified.
|
737
762
|
#
|
738
763
|
# For information on throughput quotas, see [Quotas related to
|
739
|
-
# messages][12] in the *Amazon
|
764
|
+
# messages][12] in the *Amazon SQS Developer Guide*.
|
740
765
|
#
|
741
766
|
#
|
742
767
|
#
|
743
768
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
744
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
745
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
769
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
770
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
746
771
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
747
772
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
748
773
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -78,19 +78,24 @@ 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.
|
87
87
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
88
88
|
#
|
89
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
90
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
91
|
+
# Default: 30. For more information about the visibility timeout, see
|
92
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
93
|
+
#
|
94
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
95
|
+
#
|
89
96
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
90
97
|
# dead-letter queue functionality of the source queue as a JSON
|
91
|
-
# object.
|
92
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
93
|
-
# the *Amazon Simple Queue Service Developer Guide*.
|
98
|
+
# object. The parameters are as follows:
|
94
99
|
#
|
95
100
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
96
101
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -101,35 +106,57 @@ module Aws::SQS
|
|
101
106
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
102
107
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
103
108
|
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
109
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
110
|
+
# the permissions for the dead-letter queue redrive permission and
|
111
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
112
|
+
# The parameters are as follows:
|
107
113
|
#
|
108
|
-
#
|
114
|
+
# * `redrivePermission` – The permission type that defines which
|
115
|
+
# source queues can specify the current queue as the dead-letter
|
116
|
+
# queue. Valid values are:
|
109
117
|
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
118
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
119
|
+
# Services account in the same Region can specify this queue as
|
120
|
+
# the dead-letter queue.
|
121
|
+
#
|
122
|
+
# * `denyAll` – No source queues can specify this queue as the
|
123
|
+
# dead-letter queue.
|
124
|
+
#
|
125
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
126
|
+
# parameter can specify this queue as the dead-letter queue.
|
127
|
+
#
|
128
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
129
|
+
# queues that can specify this queue as the dead-letter queue and
|
130
|
+
# redrive messages. You can specify this parameter only when the
|
131
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
132
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
133
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
134
|
+
# to `allowAll`.
|
135
|
+
#
|
136
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
137
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
138
|
+
# standard queue.
|
139
|
+
#
|
140
|
+
# </note>
|
115
141
|
#
|
116
142
|
# The following attributes apply only to [server-side-encryption][4]\:
|
117
143
|
#
|
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
|
144
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
145
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
146
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
147
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
148
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
149
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
150
|
+
# Reference*.
|
124
151
|
#
|
125
152
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
126
153
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
127
|
-
# messages before calling
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
154
|
+
# messages before calling KMS again. An integer representing seconds,
|
155
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
156
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
157
|
+
# security but results in more calls to KMS which might incur charges
|
158
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
159
|
+
# Reuse Period Work?][8].
|
133
160
|
#
|
134
161
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
135
162
|
# queues][9]\:
|
@@ -141,13 +168,13 @@ module Aws::SQS
|
|
141
168
|
# When you set this attribute, you must also provide the
|
142
169
|
# `MessageGroupId` for your messages explicitly.
|
143
170
|
#
|
144
|
-
# For more information, see [FIFO queue logic][10] in the *Amazon
|
145
|
-
#
|
171
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
172
|
+
# Developer Guide*.
|
146
173
|
#
|
147
174
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
148
175
|
# Valid values are `true` and `false`. For more information, see
|
149
|
-
# [Exactly-once processing][11] in the *Amazon
|
150
|
-
#
|
176
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
177
|
+
# Note the following:
|
151
178
|
#
|
152
179
|
# * Every message must have a unique `MessageDeduplicationId`.
|
153
180
|
#
|
@@ -201,13 +228,13 @@ module Aws::SQS
|
|
201
228
|
# deduplication occurs as specified.
|
202
229
|
#
|
203
230
|
# For information on throughput quotas, see [Quotas related to
|
204
|
-
# messages][13] in the *Amazon
|
231
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
205
232
|
#
|
206
233
|
#
|
207
234
|
#
|
208
235
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
209
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
210
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
236
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
237
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
211
238
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
212
239
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
213
240
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -220,8 +247,8 @@ module Aws::SQS
|
|
220
247
|
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
221
248
|
# @option options [Hash<String,String>] :tags
|
222
249
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
223
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
224
|
-
#
|
250
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
251
|
+
# Developer Guide*.
|
225
252
|
#
|
226
253
|
# When you use queue tags, keep the following guidelines in mind:
|
227
254
|
#
|
@@ -235,15 +262,15 @@ module Aws::SQS
|
|
235
262
|
# * A new tag with a key identical to that of an existing tag overwrites
|
236
263
|
# the existing tag.
|
237
264
|
#
|
238
|
-
# For a full list of tag restrictions, see [
|
239
|
-
# in the *Amazon
|
265
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
266
|
+
# in the *Amazon SQS Developer Guide*.
|
240
267
|
#
|
241
268
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
242
269
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
243
270
|
#
|
244
271
|
# Cross-account permissions don't apply to this action. For more
|
245
272
|
# information, see [Grant cross-account permissions to a role and a user
|
246
|
-
# name][3] in the *Amazon
|
273
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
247
274
|
#
|
248
275
|
# </note>
|
249
276
|
#
|
@@ -275,7 +302,7 @@ module Aws::SQS
|
|
275
302
|
#
|
276
303
|
# Queue URLs and names are case-sensitive.
|
277
304
|
# @option options [String] :queue_owner_aws_account_id
|
278
|
-
# The
|
305
|
+
# The account ID of the account that created the queue.
|
279
306
|
# @return [Queue]
|
280
307
|
def get_queue_by_name(options = {})
|
281
308
|
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,20 +326,26 @@ 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
|
336
336
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
337
337
|
# 0.
|
338
338
|
#
|
339
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
340
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
341
|
+
# Default: 30. For more information about the visibility timeout,
|
342
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
343
|
+
#
|
344
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
345
|
+
#
|
339
346
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
347
|
# dead-letter queue functionality of the source queue as a JSON
|
341
|
-
# object.
|
342
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
348
|
+
# object. The parameters are as follows:
|
344
349
|
#
|
345
350
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
346
351
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -352,35 +357,57 @@ module Aws::SQS
|
|
352
357
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
353
358
|
# the dead-letter-queue.
|
354
359
|
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
# a
|
360
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
361
|
+
# the permissions for the dead-letter queue redrive permission and
|
362
|
+
# which source queues can specify dead-letter queues as a JSON
|
363
|
+
# object. The parameters are as follows:
|
358
364
|
#
|
359
|
-
#
|
365
|
+
# * `redrivePermission` – The permission type that defines which
|
366
|
+
# source queues can specify the current queue as the dead-letter
|
367
|
+
# queue. Valid values are:
|
360
368
|
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
369
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
370
|
+
# Services account in the same Region can specify this queue as
|
371
|
+
# the dead-letter queue.
|
372
|
+
#
|
373
|
+
# * `denyAll` – No source queues can specify this queue as the
|
374
|
+
# dead-letter queue.
|
375
|
+
#
|
376
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
377
|
+
# parameter can specify this queue as the dead-letter queue.
|
378
|
+
#
|
379
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
380
|
+
# source queues that can specify this queue as the dead-letter
|
381
|
+
# queue and redrive messages. You can specify this parameter only
|
382
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
383
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
384
|
+
# source queues to specify dead-letter queues, set the
|
385
|
+
# `redrivePermission` parameter to `allowAll`.
|
386
|
+
#
|
387
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
388
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
389
|
+
# standard queue.
|
390
|
+
#
|
391
|
+
# </note>
|
366
392
|
#
|
367
393
|
# The following attributes apply only to [server-side-encryption][4]\:
|
368
394
|
#
|
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 *
|
395
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
396
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
397
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
398
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
399
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
400
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
401
|
+
# Reference*.
|
375
402
|
#
|
376
403
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
377
404
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
378
|
-
# decrypt messages before calling
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
405
|
+
# decrypt messages before calling KMS again. An integer representing
|
406
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
407
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
408
|
+
# better security but results in more calls to KMS which might incur
|
409
|
+
# charges after Free Tier. For more information, see [How Does the
|
410
|
+
# Data Key Reuse Period Work?][8].
|
384
411
|
#
|
385
412
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
386
413
|
# queues][9]\:
|
@@ -393,12 +420,12 @@ module Aws::SQS
|
|
393
420
|
# the `MessageGroupId` for your messages explicitly.
|
394
421
|
#
|
395
422
|
# For more information, see [FIFO queue logic][10] in the *Amazon
|
396
|
-
#
|
423
|
+
# SQS Developer Guide*.
|
397
424
|
#
|
398
425
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
399
426
|
# Valid values are `true` and `false`. For more information, see
|
400
|
-
# [Exactly-once processing][11] in the *Amazon
|
401
|
-
#
|
427
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
428
|
+
# Note the following:
|
402
429
|
#
|
403
430
|
# * Every message must have a unique `MessageDeduplicationId`.
|
404
431
|
#
|
@@ -452,13 +479,13 @@ module Aws::SQS
|
|
452
479
|
# deduplication occurs as specified.
|
453
480
|
#
|
454
481
|
# For information on throughput quotas, see [Quotas related to
|
455
|
-
# messages][13] in the *Amazon
|
482
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
456
483
|
#
|
457
484
|
#
|
458
485
|
#
|
459
486
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
460
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
461
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
487
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
488
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
462
489
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
463
490
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
464
491
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -473,8 +500,8 @@ module Aws::SQS
|
|
473
500
|
#
|
474
501
|
# @!attribute [rw] tags
|
475
502
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
476
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
477
|
-
#
|
503
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
504
|
+
# Developer Guide*.
|
478
505
|
#
|
479
506
|
# When you use queue tags, keep the following guidelines in mind:
|
480
507
|
#
|
@@ -488,15 +515,15 @@ module Aws::SQS
|
|
488
515
|
# * A new tag with a key identical to that of an existing tag
|
489
516
|
# overwrites the existing tag.
|
490
517
|
#
|
491
|
-
# For a full list of tag restrictions, see [
|
492
|
-
#
|
518
|
+
# For a full list of tag restrictions, see [Quotas related to
|
519
|
+
# queues][2] in the *Amazon SQS Developer Guide*.
|
493
520
|
#
|
494
521
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
495
522
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
496
523
|
#
|
497
524
|
# Cross-account permissions don't apply to this action. For more
|
498
525
|
# information, see [Grant cross-account permissions to a role and a
|
499
|
-
# user name][3] in the *Amazon
|
526
|
+
# user name][3] in the *Amazon SQS Developer Guide*.
|
500
527
|
#
|
501
528
|
# </note>
|
502
529
|
#
|
@@ -693,7 +720,7 @@ module Aws::SQS
|
|
693
720
|
#
|
694
721
|
# {
|
695
722
|
# queue_url: "String", # required
|
696
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
723
|
+
# 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
|
697
724
|
# }
|
698
725
|
#
|
699
726
|
# @!attribute [rw] queue_url
|
@@ -706,6 +733,10 @@ module Aws::SQS
|
|
706
733
|
# @!attribute [rw] attribute_names
|
707
734
|
# A list of attributes for which to retrieve information.
|
708
735
|
#
|
736
|
+
# The `AttributeName.N` parameter is optional, but if you don't
|
737
|
+
# specify values for this parameter, the request returns empty
|
738
|
+
# results.
|
739
|
+
#
|
709
740
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
710
741
|
# calls this action, we recommend that you structure your code so that
|
711
742
|
# it can handle new attributes gracefully.
|
@@ -761,11 +792,15 @@ module Aws::SQS
|
|
761
792
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
762
793
|
# to arrive.
|
763
794
|
#
|
795
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
796
|
+
# queue. For more information about the visibility timeout, see
|
797
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
798
|
+
#
|
799
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
800
|
+
#
|
764
801
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
765
802
|
# dead-letter queue functionality of the source queue as a JSON
|
766
|
-
# object.
|
767
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
768
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
803
|
+
# object. The parameters are as follows:
|
769
804
|
#
|
770
805
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
771
806
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -777,28 +812,56 @@ module Aws::SQS
|
|
777
812
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
778
813
|
# the dead-letter-queue.
|
779
814
|
#
|
780
|
-
# * `
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
815
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
816
|
+
# the permissions for the dead-letter queue redrive permission and
|
817
|
+
# which source queues can specify dead-letter queues as a JSON
|
818
|
+
# object. The parameters are as follows:
|
819
|
+
#
|
820
|
+
# * `redrivePermission` – The permission type that defines which
|
821
|
+
# source queues can specify the current queue as the dead-letter
|
822
|
+
# queue. Valid values are:
|
823
|
+
#
|
824
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
825
|
+
# Services account in the same Region can specify this queue as
|
826
|
+
# the dead-letter queue.
|
827
|
+
#
|
828
|
+
# * `denyAll` – No source queues can specify this queue as the
|
829
|
+
# dead-letter queue.
|
830
|
+
#
|
831
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
832
|
+
# parameter can specify this queue as the dead-letter queue.
|
833
|
+
#
|
834
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
835
|
+
# source queues that can specify this queue as the dead-letter
|
836
|
+
# queue and redrive messages. You can specify this parameter only
|
837
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
838
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
839
|
+
# source queues to specify dead-letter queues, set the
|
840
|
+
# `redrivePermission` parameter to `allowAll`.
|
841
|
+
#
|
842
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
843
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
844
|
+
# standard queue.
|
845
|
+
#
|
846
|
+
# </note>
|
784
847
|
#
|
785
848
|
# The following attributes apply only to [server-side-encryption][4]\:
|
786
849
|
#
|
787
|
-
# * `KmsMasterKeyId` – Returns the ID of an
|
788
|
-
# master key (CMK) for Amazon SQS or a custom CMK.
|
789
|
-
# information, see [Key Terms][5].
|
850
|
+
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
|
851
|
+
# managed customer master key (CMK) for Amazon SQS or a custom CMK.
|
852
|
+
# For more information, see [Key Terms][5].
|
790
853
|
#
|
791
854
|
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
792
855
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
793
|
-
# decrypt messages before calling
|
794
|
-
#
|
856
|
+
# decrypt messages before calling KMS again. For more information,
|
857
|
+
# see [How Does the Data Key Reuse Period Work?][6].
|
795
858
|
#
|
796
859
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
797
860
|
# queues][7]\:
|
798
861
|
#
|
799
862
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
800
|
-
# For more information, see [FIFO queue logic][8] in the *Amazon
|
801
|
-
#
|
863
|
+
# For more information, see [FIFO queue logic][8] in the *Amazon SQS
|
864
|
+
# Developer Guide*.
|
802
865
|
#
|
803
866
|
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
804
867
|
# `QueueName` ends with the `.fifo` suffix.
|
@@ -807,8 +870,7 @@ module Aws::SQS
|
|
807
870
|
#
|
808
871
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
809
872
|
# deduplication is enabled for the queue. For more information, see
|
810
|
-
# [Exactly-once processing][9] in the *Amazon
|
811
|
-
# Developer Guide*.
|
873
|
+
# [Exactly-once processing][9] in the *Amazon SQS Developer Guide*.
|
812
874
|
#
|
813
875
|
# The following attributes apply only to [high throughput for FIFO
|
814
876
|
# queues][10]\:
|
@@ -834,13 +896,13 @@ module Aws::SQS
|
|
834
896
|
# deduplication occurs as specified.
|
835
897
|
#
|
836
898
|
# For information on throughput quotas, see [Quotas related to
|
837
|
-
# messages][11] in the *Amazon
|
899
|
+
# messages][11] in the *Amazon SQS Developer Guide*.
|
838
900
|
#
|
839
901
|
#
|
840
902
|
#
|
841
903
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
842
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
843
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
904
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
905
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
844
906
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
845
907
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
846
908
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -891,7 +953,7 @@ module Aws::SQS
|
|
891
953
|
# @return [String]
|
892
954
|
#
|
893
955
|
# @!attribute [rw] queue_owner_aws_account_id
|
894
|
-
# The
|
956
|
+
# The account ID of the account that created the queue.
|
895
957
|
# @return [String]
|
896
958
|
#
|
897
959
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
|
@@ -904,7 +966,7 @@ module Aws::SQS
|
|
904
966
|
end
|
905
967
|
|
906
968
|
# For more information, see [Interpreting Responses][1] in the *Amazon
|
907
|
-
#
|
969
|
+
# SQS Developer Guide*.
|
908
970
|
#
|
909
971
|
#
|
910
972
|
#
|
@@ -1097,7 +1159,7 @@ module Aws::SQS
|
|
1097
1159
|
#
|
1098
1160
|
# @!attribute [rw] message_id
|
1099
1161
|
# A unique identifier for the message. A `MessageId`is considered
|
1100
|
-
# unique across all
|
1162
|
+
# unique across all accounts for an extended period of time.
|
1101
1163
|
# @return [String]
|
1102
1164
|
#
|
1103
1165
|
# @!attribute [rw] receipt_handle
|
@@ -1156,8 +1218,8 @@ module Aws::SQS
|
|
1156
1218
|
#
|
1157
1219
|
# @!attribute [rw] message_attributes
|
1158
1220
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
1159
|
-
# For more information, see [Amazon SQS
|
1160
|
-
# *Amazon
|
1221
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
1222
|
+
# *Amazon SQS Developer Guide*.
|
1161
1223
|
#
|
1162
1224
|
#
|
1163
1225
|
#
|
@@ -1226,8 +1288,7 @@ module Aws::SQS
|
|
1226
1288
|
# `StringValue`.
|
1227
1289
|
#
|
1228
1290
|
# You can also append custom labels. For more information, see [Amazon
|
1229
|
-
# SQS Message Attributes][1] in the *Amazon
|
1230
|
-
# Developer Guide*.
|
1291
|
+
# SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
|
1231
1292
|
#
|
1232
1293
|
#
|
1233
1294
|
#
|
@@ -1298,8 +1359,7 @@ module Aws::SQS
|
|
1298
1359
|
# `StringValue`.
|
1299
1360
|
#
|
1300
1361
|
# You can also append custom labels. For more information, see [Amazon
|
1301
|
-
# SQS Message Attributes][1] in the *Amazon
|
1302
|
-
# Developer Guide*.
|
1362
|
+
# SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
|
1303
1363
|
#
|
1304
1364
|
#
|
1305
1365
|
#
|
@@ -1389,7 +1449,7 @@ module Aws::SQS
|
|
1389
1449
|
#
|
1390
1450
|
# {
|
1391
1451
|
# queue_url: "String", # required
|
1392
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
1452
|
+
# 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
|
1393
1453
|
# message_attribute_names: ["MessageAttributeName"],
|
1394
1454
|
# max_number_of_messages: 1,
|
1395
1455
|
# visibility_timeout: 1,
|
@@ -1416,7 +1476,7 @@ module Aws::SQS
|
|
1416
1476
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1417
1477
|
# has been received across all queues but not deleted.
|
1418
1478
|
#
|
1419
|
-
# * `AWSTraceHeader` – Returns the
|
1479
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1420
1480
|
#
|
1421
1481
|
# * `SenderId`
|
1422
1482
|
#
|
@@ -1526,8 +1586,7 @@ module Aws::SQS
|
|
1526
1586
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
1527
1587
|
# handles. If a retry occurs within the deduplication interval, it
|
1528
1588
|
# resets the visibility timeout. For more information, see
|
1529
|
-
# [Visibility Timeout][1] in the *Amazon
|
1530
|
-
# Developer Guide*.
|
1589
|
+
# [Visibility Timeout][1] in the *Amazon SQS Developer Guide*.
|
1531
1590
|
#
|
1532
1591
|
# If a caller of the `ReceiveMessage` action still processes
|
1533
1592
|
# messages when the visibility timeout expires and messages become
|
@@ -1558,8 +1617,8 @@ module Aws::SQS
|
|
1558
1617
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
1559
1618
|
#
|
1560
1619
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using
|
1561
|
-
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
1562
|
-
#
|
1620
|
+
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
1621
|
+
# Developer Guide*.
|
1563
1622
|
#
|
1564
1623
|
#
|
1565
1624
|
#
|
@@ -1740,8 +1799,8 @@ module Aws::SQS
|
|
1740
1799
|
#
|
1741
1800
|
# @!attribute [rw] message_attributes
|
1742
1801
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
1743
|
-
# For more information, see [Amazon SQS
|
1744
|
-
# *Amazon
|
1802
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
1803
|
+
# *Amazon SQS Developer Guide*.
|
1745
1804
|
#
|
1746
1805
|
#
|
1747
1806
|
#
|
@@ -1754,7 +1813,7 @@ module Aws::SQS
|
|
1754
1813
|
#
|
1755
1814
|
# * Currently, the only supported message system attribute is
|
1756
1815
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1757
|
-
# a correctly formatted
|
1816
|
+
# a correctly formatted X-Ray trace header string.
|
1758
1817
|
#
|
1759
1818
|
# * The size of a message system attribute doesn't count towards the
|
1760
1819
|
# total size of a message.
|
@@ -1768,7 +1827,7 @@ module Aws::SQS
|
|
1768
1827
|
# `MessageDeduplicationId` is sent successfully, subsequent messages
|
1769
1828
|
# with the same `MessageDeduplicationId` are accepted successfully but
|
1770
1829
|
# aren't delivered. For more information, see [ Exactly-once
|
1771
|
-
# processing][1] in the *Amazon
|
1830
|
+
# processing][1] in the *Amazon SQS Developer Guide*.
|
1772
1831
|
#
|
1773
1832
|
# * Every message must have a unique `MessageDeduplicationId`,
|
1774
1833
|
#
|
@@ -1817,8 +1876,8 @@ module Aws::SQS
|
|
1817
1876
|
# ``).
|
1818
1877
|
#
|
1819
1878
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
1820
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
1821
|
-
#
|
1879
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
1880
|
+
# Guide*.
|
1822
1881
|
#
|
1823
1882
|
#
|
1824
1883
|
#
|
@@ -1851,8 +1910,7 @@ module Aws::SQS
|
|
1851
1910
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1852
1911
|
#
|
1853
1912
|
# For best practices of using `MessageGroupId`, see [Using the
|
1854
|
-
# MessageGroupId Property][1] in the *Amazon
|
1855
|
-
# Developer Guide*.
|
1913
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
1856
1914
|
#
|
1857
1915
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
1858
1916
|
# Standard queues.
|
@@ -2035,8 +2093,8 @@ module Aws::SQS
|
|
2035
2093
|
#
|
2036
2094
|
# @!attribute [rw] message_attributes
|
2037
2095
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
2038
|
-
# For more information, see [Amazon SQS
|
2039
|
-
# *Amazon
|
2096
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
2097
|
+
# *Amazon SQS Developer Guide*.
|
2040
2098
|
#
|
2041
2099
|
#
|
2042
2100
|
#
|
@@ -2049,7 +2107,7 @@ module Aws::SQS
|
|
2049
2107
|
#
|
2050
2108
|
# * Currently, the only supported message system attribute is
|
2051
2109
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
2052
|
-
# a correctly formatted
|
2110
|
+
# a correctly formatted X-Ray trace header string.
|
2053
2111
|
#
|
2054
2112
|
# * The size of a message system attribute doesn't count towards the
|
2055
2113
|
# total size of a message.
|
@@ -2063,7 +2121,7 @@ module Aws::SQS
|
|
2063
2121
|
# messages sent with the same `MessageDeduplicationId` are accepted
|
2064
2122
|
# successfully but aren't delivered during the 5-minute deduplication
|
2065
2123
|
# interval. For more information, see [ Exactly-once processing][1] in
|
2066
|
-
# the *Amazon
|
2124
|
+
# the *Amazon SQS Developer Guide*.
|
2067
2125
|
#
|
2068
2126
|
# * Every message must have a unique `MessageDeduplicationId`,
|
2069
2127
|
#
|
@@ -2112,8 +2170,8 @@ module Aws::SQS
|
|
2112
2170
|
# ``).
|
2113
2171
|
#
|
2114
2172
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
2115
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
2116
|
-
#
|
2173
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
2174
|
+
# Guide*.
|
2117
2175
|
#
|
2118
2176
|
#
|
2119
2177
|
#
|
@@ -2146,8 +2204,7 @@ module Aws::SQS
|
|
2146
2204
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
2147
2205
|
#
|
2148
2206
|
# For best practices of using `MessageGroupId`, see [Using the
|
2149
|
-
# MessageGroupId Property][1] in the *Amazon
|
2150
|
-
# Developer Guide*.
|
2207
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2151
2208
|
#
|
2152
2209
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2153
2210
|
# Standard queues.
|
@@ -2206,7 +2263,7 @@ module Aws::SQS
|
|
2206
2263
|
# @!attribute [rw] message_id
|
2207
2264
|
# An attribute containing the `MessageId` of the message sent to the
|
2208
2265
|
# queue. For more information, see [Queue and Message Identifiers][1]
|
2209
|
-
# in the *Amazon
|
2266
|
+
# in the *Amazon SQS Developer Guide*.
|
2210
2267
|
#
|
2211
2268
|
#
|
2212
2269
|
#
|
@@ -2272,20 +2329,26 @@ module Aws::SQS
|
|
2272
2329
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2273
2330
|
# Default: 345,600 (4 days).
|
2274
2331
|
#
|
2275
|
-
# * `Policy` – The queue's policy. A valid
|
2276
|
-
# information about policy structure, see [Overview
|
2277
|
-
# Policies][1] in the *
|
2332
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2333
|
+
# policy. For more information about policy structure, see [Overview
|
2334
|
+
# of Amazon Web Services IAM Policies][1] in the *Identity and
|
2335
|
+
# Access Management User Guide*.
|
2278
2336
|
#
|
2279
2337
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2280
2338
|
# for which a ` ReceiveMessage ` action waits for a message to
|
2281
2339
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2282
2340
|
# 0.
|
2283
2341
|
#
|
2342
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2343
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2344
|
+
# Default: 30. For more information about the visibility timeout,
|
2345
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2346
|
+
#
|
2347
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2348
|
+
#
|
2284
2349
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2285
2350
|
# dead-letter queue functionality of the source queue as a JSON
|
2286
|
-
# object.
|
2287
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2288
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
2351
|
+
# object. The parameters are as follows:
|
2289
2352
|
#
|
2290
2353
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2291
2354
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2297,42 +2360,64 @@ module Aws::SQS
|
|
2297
2360
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2298
2361
|
# the dead-letter-queue.
|
2299
2362
|
#
|
2300
|
-
#
|
2301
|
-
#
|
2302
|
-
# a
|
2363
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2364
|
+
# the permissions for the dead-letter queue redrive permission and
|
2365
|
+
# which source queues can specify dead-letter queues as a JSON
|
2366
|
+
# object. The parameters are as follows:
|
2303
2367
|
#
|
2304
|
-
#
|
2368
|
+
# * `redrivePermission` – The permission type that defines which
|
2369
|
+
# source queues can specify the current queue as the dead-letter
|
2370
|
+
# queue. Valid values are:
|
2305
2371
|
#
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
#
|
2309
|
-
#
|
2310
|
-
#
|
2372
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2373
|
+
# Services account in the same Region can specify this queue as
|
2374
|
+
# the dead-letter queue.
|
2375
|
+
#
|
2376
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2377
|
+
# dead-letter queue.
|
2378
|
+
#
|
2379
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2380
|
+
# parameter can specify this queue as the dead-letter queue.
|
2381
|
+
#
|
2382
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2383
|
+
# source queues that can specify this queue as the dead-letter
|
2384
|
+
# queue and redrive messages. You can specify this parameter only
|
2385
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2386
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
2387
|
+
# source queues to specify dead-letter queues, set the
|
2388
|
+
# `redrivePermission` parameter to `allowAll`.
|
2389
|
+
#
|
2390
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2391
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2392
|
+
# standard queue.
|
2393
|
+
#
|
2394
|
+
# </note>
|
2311
2395
|
#
|
2312
2396
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2313
2397
|
#
|
2314
|
-
# * `KmsMasterKeyId` – The ID of an
|
2315
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
2316
|
-
# [Key Terms][5]. While the alias of the
|
2317
|
-
# SQS is always `alias/aws/sqs`, the
|
2318
|
-
# example, be `alias/MyAlias `. For
|
2319
|
-
# the *
|
2398
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
2399
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
2400
|
+
# information, see [Key Terms][5]. While the alias of the
|
2401
|
+
# AWS-managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
2402
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
2403
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
2404
|
+
# Reference*.
|
2320
2405
|
#
|
2321
2406
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
2322
2407
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
2323
|
-
# decrypt messages before calling
|
2324
|
-
#
|
2325
|
-
#
|
2326
|
-
#
|
2327
|
-
#
|
2328
|
-
#
|
2408
|
+
# decrypt messages before calling KMS again. An integer representing
|
2409
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
2410
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
2411
|
+
# better security but results in more calls to KMS which might incur
|
2412
|
+
# charges after Free Tier. For more information, see [How Does the
|
2413
|
+
# Data Key Reuse Period Work?][8].
|
2329
2414
|
#
|
2330
2415
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2331
2416
|
# queues][9]\:
|
2332
2417
|
#
|
2333
2418
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2334
2419
|
# For more information, see [Exactly-once processing][10] in the
|
2335
|
-
# *Amazon
|
2420
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
2336
2421
|
#
|
2337
2422
|
# * Every message must have a unique `MessageDeduplicationId`.
|
2338
2423
|
#
|
@@ -2386,13 +2471,13 @@ module Aws::SQS
|
|
2386
2471
|
# deduplication occurs as specified.
|
2387
2472
|
#
|
2388
2473
|
# For information on throughput quotas, see [Quotas related to
|
2389
|
-
# messages][12] in the *Amazon
|
2474
|
+
# messages][12] in the *Amazon SQS Developer Guide*.
|
2390
2475
|
#
|
2391
2476
|
#
|
2392
2477
|
#
|
2393
2478
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2394
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2395
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2479
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2480
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2396
2481
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2397
2482
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2398
2483
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|