aws-sdk-sqs 1.45.0 → 1.48.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.
@@ -94,10 +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 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*.
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*.
101
101
  #
102
102
  #
103
103
  #
@@ -194,7 +194,7 @@ module Aws::SQS
194
194
  # @example Request syntax with placeholder values
195
195
  #
196
196
  # message = queue.receive_messages({
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
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
198
198
  # message_attribute_names: ["MessageAttributeName"],
199
199
  # max_number_of_messages: 1,
200
200
  # visibility_timeout: 1,
@@ -227,6 +227,10 @@ module Aws::SQS
227
227
  # * `SentTimestamp` – Returns the time the message was sent to the queue
228
228
  # ([epoch time][1] in milliseconds).
229
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
+ #
230
234
  # * `MessageDeduplicationId` – Returns the value provided by the
231
235
  # producer that calls the ` SendMessage ` action.
232
236
  #
@@ -239,6 +243,8 @@ module Aws::SQS
239
243
  #
240
244
  #
241
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
242
248
  # @option options [Array<String>] :message_attribute_names
243
249
  # The name of the message attribute, where *N* is the index.
244
250
  #
@@ -631,16 +637,11 @@ module Aws::SQS
631
637
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
632
638
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
633
639
  #
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
- #
641
640
  # * `RedrivePolicy` – The string that includes the parameters for the
642
641
  # dead-letter queue functionality of the source queue as a JSON
643
- # object. The parameters are as follows:
642
+ # object. For more information about the redrive policy and
643
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
644
+ # the *Amazon SQS Developer Guide*.
644
645
  #
645
646
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
646
647
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -651,38 +652,16 @@ module Aws::SQS
651
652
  # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
652
653
  # a queue, Amazon SQS moves the message to the dead-letter-queue.
653
654
  #
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:
658
- #
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:
662
- #
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.
655
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
656
+ # Similarly, the dead-letter queue of a standard queue must also be a
657
+ # standard queue.
669
658
  #
670
- # * `byQueue` – Only queues specified by the `sourceQueueArns`
671
- # parameter can specify this queue as the dead-letter queue.
659
+ # </note>
672
660
  #
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
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
662
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
663
+ # Default: 30. For more information about the visibility timeout, see
664
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
686
665
  #
687
666
  # The following attributes apply only to [server-side-encryption][4]\:
688
667
  #
@@ -702,11 +681,15 @@ module Aws::SQS
702
681
  # after Free Tier. For more information, see [How Does the Data Key
703
682
  # Reuse Period Work?][8].
704
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]).
687
+ #
705
688
  # The following attribute applies only to [FIFO (first-in-first-out)
706
- # queues][9]\:
689
+ # queues][11]\:
707
690
  #
708
691
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
709
- # For more information, see [Exactly-once processing][10] in the
692
+ # For more information, see [Exactly-once processing][12] in the
710
693
  # *Amazon SQS Developer Guide*. Note the following:
711
694
  #
712
695
  # * Every message must have a unique `MessageDeduplicationId`.
@@ -738,7 +721,7 @@ module Aws::SQS
738
721
  # duplicates and only one copy of the message is delivered.
739
722
  #
740
723
  # The following attributes apply only to [high throughput for FIFO
741
- # queues][11]\:
724
+ # queues][13]\:
742
725
  #
743
726
  # * `DeduplicationScope` – Specifies whether message deduplication
744
727
  # occurs at the message group or queue level. Valid values are
@@ -761,22 +744,24 @@ module Aws::SQS
761
744
  # deduplication occurs as specified.
762
745
  #
763
746
  # For information on throughput quotas, see [Quotas related to
764
- # messages][12] in the *Amazon SQS Developer Guide*.
747
+ # messages][14] in the *Amazon SQS Developer Guide*.
765
748
  #
766
749
  #
767
750
  #
768
751
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
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
752
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
753
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
771
754
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
772
755
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
773
756
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
774
757
  # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
775
758
  # [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
776
- # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
777
- # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
778
- # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
779
- # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
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
780
765
  # @return [EmptyStructure]
781
766
  def set_attributes(options = {})
