aws-sdk-sqs 1.54.0 → 1.56.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -76,75 +76,41 @@ module Aws::SQS
76
76
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
77
77
  # Amazon SQS retains a message. Valid values: An integer from 60
78
78
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
79
- # (4 days). When you change a queue's attributes, the change can take
80
- # up to 60 seconds for most of the attributes to propagate throughout
81
- # the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
82
- # attribute can take up to 15 minutes and will impact existing
83
- # messages in the queue potentially causing them to be expired and
84
- # deleted if the `MessageRetentionPeriod` is reduced below the age of
85
- # existing messages.
79
+ # (4 days).
86
80
  #
87
81
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
88
82
  # For more information about policy structure, see [Overview of Amazon
89
- # Web Services IAM Policies][1] in the *IAM User Guide*.
83
+ # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
90
84
  #
91
85
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
92
86
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
93
87
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
94
88
  #
95
- # * `VisibilityTimeout` – The visibility timeout for the queue, in
96
- # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
97
- # Default: 30. For more information about the visibility timeout, see
98
- # [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
99
- #
100
- # The following attributes apply only to [dead-letter queues:][3]
101
- #
102
89
  # * `RedrivePolicy` – The string that includes the parameters for the
103
90
  # dead-letter queue functionality of the source queue as a JSON
104
- # 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*.
105
94
  #
106
95
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
107
96
  # dead-letter queue to which Amazon SQS moves messages after the
108
97
  # value of `maxReceiveCount` is exceeded.
109
98
  #
110
99
  # * `maxReceiveCount` – The number of times a message is delivered to
111
- # the source queue before being moved to the dead-letter queue.
112
- # Default: 10. When the `ReceiveCount` for a message exceeds the
113
- # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
114
- # dead-letter-queue.
115
- #
116
- # * `RedriveAllowPolicy` – The string that includes the parameters for
117
- # the permissions for the dead-letter queue redrive permission and
118
- # which source queues can specify dead-letter queues as a JSON object.
119
- # The parameters are as follows:
120
- #
121
- # * `redrivePermission` – The permission type that defines which
122
- # source queues can specify the current queue as the dead-letter
123
- # queue. Valid values are:
124
- #
125
- # * `allowAll` – (Default) Any source queues in this Amazon Web
126
- # Services account in the same Region can specify this queue as
127
- # the dead-letter queue.
128
- #
129
- # * `denyAll` – No source queues can specify this queue as the
130
- # dead-letter queue.
131
- #
132
- # * `byQueue` – Only queues specified by the `sourceQueueArns`
133
- # parameter can specify this queue as the dead-letter queue.
134
- #
135
- # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
136
- # queues that can specify this queue as the dead-letter queue and
137
- # redrive messages. You can specify this parameter only when the
138
- # `redrivePermission` parameter is set to `byQueue`. You can specify
139
- # up to 10 source queue ARNs. To allow more than 10 source queues to
140
- # specify dead-letter queues, set the `redrivePermission` parameter
141
- # to `allowAll`.
142
- #
143
- # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
144
- # Similarly, the dead-letter queue of a standard queue must also be a
145
- # standard queue.
100
+ # the source queue before being moved to the dead-letter queue. When
101
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
102
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
146
103
  #
147
- # </note>
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.
107
+ #
108
+ # </note>
109
+ #
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*.
148
114
  #
149
115
  # The following attributes apply only to [server-side-encryption][4]:
150
116
  #
@@ -163,11 +129,11 @@ module Aws::SQS
163
129
  # Default: 300 (5 minutes). A shorter time period provides better
164
130
  # security but results in more calls to KMS which might incur charges
165
131
  # after Free Tier. For more information, see [How Does the Data Key
166
- # Reuse Period Work?][8]
132
+ # Reuse Period Work?][8].
167
133
  #
168
134
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
169
135
  # SQS owned encryption keys. Only one server-side encryption option is
170
- # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
136
+ # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
171
137
  #
172
138
  # The following attributes apply only to [FIFO (first-in-first-out)
173
139
  # queues][11]:
@@ -244,8 +210,8 @@ module Aws::SQS
244
210
  #
245
211
  #
246
212
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
247
- # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
248
- # [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
249
215
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
250
216
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
251
217
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -282,8 +248,8 @@ module Aws::SQS
282
248
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
283
249
  #
284
250
  # Cross-account permissions don't apply to this action. For more
285
- # information, see [Grant cross-account permissions to a role and a
286
- # username][3] in the *Amazon SQS Developer Guide*.
251
+ # information, see [Grant cross-account permissions to a role and a user
252
+ # name][3] in the *Amazon SQS Developer Guide*.
287
253
  #
288
254
  # </note>
289
255
  #
@@ -294,7 +260,9 @@ module Aws::SQS
294
260
  # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
295
261
  # @return [Queue]
296
262
  def create_queue(options = {})
297
- resp = @client.create_queue(options)
263
+ resp = Aws::Plugins::UserAgent.feature('resource') do
264
+ @client.create_queue(options)
265
+ end
298
266
  Queue.new(
299
267
  url: resp.data.queue_url,
300
268
  client: @client
@@ -319,7 +287,9 @@ module Aws::SQS
319
287
  # queue.
320
288
  # @return [Queue]
321
289
  def get_queue_by_name(options = {})
322
- resp = @client.get_queue_url(options)
290
+ resp = Aws::Plugins::UserAgent.feature('resource') do
291
+ @client.get_queue_url(options)
292
+ end
323
293
  Queue.new(
324
294
  url: resp.data.queue_url,
325
295
  client: @client
@@ -351,7 +321,9 @@ module Aws::SQS
351
321
  # @return [Queue::Collection]
352
322
  def queues(options = {})
353
323
  batches = Enumerator.new do |y|
354
- resp = @client.list_queues(options)
324
+ resp = Aws::Plugins::UserAgent.feature('resource') do
325
+ @client.list_queues(options)
326
+ end
355
327
  resp.each_page do |page|
356
328
  batch = []
357
329
  page.data.queue_urls.each do |q|