782
767
  options = options.merge(queue_url: @url)
@@ -86,16 +86,11 @@ module Aws::SQS
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
- #
96
89
  # * `RedrivePolicy` – The string that includes the parameters for the
97
90
  # dead-letter queue functionality of the source queue as a JSON
98
- # object. The parameters are as follows:
91
+ # object. For more information about the redrive policy and
92
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
93
+ # the *Amazon SQS Developer Guide*.
99
94
  #
100
95
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
101
96
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -106,38 +101,16 @@ module Aws::SQS
106
101
  # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
107
102
  # a queue, Amazon SQS moves the message to the dead-letter-queue.
108
103
  #
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:
113
- #
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:
117
- #
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.
104
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
105
+ # Similarly, the dead-letter queue of a standard queue must also be a
106
+ # standard queue.
124
107
  #
125
- # * `byQueue` – Only queues specified by the `sourceQueueArns`
126
- # parameter can specify this queue as the dead-letter queue.
108
+ # </note>
127
109
  #
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>
110
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
111
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
112
+ # Default: 30. For more information about the visibility timeout, see
113
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
141
114
  #
142
115
  # The following attributes apply only to [server-side-encryption][4]\:
143
116
  #
@@ -158,8 +131,12 @@ module Aws::SQS
158
131
  # after Free Tier. For more information, see [How Does the Data Key
159
132
  # Reuse Period Work?][8].
160
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]).
137
+ #
161
138
  # The following attributes apply only to [FIFO (first-in-first-out)
162
- # queues][9]\:
139
+ # queues][11]\:
163
140
  #
164
141
  # * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
165
142
  # and `false`. If you don't specify the `FifoQueue` attribute, Amazon
@@ -168,12 +145,12 @@ module Aws::SQS
168
145
  # When you set this attribute, you must also provide the
169
146
  # `MessageGroupId` for your messages explicitly.
170
147
  #
171
- # For more information, see [FIFO queue logic][10] in the *Amazon SQS
148
+ # For more information, see [FIFO queue logic][12] in the *Amazon SQS
172
149
  # Developer Guide*.
173
150
  #
174
151
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
175
152
  # Valid values are `true` and `false`. For more information, see
176
- # [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
153
+ # [Exactly-once processing][13] in the *Amazon SQS Developer Guide*.
177
154
  # Note the following:
178
155
  #
179
156
  # * Every message must have a unique `MessageDeduplicationId`.
@@ -205,7 +182,7 @@ module Aws::SQS
205
182
  # duplicates and only one copy of the message is delivered.
206
183
  #
207
184
  # The following attributes apply only to [high throughput for FIFO
208
- # queues][12]\:
185
+ # queues][14]\:
209
186
  #
210
187
  # * `DeduplicationScope` – Specifies whether message deduplication
211
188
  # occurs at the message group or queue level. Valid values are
@@ -228,23 +205,25 @@ module Aws::SQS
228
205
  # deduplication occurs as specified.
229
206
  #
230
207
  # For information on throughput quotas, see [Quotas related to
231
- # messages][13] in the *Amazon SQS Developer Guide*.
208
+ # messages][15] in the *Amazon SQS Developer Guide*.
232
209
  #
233
210
  #
234
211
  #
235
212
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
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
213
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
214
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
238
215
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
239
216
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
240
217
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
241
218
  # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
242
219
  # [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
243
- # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
244
- # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
245
- # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
246
- # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
247
- # [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
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
248
227
  # @option options [Hash<String,String>] :tags
249
228
  # Add cost allocation tags to the specified Amazon SQS queue. For an
250
229
  # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
@@ -302,7 +281,8 @@ module Aws::SQS
302
281
  #
303
282
  # Queue URLs and names are case-sensitive.
304
283
  # @option options [String] :queue_owner_aws_account_id
305
- # The account ID of the account that created the queue.
284
+ # The Amazon Web Services account ID of the account that created the
285
+ # queue.
306
286
  # @return [Queue]
307
287
  def get_queue_by_name(options = {})
308
288
  resp = @client.get_queue_url(options)