aws-sdk-sqs 1.27.1 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +283 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-sqs.rb +6 -3
- data/lib/aws-sdk-sqs/client.rb +361 -146
- data/lib/aws-sdk-sqs/client_api.rb +23 -1
- data/lib/aws-sdk-sqs/customizations.rb +2 -0
- data/lib/aws-sdk-sqs/errors.rb +3 -1
- data/lib/aws-sdk-sqs/message.rb +5 -3
- data/lib/aws-sdk-sqs/plugins/md5s.rb +2 -0
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +2 -0
- data/lib/aws-sdk-sqs/queue.rb +109 -47
- data/lib/aws-sdk-sqs/queue_poller.rb +3 -1
- data/lib/aws-sdk-sqs/resource.rb +85 -35
- data/lib/aws-sdk-sqs/types.rb +371 -120
- metadata +10 -7
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
require 'set'
|
2
4
|
|
3
5
|
module Aws
|
@@ -288,7 +290,7 @@ module Aws
|
|
288
290
|
# @option options [Integer] :visibility_timeout (nil)
|
289
291
|
# The number of seconds you have to process a message before
|
290
292
|
# it is put back into the queue and can be received again.
|
291
|
-
# By default, the queue's
|
293
|
+
# By default, the queue's visibility timeout is not set.
|
292
294
|
#
|
293
295
|
# @option options [Array<String>] :attribute_names ([])
|
294
296
|
# The list of attributes that need to be returned along with each
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -1,7 +1,9 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
4
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
@@ -62,39 +64,39 @@ module Aws::SQS
|
|
62
64
|
# The following lists the names, descriptions, and values of the special
|
63
65
|
# request parameters that the `CreateQueue` action uses:
|
64
66
|
#
|
65
|
-
# * `DelaySeconds`
|
67
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
66
68
|
# delivery of all messages in the queue is delayed. Valid values: An
|
67
69
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
68
70
|
#
|
69
|
-
# * `MaximumMessageSize`
|
71
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
70
72
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
71
73
|
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
|
72
74
|
# (256 KiB).
|
73
75
|
#
|
74
|
-
# * `MessageRetentionPeriod`
|
76
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
75
77
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
76
78
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
77
79
|
# (4 days).
|
78
80
|
#
|
79
|
-
# * `Policy`
|
81
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
80
82
|
# information about policy structure, see [Overview of AWS IAM
|
81
83
|
# Policies][1] in the *Amazon IAM User Guide*.
|
82
84
|
#
|
83
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
85
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
84
86
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
85
87
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
86
88
|
#
|
87
|
-
# * `RedrivePolicy`
|
88
|
-
# dead-letter queue functionality of the source queue
|
89
|
-
# information about the redrive policy and
|
90
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
91
|
-
# Service Developer Guide*.
|
89
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
90
|
+
# dead-letter queue functionality of the source queue as a JSON
|
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 Simple Queue Service Developer Guide*.
|
92
94
|
#
|
93
|
-
# * `deadLetterTargetArn`
|
95
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
94
96
|
# dead-letter queue to which Amazon SQS moves messages after the
|
95
97
|
# value of `maxReceiveCount` is exceeded.
|
96
98
|
#
|
97
|
-
# * `maxReceiveCount`
|
99
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
98
100
|
# the source queue before being moved to the dead-letter queue. When
|
99
101
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
100
102
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -105,7 +107,7 @@ module Aws::SQS
|
|
105
107
|
#
|
106
108
|
# </note>
|
107
109
|
#
|
108
|
-
# * `VisibilityTimeout`
|
110
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
109
111
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
110
112
|
# Default: 30. For more information about the visibility timeout, see
|
111
113
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -113,14 +115,14 @@ module Aws::SQS
|
|
113
115
|
#
|
114
116
|
# The following attributes apply only to [server-side-encryption][4]\:
|
115
117
|
#
|
116
|
-
# * `KmsMasterKeyId`
|
118
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
117
119
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
118
120
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
119
121
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
120
122
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
121
123
|
# Key Management Service API Reference*.
|
122
124
|
#
|
123
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
125
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
124
126
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
125
127
|
# messages before calling AWS KMS again. An integer representing
|
126
128
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -132,22 +134,22 @@ module Aws::SQS
|
|
132
134
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
133
135
|
# queues][9]\:
|
134
136
|
#
|
135
|
-
# * `FifoQueue`
|
136
|
-
# `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
137
|
-
# creates a standard queue. You can provide this attribute only
|
138
|
-
# queue creation. You can't change it for an existing queue.
|
139
|
-
# set this attribute, you must also provide the
|
140
|
-
# your messages explicitly.
|
137
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
138
|
+
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
139
|
+
# SQS creates a standard queue. You can provide this attribute only
|
140
|
+
# during queue creation. You can't change it for an existing queue.
|
141
|
+
# When you set this attribute, you must also provide the
|
142
|
+
# `MessageGroupId` for your messages explicitly.
|
141
143
|
#
|
142
144
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
143
145
|
# Simple Queue Service Developer Guide*.
|
144
146
|
#
|
145
|
-
# * `ContentBasedDeduplication`
|
146
|
-
# Valid values
|
147
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
148
|
+
# Valid values are `true` and `false`. For more information, see
|
147
149
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
148
|
-
# Developer Guide*.
|
150
|
+
# Developer Guide*. Note the following:
|
149
151
|
#
|
150
|
-
# * Every message must have a unique `MessageDeduplicationId
|
152
|
+
# * Every message must have a unique `MessageDeduplicationId`.
|
151
153
|
#
|
152
154
|
# * You may provide a `MessageDeduplicationId` explicitly.
|
153
155
|
#
|
@@ -175,6 +177,50 @@ module Aws::SQS
|
|
175
177
|
# `MessageDeduplicationId`, the two messages are treated as
|
176
178
|
# duplicates and only one copy of the message is delivered.
|
177
179
|
#
|
180
|
+
# **Preview: High throughput for FIFO queues**
|
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:
|
189
|
+
#
|
190
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
191
|
+
# occurs at the message group or queue level. Valid values are
|
192
|
+
# `messageGroup` and `queue`.
|
193
|
+
#
|
194
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue throughput
|
195
|
+
# quota applies to the entire queue or per message group. Valid values
|
196
|
+
# are `perQueue` and `perMessageGroupId`. The `perMessageGroupId`
|
197
|
+
# value is allowed only when the value for `DeduplicationScope` is
|
198
|
+
# `messageGroup`.
|
199
|
+
#
|
200
|
+
# To enable high throughput for FIFO queues, do the following:
|
201
|
+
#
|
202
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
203
|
+
#
|
204
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
205
|
+
#
|
206
|
+
# If you set these attributes to anything other than the values shown
|
207
|
+
# for enabling high throughput, standard throughput is in effect and
|
208
|
+
# deduplication occurs as specified.
|
209
|
+
#
|
210
|
+
# This preview is available in the following AWS Regions:
|
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*.
|
223
|
+
#
|
178
224
|
#
|
179
225
|
#
|
180
226
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -188,6 +234,8 @@ module Aws::SQS
|
|
188
234
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
189
235
|
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
190
236
|
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
237
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
238
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
191
239
|
# @option options [Hash<String,String>] :tags
|
192
240
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
193
241
|
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
@@ -212,8 +260,8 @@ module Aws::SQS
|
|
212
260
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
213
261
|
#
|
214
262
|
# Cross-account permissions don't apply to this action. For more
|
215
|
-
# information, see [Grant
|
216
|
-
#
|
263
|
+
# information, see [Grant cross-account permissions to a role and a user
|
264
|
+
# name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
217
265
|
#
|
218
266
|
# </note>
|
219
267
|
#
|
@@ -280,15 +328,17 @@ module Aws::SQS
|
|
280
328
|
# @return [Queue::Collection]
|
281
329
|
def queues(options = {})
|
282
330
|
batches = Enumerator.new do |y|
|
283
|
-
batch = []
|
284
331
|
resp = @client.list_queues(options)
|
285
|
-
resp.
|
286
|
-
batch
|
287
|
-
|
288
|
-
|
289
|
-
|
332
|
+
resp.each_page do |page|
|
333
|
+
batch = []
|
334
|
+
page.data.queue_urls.each do |q|
|
335
|
+
batch << Queue.new(
|
336
|
+
url: q,
|
337
|
+
client: @client
|
338
|
+
)
|
339
|
+
end
|
340
|
+
y.yield(batch)
|
290
341
|
end
|
291
|
-
y.yield(batch)
|
292
342
|
end
|
293
343
|
Queue::Collection.new(batches)
|
294
344
|
end
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -1,7 +1,9 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
4
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
@@ -70,6 +72,7 @@ module Aws::SQS
|
|
70
72
|
:label,
|
71
73
|
:aws_account_ids,
|
72
74
|
:actions)
|
75
|
+
SENSITIVE = []
|
73
76
|
include Aws::Structure
|
74
77
|
end
|
75
78
|
|
@@ -93,7 +96,8 @@ module Aws::SQS
|
|
93
96
|
# @return [String]
|
94
97
|
#
|
95
98
|
# @!attribute [rw] sender_fault
|
96
|
-
# Specifies whether the error happened due to the
|
99
|
+
# Specifies whether the error happened due to the caller of the batch
|
100
|
+
# API action.
|
97
101
|
# @return [Boolean]
|
98
102
|
#
|
99
103
|
# @!attribute [rw] code
|
@@ -111,6 +115,7 @@ module Aws::SQS
|
|
111
115
|
:sender_fault,
|
112
116
|
:code,
|
113
117
|
:message)
|
118
|
+
SENSITIVE = []
|
114
119
|
include Aws::Structure
|
115
120
|
end
|
116
121
|
|
@@ -145,6 +150,7 @@ module Aws::SQS
|
|
145
150
|
class ChangeMessageVisibilityBatchRequest < Struct.new(
|
146
151
|
:queue_url,
|
147
152
|
:entries)
|
153
|
+
SENSITIVE = []
|
148
154
|
include Aws::Structure
|
149
155
|
end
|
150
156
|
|
@@ -175,7 +181,11 @@ module Aws::SQS
|
|
175
181
|
# An identifier for this particular receipt handle used to communicate
|
176
182
|
# the result.
|
177
183
|
#
|
178
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
184
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
185
|
+
#
|
186
|
+
# This identifier can have up to 80 characters. The following
|
187
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
188
|
+
# underscores (\_).
|
179
189
|
#
|
180
190
|
# </note>
|
181
191
|
# @return [String]
|
@@ -194,6 +204,7 @@ module Aws::SQS
|
|
194
204
|
:id,
|
195
205
|
:receipt_handle,
|
196
206
|
:visibility_timeout)
|
207
|
+
SENSITIVE = []
|
197
208
|
include Aws::Structure
|
198
209
|
end
|
199
210
|
|
@@ -214,6 +225,7 @@ module Aws::SQS
|
|
214
225
|
class ChangeMessageVisibilityBatchResult < Struct.new(
|
215
226
|
:successful,
|
216
227
|
:failed)
|
228
|
+
SENSITIVE = []
|
217
229
|
include Aws::Structure
|
218
230
|
end
|
219
231
|
|
@@ -228,6 +240,7 @@ module Aws::SQS
|
|
228
240
|
#
|
229
241
|
class ChangeMessageVisibilityBatchResultEntry < Struct.new(
|
230
242
|
:id)
|
243
|
+
SENSITIVE = []
|
231
244
|
include Aws::Structure
|
232
245
|
end
|
233
246
|
|
@@ -255,7 +268,7 @@ module Aws::SQS
|
|
255
268
|
#
|
256
269
|
# @!attribute [rw] visibility_timeout
|
257
270
|
# The new value for the message's visibility timeout (in seconds).
|
258
|
-
# Values
|
271
|
+
# Values range: `0` to `43200`. Maximum: 12 hours.
|
259
272
|
# @return [Integer]
|
260
273
|
#
|
261
274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityRequest AWS API Documentation
|
@@ -264,6 +277,7 @@ module Aws::SQS
|
|
264
277
|
:queue_url,
|
265
278
|
:receipt_handle,
|
266
279
|
:visibility_timeout)
|
280
|
+
SENSITIVE = []
|
267
281
|
include Aws::Structure
|
268
282
|
end
|
269
283
|
|
@@ -299,40 +313,40 @@ module Aws::SQS
|
|
299
313
|
# The following lists the names, descriptions, and values of the
|
300
314
|
# special request parameters that the `CreateQueue` action uses:
|
301
315
|
#
|
302
|
-
# * `DelaySeconds`
|
316
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
303
317
|
# delivery of all messages in the queue is delayed. Valid values: An
|
304
318
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
305
319
|
#
|
306
|
-
# * `MaximumMessageSize`
|
320
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
307
321
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
308
322
|
# from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
|
309
323
|
# 262,144 (256 KiB).
|
310
324
|
#
|
311
|
-
# * `MessageRetentionPeriod`
|
325
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
312
326
|
# which Amazon SQS retains a message. Valid values: An integer from
|
313
327
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
314
328
|
# 345,600 (4 days).
|
315
329
|
#
|
316
|
-
# * `Policy`
|
330
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
317
331
|
# information about policy structure, see [Overview of AWS IAM
|
318
332
|
# Policies][1] in the *Amazon IAM User Guide*.
|
319
333
|
#
|
320
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
334
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
321
335
|
# for which a ` ReceiveMessage ` action waits for a message to
|
322
336
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
323
337
|
# 0.
|
324
338
|
#
|
325
|
-
# * `RedrivePolicy`
|
326
|
-
# dead-letter queue functionality of the source queue
|
327
|
-
# information about the redrive policy and
|
328
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
329
|
-
# Queue Service Developer Guide*.
|
339
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
|
+
# dead-letter queue functionality of the source queue as a JSON
|
341
|
+
# object. For more information about the redrive policy and
|
342
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
330
344
|
#
|
331
|
-
# * `deadLetterTargetArn`
|
345
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
332
346
|
# dead-letter queue to which Amazon SQS moves messages after the
|
333
347
|
# value of `maxReceiveCount` is exceeded.
|
334
348
|
#
|
335
|
-
# * `maxReceiveCount`
|
349
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
336
350
|
# to the source queue before being moved to the dead-letter queue.
|
337
351
|
# When the `ReceiveCount` for a message exceeds the
|
338
352
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -344,7 +358,7 @@ module Aws::SQS
|
|
344
358
|
#
|
345
359
|
# </note>
|
346
360
|
#
|
347
|
-
# * `VisibilityTimeout`
|
361
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
348
362
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
349
363
|
# Default: 30. For more information about the visibility timeout,
|
350
364
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -352,14 +366,14 @@ module Aws::SQS
|
|
352
366
|
#
|
353
367
|
# The following attributes apply only to [server-side-encryption][4]\:
|
354
368
|
#
|
355
|
-
# * `KmsMasterKeyId`
|
369
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
356
370
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
357
371
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
358
372
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
359
373
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
360
374
|
# the *AWS Key Management Service API Reference*.
|
361
375
|
#
|
362
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
376
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
363
377
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
364
378
|
# decrypt messages before calling AWS KMS again. An integer
|
365
379
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -371,22 +385,22 @@ module Aws::SQS
|
|
371
385
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
372
386
|
# queues][9]\:
|
373
387
|
#
|
374
|
-
# * `FifoQueue`
|
375
|
-
# `false`. If you don't specify the `FifoQueue` attribute,
|
376
|
-
# SQS creates a standard queue. You can provide this
|
377
|
-
# during queue creation. You can't change it for an
|
378
|
-
# When you set this attribute, you must also provide
|
379
|
-
# `MessageGroupId` for your messages explicitly.
|
388
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
389
|
+
# and `false`. If you don't specify the `FifoQueue` attribute,
|
390
|
+
# Amazon SQS creates a standard queue. You can provide this
|
391
|
+
# attribute only during queue creation. You can't change it for an
|
392
|
+
# existing queue. When you set this attribute, you must also provide
|
393
|
+
# the `MessageGroupId` for your messages explicitly.
|
380
394
|
#
|
381
395
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
382
396
|
# Simple Queue Service Developer Guide*.
|
383
397
|
#
|
384
|
-
# * `ContentBasedDeduplication`
|
385
|
-
# Valid values
|
398
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
399
|
+
# Valid values are `true` and `false`. For more information, see
|
386
400
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
387
|
-
# Developer Guide*.
|
401
|
+
# Developer Guide*. Note the following:
|
388
402
|
#
|
389
|
-
# * Every message must have a unique `MessageDeduplicationId
|
403
|
+
# * Every message must have a unique `MessageDeduplicationId`.
|
390
404
|
#
|
391
405
|
# * You may provide a `MessageDeduplicationId` explicitly.
|
392
406
|
#
|
@@ -414,6 +428,50 @@ module Aws::SQS
|
|
414
428
|
# `MessageDeduplicationId`, the two messages are treated as
|
415
429
|
# duplicates and only one copy of the message is delivered.
|
416
430
|
#
|
431
|
+
# **Preview: High throughput for FIFO queues**
|
432
|
+
#
|
433
|
+
# **High throughput for Amazon SQS FIFO queues is in preview release
|
434
|
+
# and is subject to change.** This feature provides a high number of
|
435
|
+
# transactions per second (TPS) for messages in FIFO queues. For
|
436
|
+
# information on throughput quotas, see [Quotas related to
|
437
|
+
# messages][12] in the *Amazon Simple Queue Service Developer Guide*.
|
438
|
+
#
|
439
|
+
# This preview includes two new attributes:
|
440
|
+
#
|
441
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
442
|
+
# occurs at the message group or queue level. Valid values are
|
443
|
+
# `messageGroup` and `queue`.
|
444
|
+
#
|
445
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue
|
446
|
+
# throughput quota applies to the entire queue or per message group.
|
447
|
+
# Valid values are `perQueue` and `perMessageGroupId`. The
|
448
|
+
# `perMessageGroupId` value is allowed only when the value for
|
449
|
+
# `DeduplicationScope` is `messageGroup`.
|
450
|
+
#
|
451
|
+
# To enable high throughput for FIFO queues, do the following:
|
452
|
+
#
|
453
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
454
|
+
#
|
455
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
456
|
+
#
|
457
|
+
# If you set these attributes to anything other than the values shown
|
458
|
+
# for enabling high throughput, standard throughput is in effect and
|
459
|
+
# deduplication occurs as specified.
|
460
|
+
#
|
461
|
+
# This preview is available in the following AWS Regions:
|
462
|
+
#
|
463
|
+
# * US East (Ohio); us-east-2
|
464
|
+
#
|
465
|
+
# * US East (N. Virginia); us-east-1
|
466
|
+
#
|
467
|
+
# * US West (Oregon); us-west-2
|
468
|
+
#
|
469
|
+
# * Europe (Ireland); eu-west-1
|
470
|
+
#
|
471
|
+
# For more information about high throughput for FIFO queues, see
|
472
|
+
# [Preview: High throughput for FIFO queues][13] in the *Amazon Simple
|
473
|
+
# Queue Service Developer Guide*.
|
474
|
+
#
|
417
475
|
#
|
418
476
|
#
|
419
477
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -427,6 +485,8 @@ module Aws::SQS
|
|
427
485
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
428
486
|
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
429
487
|
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
488
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
489
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
430
490
|
# @return [Hash<String,String>]
|
431
491
|
#
|
432
492
|
# @!attribute [rw] tags
|
@@ -453,8 +513,8 @@ module Aws::SQS
|
|
453
513
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
454
514
|
#
|
455
515
|
# Cross-account permissions don't apply to this action. For more
|
456
|
-
# information, see [Grant
|
457
|
-
#
|
516
|
+
# information, see [Grant cross-account permissions to a role and a
|
517
|
+
# user name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
458
518
|
#
|
459
519
|
# </note>
|
460
520
|
#
|
@@ -471,6 +531,7 @@ module Aws::SQS
|
|
471
531
|
:queue_name,
|
472
532
|
:attributes,
|
473
533
|
:tags)
|
534
|
+
SENSITIVE = []
|
474
535
|
include Aws::Structure
|
475
536
|
end
|
476
537
|
|
@@ -484,6 +545,7 @@ module Aws::SQS
|
|
484
545
|
#
|
485
546
|
class CreateQueueResult < Struct.new(
|
486
547
|
:queue_url)
|
548
|
+
SENSITIVE = []
|
487
549
|
include Aws::Structure
|
488
550
|
end
|
489
551
|
|
@@ -515,6 +577,7 @@ module Aws::SQS
|
|
515
577
|
class DeleteMessageBatchRequest < Struct.new(
|
516
578
|
:queue_url,
|
517
579
|
:entries)
|
580
|
+
SENSITIVE = []
|
518
581
|
include Aws::Structure
|
519
582
|
end
|
520
583
|
|
@@ -532,7 +595,11 @@ module Aws::SQS
|
|
532
595
|
# An identifier for this particular receipt handle. This is used to
|
533
596
|
# communicate the result.
|
534
597
|
#
|
535
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
598
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
599
|
+
#
|
600
|
+
# This identifier can have up to 80 characters. The following
|
601
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
602
|
+
# underscores (\_).
|
536
603
|
#
|
537
604
|
# </note>
|
538
605
|
# @return [String]
|
@@ -546,6 +613,7 @@ module Aws::SQS
|
|
546
613
|
class DeleteMessageBatchRequestEntry < Struct.new(
|
547
614
|
:id,
|
548
615
|
:receipt_handle)
|
616
|
+
SENSITIVE = []
|
549
617
|
include Aws::Structure
|
550
618
|
end
|
551
619
|
|
@@ -566,6 +634,7 @@ module Aws::SQS
|
|
566
634
|
class DeleteMessageBatchResult < Struct.new(
|
567
635
|
:successful,
|
568
636
|
:failed)
|
637
|
+
SENSITIVE = []
|
569
638
|
include Aws::Structure
|
570
639
|
end
|
571
640
|
|
@@ -579,6 +648,7 @@ module Aws::SQS
|
|
579
648
|
#
|
580
649
|
class DeleteMessageBatchResultEntry < Struct.new(
|
581
650
|
:id)
|
651
|
+
SENSITIVE = []
|
582
652
|
include Aws::Structure
|
583
653
|
end
|
584
654
|
|
@@ -605,6 +675,7 @@ module Aws::SQS
|
|
605
675
|
class DeleteMessageRequest < Struct.new(
|
606
676
|
:queue_url,
|
607
677
|
:receipt_handle)
|
678
|
+
SENSITIVE = []
|
608
679
|
include Aws::Structure
|
609
680
|
end
|
610
681
|
|
@@ -625,6 +696,7 @@ module Aws::SQS
|
|
625
696
|
#
|
626
697
|
class DeleteQueueRequest < Struct.new(
|
627
698
|
:queue_url)
|
699
|
+
SENSITIVE = []
|
628
700
|
include Aws::Structure
|
629
701
|
end
|
630
702
|
|
@@ -639,7 +711,7 @@ module Aws::SQS
|
|
639
711
|
#
|
640
712
|
# {
|
641
713
|
# queue_url: "String", # required
|
642
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
714
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
643
715
|
# }
|
644
716
|
#
|
645
717
|
# @!attribute [rw] queue_url
|
@@ -660,74 +732,81 @@ module Aws::SQS
|
|
660
732
|
#
|
661
733
|
# The following attributes are supported:
|
662
734
|
#
|
663
|
-
#
|
735
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
736
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
737
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
738
|
+
# consistency until at least 1 minute after the producers stop sending
|
739
|
+
# messages. This period is required for the queue metadata to reach
|
740
|
+
# eventual consistency.
|
664
741
|
#
|
665
|
-
# * `
|
742
|
+
# * `All` – Returns all values.
|
743
|
+
#
|
744
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
666
745
|
# messages available for retrieval from the queue.
|
667
746
|
#
|
668
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
747
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
669
748
|
# number of messages in the queue that are delayed and not available
|
670
749
|
# for reading immediately. This can happen when the queue is
|
671
750
|
# configured as a delay queue or when a message has been sent with a
|
672
751
|
# delay parameter.
|
673
752
|
#
|
674
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
753
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
675
754
|
# number of messages that are in flight. Messages are considered to
|
676
755
|
# be *in flight* if they have been sent to a client but have not yet
|
677
756
|
# been deleted or have not yet reached the end of their visibility
|
678
757
|
# window.
|
679
758
|
#
|
680
|
-
# * `CreatedTimestamp`
|
759
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created
|
681
760
|
# in seconds ([epoch time][1]).
|
682
761
|
#
|
683
|
-
# * `DelaySeconds`
|
762
|
+
# * `DelaySeconds` – Returns the default delay on the queue in
|
684
763
|
# seconds.
|
685
764
|
#
|
686
|
-
# * `LastModifiedTimestamp`
|
765
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
687
766
|
# changed in seconds ([epoch time][1]).
|
688
767
|
#
|
689
|
-
# * `MaximumMessageSize`
|
768
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a
|
690
769
|
# message can contain before Amazon SQS rejects it.
|
691
770
|
#
|
692
|
-
# * `MessageRetentionPeriod`
|
771
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
693
772
|
# for which Amazon SQS retains a message.
|
694
773
|
#
|
695
|
-
# * `Policy`
|
774
|
+
# * `Policy` – Returns the policy of the queue.
|
696
775
|
#
|
697
|
-
# * `QueueArn`
|
776
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
698
777
|
#
|
699
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
778
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
700
779
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
701
780
|
# to arrive.
|
702
781
|
#
|
703
|
-
# * `RedrivePolicy`
|
704
|
-
#
|
705
|
-
# information about the redrive policy and
|
706
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
707
|
-
# Queue Service Developer Guide*.
|
782
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
783
|
+
# dead-letter queue functionality of the source queue as a JSON
|
784
|
+
# object. For more information about the redrive policy and
|
785
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
786
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
708
787
|
#
|
709
|
-
# * `deadLetterTargetArn`
|
788
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
710
789
|
# dead-letter queue to which Amazon SQS moves messages after the
|
711
790
|
# value of `maxReceiveCount` is exceeded.
|
712
791
|
#
|
713
|
-
# * `maxReceiveCount`
|
792
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
714
793
|
# to the source queue before being moved to the dead-letter queue.
|
715
794
|
# When the `ReceiveCount` for a message exceeds the
|
716
795
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
717
796
|
# the dead-letter-queue.
|
718
797
|
#
|
719
|
-
# * `VisibilityTimeout`
|
798
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
720
799
|
# queue. For more information about the visibility timeout, see
|
721
800
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
722
801
|
# Developer Guide*.
|
723
802
|
#
|
724
803
|
# The following attributes apply only to [server-side-encryption][4]\:
|
725
804
|
#
|
726
|
-
# * `KmsMasterKeyId`
|
805
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer
|
727
806
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
728
807
|
# information, see [Key Terms][5].
|
729
808
|
#
|
730
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
809
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
731
810
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
732
811
|
# decrypt messages before calling AWS KMS again. For more
|
733
812
|
# information, see [How Does the Data Key Reuse Period Work?][6].
|
@@ -735,20 +814,64 @@ module Aws::SQS
|
|
735
814
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
736
815
|
# queues][7]\:
|
737
816
|
#
|
738
|
-
# * `FifoQueue`
|
739
|
-
# information, see [FIFO Queue Logic][8] in the *Amazon
|
740
|
-
# Service Developer Guide*.
|
817
|
+
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
818
|
+
# For more information, see [FIFO Queue Logic][8] in the *Amazon
|
819
|
+
# Simple Queue Service Developer Guide*.
|
741
820
|
#
|
742
821
|
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
743
822
|
# `QueueName` ends with the `.fifo` suffix.
|
744
823
|
#
|
745
824
|
# </note>
|
746
825
|
#
|
747
|
-
# * `ContentBasedDeduplication`
|
826
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
748
827
|
# deduplication is enabled for the queue. For more information, see
|
749
828
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
750
829
|
# Developer Guide*.
|
751
830
|
#
|
831
|
+
# **Preview: High throughput for FIFO queues**
|
832
|
+
#
|
833
|
+
# **High throughput for Amazon SQS FIFO queues is in preview release
|
834
|
+
# and is subject to change.** This feature provides a high number of
|
835
|
+
# transactions per second (TPS) for messages in FIFO queues. For
|
836
|
+
# information on throughput quotas, see [Quotas related to
|
837
|
+
# messages][10] in the *Amazon Simple Queue Service Developer Guide*.
|
838
|
+
#
|
839
|
+
# This preview includes two new attributes:
|
840
|
+
#
|
841
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
842
|
+
# occurs at the message group or queue level. Valid values are
|
843
|
+
# `messageGroup` and `queue`.
|
844
|
+
#
|
845
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue
|
846
|
+
# throughput quota applies to the entire queue or per message group.
|
847
|
+
# Valid values are `perQueue` and `perMessageGroupId`. The
|
848
|
+
# `perMessageGroupId` value is allowed only when the value for
|
849
|
+
# `DeduplicationScope` is `messageGroup`.
|
850
|
+
#
|
851
|
+
# To enable high throughput for FIFO queues, do the following:
|
852
|
+
#
|
853
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
854
|
+
#
|
855
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
856
|
+
#
|
857
|
+
# If you set these attributes to anything other than the values shown
|
858
|
+
# for enabling high throughput, standard throughput is in effect and
|
859
|
+
# deduplication occurs as specified.
|
860
|
+
#
|
861
|
+
# This preview is available in the following AWS Regions:
|
862
|
+
#
|
863
|
+
# * US East (Ohio); us-east-2
|
864
|
+
#
|
865
|
+
# * US East (N. Virginia); us-east-1
|
866
|
+
#
|
867
|
+
# * US West (Oregon); us-west-2
|
868
|
+
#
|
869
|
+
# * Europe (Ireland); eu-west-1
|
870
|
+
#
|
871
|
+
# For more information about high throughput for FIFO queues, see
|
872
|
+
# [Preview: High throughput for FIFO queues][11] in the *Amazon Simple
|
873
|
+
# Queue Service Developer Guide*.
|
874
|
+
#
|
752
875
|
#
|
753
876
|
#
|
754
877
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
@@ -760,6 +883,8 @@ module Aws::SQS
|
|
760
883
|
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
761
884
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
762
885
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
886
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
887
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
763
888
|
# @return [Array<String>]
|
764
889
|
#
|
765
890
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -767,6 +892,7 @@ module Aws::SQS
|
|
767
892
|
class GetQueueAttributesRequest < Struct.new(
|
768
893
|
:queue_url,
|
769
894
|
:attribute_names)
|
895
|
+
SENSITIVE = []
|
770
896
|
include Aws::Structure
|
771
897
|
end
|
772
898
|
|
@@ -780,6 +906,7 @@ module Aws::SQS
|
|
780
906
|
#
|
781
907
|
class GetQueueAttributesResult < Struct.new(
|
782
908
|
:attributes)
|
909
|
+
SENSITIVE = []
|
783
910
|
include Aws::Structure
|
784
911
|
end
|
785
912
|
|
@@ -808,6 +935,7 @@ module Aws::SQS
|
|
808
935
|
class GetQueueUrlRequest < Struct.new(
|
809
936
|
:queue_name,
|
810
937
|
:queue_owner_aws_account_id)
|
938
|
+
SENSITIVE = []
|
811
939
|
include Aws::Structure
|
812
940
|
end
|
813
941
|
|
@@ -826,6 +954,7 @@ module Aws::SQS
|
|
826
954
|
#
|
827
955
|
class GetQueueUrlResult < Struct.new(
|
828
956
|
:queue_url)
|
957
|
+
SENSITIVE = []
|
829
958
|
include Aws::Structure
|
830
959
|
end
|
831
960
|
|
@@ -859,6 +988,8 @@ module Aws::SQS
|
|
859
988
|
#
|
860
989
|
# {
|
861
990
|
# queue_url: "String", # required
|
991
|
+
# next_token: "Token",
|
992
|
+
# max_results: 1,
|
862
993
|
# }
|
863
994
|
#
|
864
995
|
# @!attribute [rw] queue_url
|
@@ -867,10 +998,23 @@ module Aws::SQS
|
|
867
998
|
# Queue URLs and names are case-sensitive.
|
868
999
|
# @return [String]
|
869
1000
|
#
|
1001
|
+
# @!attribute [rw] next_token
|
1002
|
+
# Pagination token to request the next set of results.
|
1003
|
+
# @return [String]
|
1004
|
+
#
|
1005
|
+
# @!attribute [rw] max_results
|
1006
|
+
# Maximum number of results to include in the response. Value range is
|
1007
|
+
# 1 to 1000. You must set `MaxResults` to receive a value for
|
1008
|
+
# `NextToken` in the response.
|
1009
|
+
# @return [Integer]
|
1010
|
+
#
|
870
1011
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
|
871
1012
|
#
|
872
1013
|
class ListDeadLetterSourceQueuesRequest < Struct.new(
|
873
|
-
:queue_url
|
1014
|
+
:queue_url,
|
1015
|
+
:next_token,
|
1016
|
+
:max_results)
|
1017
|
+
SENSITIVE = []
|
874
1018
|
include Aws::Structure
|
875
1019
|
end
|
876
1020
|
|
@@ -881,10 +1025,18 @@ module Aws::SQS
|
|
881
1025
|
# attribute configured with a dead-letter queue.
|
882
1026
|
# @return [Array<String>]
|
883
1027
|
#
|
1028
|
+
# @!attribute [rw] next_token
|
1029
|
+
# Pagination token to include in the next request. Token value is
|
1030
|
+
# `null` if there are no additional results to request, or if you did
|
1031
|
+
# not set `MaxResults` in the request.
|
1032
|
+
# @return [String]
|
1033
|
+
#
|
884
1034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
|
885
1035
|
#
|
886
1036
|
class ListDeadLetterSourceQueuesResult < Struct.new(
|
887
|
-
:queue_urls
|
1037
|
+
:queue_urls,
|
1038
|
+
:next_token)
|
1039
|
+
SENSITIVE = []
|
888
1040
|
include Aws::Structure
|
889
1041
|
end
|
890
1042
|
|
@@ -903,6 +1055,7 @@ module Aws::SQS
|
|
903
1055
|
#
|
904
1056
|
class ListQueueTagsRequest < Struct.new(
|
905
1057
|
:queue_url)
|
1058
|
+
SENSITIVE = []
|
906
1059
|
include Aws::Structure
|
907
1060
|
end
|
908
1061
|
|
@@ -914,6 +1067,7 @@ module Aws::SQS
|
|
914
1067
|
#
|
915
1068
|
class ListQueueTagsResult < Struct.new(
|
916
1069
|
:tags)
|
1070
|
+
SENSITIVE = []
|
917
1071
|
include Aws::Structure
|
918
1072
|
end
|
919
1073
|
|
@@ -922,6 +1076,8 @@ module Aws::SQS
|
|
922
1076
|
#
|
923
1077
|
# {
|
924
1078
|
# queue_name_prefix: "String",
|
1079
|
+
# next_token: "Token",
|
1080
|
+
# max_results: 1,
|
925
1081
|
# }
|
926
1082
|
#
|
927
1083
|
# @!attribute [rw] queue_name_prefix
|
@@ -931,23 +1087,45 @@ module Aws::SQS
|
|
931
1087
|
# Queue URLs and names are case-sensitive.
|
932
1088
|
# @return [String]
|
933
1089
|
#
|
1090
|
+
# @!attribute [rw] next_token
|
1091
|
+
# Pagination token to request the next set of results.
|
1092
|
+
# @return [String]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] max_results
|
1095
|
+
# Maximum number of results to include in the response. Value range is
|
1096
|
+
# 1 to 1000. You must set `MaxResults` to receive a value for
|
1097
|
+
# `NextToken` in the response.
|
1098
|
+
# @return [Integer]
|
1099
|
+
#
|
934
1100
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
|
935
1101
|
#
|
936
1102
|
class ListQueuesRequest < Struct.new(
|
937
|
-
:queue_name_prefix
|
1103
|
+
:queue_name_prefix,
|
1104
|
+
:next_token,
|
1105
|
+
:max_results)
|
1106
|
+
SENSITIVE = []
|
938
1107
|
include Aws::Structure
|
939
1108
|
end
|
940
1109
|
|
941
1110
|
# A list of your queues.
|
942
1111
|
#
|
943
1112
|
# @!attribute [rw] queue_urls
|
944
|
-
# A list of queue URLs, up to 1,000 entries
|
1113
|
+
# A list of queue URLs, up to 1,000 entries, or the value of
|
1114
|
+
# MaxResults that you sent in the request.
|
945
1115
|
# @return [Array<String>]
|
946
1116
|
#
|
1117
|
+
# @!attribute [rw] next_token
|
1118
|
+
# Pagination token to include in the next request. Token value is
|
1119
|
+
# `null` if there are no additional results to request, or if you did
|
1120
|
+
# not set `MaxResults` in the request.
|
1121
|
+
# @return [String]
|
1122
|
+
#
|
947
1123
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult AWS API Documentation
|
948
1124
|
#
|
949
1125
|
class ListQueuesResult < Struct.new(
|
950
|
-
:queue_urls
|
1126
|
+
:queue_urls,
|
1127
|
+
:next_token)
|
1128
|
+
SENSITIVE = []
|
951
1129
|
include Aws::Structure
|
952
1130
|
end
|
953
1131
|
|
@@ -1019,7 +1197,7 @@ module Aws::SQS
|
|
1019
1197
|
#
|
1020
1198
|
#
|
1021
1199
|
#
|
1022
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1200
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1023
1201
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1024
1202
|
#
|
1025
1203
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/Message AWS API Documentation
|
@@ -1032,6 +1210,7 @@ module Aws::SQS
|
|
1032
1210
|
:attributes,
|
1033
1211
|
:md5_of_message_attributes,
|
1034
1212
|
:message_attributes)
|
1213
|
+
SENSITIVE = []
|
1035
1214
|
include Aws::Structure
|
1036
1215
|
end
|
1037
1216
|
|
@@ -1088,7 +1267,7 @@ module Aws::SQS
|
|
1088
1267
|
#
|
1089
1268
|
#
|
1090
1269
|
#
|
1091
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1270
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1092
1271
|
# @return [String]
|
1093
1272
|
#
|
1094
1273
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageAttributeValue AWS API Documentation
|
@@ -1099,6 +1278,7 @@ module Aws::SQS
|
|
1099
1278
|
:string_list_values,
|
1100
1279
|
:binary_list_values,
|
1101
1280
|
:data_type)
|
1281
|
+
SENSITIVE = []
|
1102
1282
|
include Aws::Structure
|
1103
1283
|
end
|
1104
1284
|
|
@@ -1159,7 +1339,7 @@ module Aws::SQS
|
|
1159
1339
|
#
|
1160
1340
|
#
|
1161
1341
|
#
|
1162
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1342
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1163
1343
|
# @return [String]
|
1164
1344
|
#
|
1165
1345
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageSystemAttributeValue AWS API Documentation
|
@@ -1170,6 +1350,7 @@ module Aws::SQS
|
|
1170
1350
|
:string_list_values,
|
1171
1351
|
:binary_list_values,
|
1172
1352
|
:data_type)
|
1353
|
+
SENSITIVE = []
|
1173
1354
|
include Aws::Structure
|
1174
1355
|
end
|
1175
1356
|
|
@@ -1208,6 +1389,7 @@ module Aws::SQS
|
|
1208
1389
|
#
|
1209
1390
|
class PurgeQueueRequest < Struct.new(
|
1210
1391
|
:queue_url)
|
1392
|
+
SENSITIVE = []
|
1211
1393
|
include Aws::Structure
|
1212
1394
|
end
|
1213
1395
|
|
@@ -1243,7 +1425,7 @@ module Aws::SQS
|
|
1243
1425
|
#
|
1244
1426
|
# {
|
1245
1427
|
# queue_url: "String", # required
|
1246
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
1428
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
1247
1429
|
# message_attribute_names: ["MessageAttributeName"],
|
1248
1430
|
# max_number_of_messages: 1,
|
1249
1431
|
# visibility_timeout: 1,
|
@@ -1261,16 +1443,16 @@ module Aws::SQS
|
|
1261
1443
|
# A list of attributes that need to be returned along with each
|
1262
1444
|
# message. These attributes include:
|
1263
1445
|
#
|
1264
|
-
# * `All`
|
1446
|
+
# * `All` – Returns all values.
|
1265
1447
|
#
|
1266
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1448
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1267
1449
|
# was first received from the queue ([epoch time][1] in
|
1268
1450
|
# milliseconds).
|
1269
1451
|
#
|
1270
|
-
# * `ApproximateReceiveCount`
|
1271
|
-
# has been received
|
1452
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1453
|
+
# has been received across all queues but not deleted.
|
1272
1454
|
#
|
1273
|
-
# * `AWSTraceHeader`
|
1455
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1274
1456
|
#
|
1275
1457
|
# * `SenderId`
|
1276
1458
|
#
|
@@ -1280,17 +1462,17 @@ module Aws::SQS
|
|
1280
1462
|
# * For an IAM role, returns the IAM role ID, for example
|
1281
1463
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1282
1464
|
#
|
1283
|
-
# * `SentTimestamp`
|
1465
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1284
1466
|
# queue ([epoch time][1] in milliseconds).
|
1285
1467
|
#
|
1286
|
-
# * `MessageDeduplicationId`
|
1468
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1287
1469
|
# producer that calls the ` SendMessage ` action.
|
1288
1470
|
#
|
1289
|
-
# * `MessageGroupId`
|
1471
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1290
1472
|
# calls the ` SendMessage ` action. Messages with the same
|
1291
1473
|
# `MessageGroupId` are returned in sequence.
|
1292
1474
|
#
|
1293
|
-
# * `SequenceNumber`
|
1475
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1294
1476
|
#
|
1295
1477
|
#
|
1296
1478
|
#
|
@@ -1338,6 +1520,18 @@ module Aws::SQS
|
|
1338
1520
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1339
1521
|
# available and the wait time expires, the call returns successfully
|
1340
1522
|
# with an empty list of messages.
|
1523
|
+
#
|
1524
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1525
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1526
|
+
# parameter. For example, with the Java SDK, you can set HTTP
|
1527
|
+
# transport settings using the [ NettyNioAsyncHttpClient][1] for
|
1528
|
+
# asynchronous clients, or the [ ApacheHttpClient][2] for synchronous
|
1529
|
+
# clients.
|
1530
|
+
#
|
1531
|
+
#
|
1532
|
+
#
|
1533
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1534
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1341
1535
|
# @return [Integer]
|
1342
1536
|
#
|
1343
1537
|
# @!attribute [rw] receive_request_attempt_id
|
@@ -1345,10 +1539,10 @@ module Aws::SQS
|
|
1345
1539
|
#
|
1346
1540
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1347
1541
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1348
|
-
# of a response you receive a generic error,
|
1349
|
-
# action with an identical `ReceiveRequestAttemptId` to
|
1350
|
-
# same set of messages, even if their visibility timeout
|
1351
|
-
# expired.
|
1542
|
+
# of a response you receive a generic error, it is possible to retry
|
1543
|
+
# the same action with an identical `ReceiveRequestAttemptId` to
|
1544
|
+
# retrieve the same set of messages, even if their visibility timeout
|
1545
|
+
# has not yet expired.
|
1352
1546
|
#
|
1353
1547
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
1354
1548
|
# `ReceiveMessage` action.
|
@@ -1360,7 +1554,7 @@ module Aws::SQS
|
|
1360
1554
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1361
1555
|
# `ReceiveRequestAttemptId`.
|
1362
1556
|
#
|
1363
|
-
# *
|
1557
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1364
1558
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1365
1559
|
# modified (deleted or had their visibility changes).
|
1366
1560
|
#
|
@@ -1394,7 +1588,7 @@ module Aws::SQS
|
|
1394
1588
|
# visibility timeout expires. As a result, delays might occur but
|
1395
1589
|
# the messages in the queue remain in a strict order.
|
1396
1590
|
#
|
1397
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1591
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1398
1592
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters
|
1399
1593
|
# (`a-z`, `A-Z`, `0-9`) and punctuation (``
|
1400
1594
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
@@ -1419,6 +1613,7 @@ module Aws::SQS
|
|
1419
1613
|
:visibility_timeout,
|
1420
1614
|
:wait_time_seconds,
|
1421
1615
|
:receive_request_attempt_id)
|
1616
|
+
SENSITIVE = []
|
1422
1617
|
include Aws::Structure
|
1423
1618
|
end
|
1424
1619
|
|
@@ -1432,6 +1627,7 @@ module Aws::SQS
|
|
1432
1627
|
#
|
1433
1628
|
class ReceiveMessageResult < Struct.new(
|
1434
1629
|
:messages)
|
1630
|
+
SENSITIVE = []
|
1435
1631
|
include Aws::Structure
|
1436
1632
|
end
|
1437
1633
|
|
@@ -1459,6 +1655,7 @@ module Aws::SQS
|
|
1459
1655
|
class RemovePermissionRequest < Struct.new(
|
1460
1656
|
:queue_url,
|
1461
1657
|
:label)
|
1658
|
+
SENSITIVE = []
|
1462
1659
|
include Aws::Structure
|
1463
1660
|
end
|
1464
1661
|
|
@@ -1511,6 +1708,7 @@ module Aws::SQS
|
|
1511
1708
|
class SendMessageBatchRequest < Struct.new(
|
1512
1709
|
:queue_url,
|
1513
1710
|
:entries)
|
1711
|
+
SENSITIVE = []
|
1514
1712
|
include Aws::Structure
|
1515
1713
|
end
|
1516
1714
|
|
@@ -1550,7 +1748,7 @@ module Aws::SQS
|
|
1550
1748
|
# An identifier for a message in this batch used to communicate the
|
1551
1749
|
# result.
|
1552
1750
|
#
|
1553
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
1751
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
1554
1752
|
#
|
1555
1753
|
# This identifier can have up to 80 characters. The following
|
1556
1754
|
# characters are accepted: alphanumeric characters, hyphens(-), and
|
@@ -1583,7 +1781,7 @@ module Aws::SQS
|
|
1583
1781
|
#
|
1584
1782
|
#
|
1585
1783
|
#
|
1586
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1784
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1587
1785
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1588
1786
|
#
|
1589
1787
|
# @!attribute [rw] message_system_attributes
|
@@ -1592,7 +1790,7 @@ module Aws::SQS
|
|
1592
1790
|
#
|
1593
1791
|
# * Currently, the only supported message system attribute is
|
1594
1792
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1595
|
-
# a correctly formatted AWS X-Ray trace string.
|
1793
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1596
1794
|
#
|
1597
1795
|
# * The size of a message system attribute doesn't count towards the
|
1598
1796
|
# total size of a message.
|
@@ -1710,6 +1908,7 @@ module Aws::SQS
|
|
1710
1908
|
:message_system_attributes,
|
1711
1909
|
:message_deduplication_id,
|
1712
1910
|
:message_group_id)
|
1911
|
+
SENSITIVE = []
|
1713
1912
|
include Aws::Structure
|
1714
1913
|
end
|
1715
1914
|
|
@@ -1731,6 +1930,7 @@ module Aws::SQS
|
|
1731
1930
|
class SendMessageBatchResult < Struct.new(
|
1732
1931
|
:successful,
|
1733
1932
|
:failed)
|
1933
|
+
SENSITIVE = []
|
1734
1934
|
include Aws::Structure
|
1735
1935
|
end
|
1736
1936
|
|
@@ -1746,11 +1946,10 @@ module Aws::SQS
|
|
1746
1946
|
# @return [String]
|
1747
1947
|
#
|
1748
1948
|
# @!attribute [rw] md5_of_message_body
|
1749
|
-
# An MD5 digest of the non-URL-encoded message
|
1750
|
-
#
|
1751
|
-
#
|
1752
|
-
#
|
1753
|
-
# [RFC1321][1].
|
1949
|
+
# An MD5 digest of the non-URL-encoded message body string. You can
|
1950
|
+
# use this attribute to verify that Amazon SQS received the message
|
1951
|
+
# correctly. Amazon SQS URL-decodes the message before creating the
|
1952
|
+
# MD5 digest. For information about MD5, see [RFC1321][1].
|
1754
1953
|
#
|
1755
1954
|
#
|
1756
1955
|
#
|
@@ -1800,6 +1999,7 @@ module Aws::SQS
|
|
1800
1999
|
:md5_of_message_attributes,
|
1801
2000
|
:md5_of_message_system_attributes,
|
1802
2001
|
:sequence_number)
|
2002
|
+
SENSITIVE = []
|
1803
2003
|
include Aws::Structure
|
1804
2004
|
end
|
1805
2005
|
|
@@ -1839,7 +2039,8 @@ module Aws::SQS
|
|
1839
2039
|
# @return [String]
|
1840
2040
|
#
|
1841
2041
|
# @!attribute [rw] message_body
|
1842
|
-
# The message to send. The
|
2042
|
+
# The message to send. The minimum size is one character. The maximum
|
2043
|
+
# size is 256 KB.
|
1843
2044
|
#
|
1844
2045
|
# A message can include only XML, JSON, and unformatted text. The
|
1845
2046
|
# following Unicode characters are allowed:
|
@@ -1875,7 +2076,7 @@ module Aws::SQS
|
|
1875
2076
|
#
|
1876
2077
|
#
|
1877
2078
|
#
|
1878
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
2079
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1879
2080
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1880
2081
|
#
|
1881
2082
|
# @!attribute [rw] message_system_attributes
|
@@ -1884,7 +2085,7 @@ module Aws::SQS
|
|
1884
2085
|
#
|
1885
2086
|
# * Currently, the only supported message system attribute is
|
1886
2087
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1887
|
-
# a correctly formatted AWS X-Ray trace string.
|
2088
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1888
2089
|
#
|
1889
2090
|
# * The size of a message system attribute doesn't count towards the
|
1890
2091
|
# total size of a message.
|
@@ -1941,7 +2142,7 @@ module Aws::SQS
|
|
1941
2142
|
#
|
1942
2143
|
# </note>
|
1943
2144
|
#
|
1944
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
2145
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1945
2146
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1946
2147
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1947
2148
|
# ``).
|
@@ -2002,17 +2203,17 @@ module Aws::SQS
|
|
2002
2203
|
:message_system_attributes,
|
2003
2204
|
:message_deduplication_id,
|
2004
2205
|
:message_group_id)
|
2206
|
+
SENSITIVE = []
|
2005
2207
|
include Aws::Structure
|
2006
2208
|
end
|
2007
2209
|
|
2008
2210
|
# The `MD5OfMessageBody` and `MessageId` elements.
|
2009
2211
|
#
|
2010
2212
|
# @!attribute [rw] md5_of_message_body
|
2011
|
-
# An MD5 digest of the non-URL-encoded message
|
2012
|
-
#
|
2013
|
-
#
|
2014
|
-
#
|
2015
|
-
# [RFC1321][1].
|
2213
|
+
# An MD5 digest of the non-URL-encoded message body string. You can
|
2214
|
+
# use this attribute to verify that Amazon SQS received the message
|
2215
|
+
# correctly. Amazon SQS URL-decodes the message before creating the
|
2216
|
+
# MD5 digest. For information about MD5, see [RFC1321][1].
|
2016
2217
|
#
|
2017
2218
|
#
|
2018
2219
|
#
|
@@ -2066,6 +2267,7 @@ module Aws::SQS
|
|
2066
2267
|
:md5_of_message_system_attributes,
|
2067
2268
|
:message_id,
|
2068
2269
|
:sequence_number)
|
2270
|
+
SENSITIVE = []
|
2069
2271
|
include Aws::Structure
|
2070
2272
|
end
|
2071
2273
|
|
@@ -2092,40 +2294,40 @@ module Aws::SQS
|
|
2092
2294
|
# special request parameters that the `SetQueueAttributes` action
|
2093
2295
|
# uses:
|
2094
2296
|
#
|
2095
|
-
# * `DelaySeconds`
|
2297
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2096
2298
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2097
2299
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2098
2300
|
#
|
2099
|
-
# * `MaximumMessageSize`
|
2301
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2100
2302
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
2101
2303
|
# from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
|
2102
2304
|
# 262,144 (256 KiB).
|
2103
2305
|
#
|
2104
|
-
# * `MessageRetentionPeriod`
|
2306
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2105
2307
|
# which Amazon SQS retains a message. Valid values: An integer
|
2106
2308
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2107
2309
|
# Default: 345,600 (4 days).
|
2108
2310
|
#
|
2109
|
-
# * `Policy`
|
2311
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2110
2312
|
# information about policy structure, see [Overview of AWS IAM
|
2111
2313
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2112
2314
|
#
|
2113
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2315
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2114
2316
|
# for which a ` ReceiveMessage ` action waits for a message to
|
2115
|
-
# arrive. Valid values:
|
2317
|
+
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2116
2318
|
# 0.
|
2117
2319
|
#
|
2118
|
-
# * `RedrivePolicy`
|
2119
|
-
# dead-letter queue functionality of the source queue
|
2120
|
-
# information about the redrive policy and
|
2121
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
2122
|
-
# Queue Service Developer Guide*.
|
2320
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2321
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2322
|
+
# object. For more information about the redrive policy and
|
2323
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2324
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
2123
2325
|
#
|
2124
|
-
# * `deadLetterTargetArn`
|
2326
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2125
2327
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2126
2328
|
# value of `maxReceiveCount` is exceeded.
|
2127
2329
|
#
|
2128
|
-
# * `maxReceiveCount`
|
2330
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
2129
2331
|
# to the source queue before being moved to the dead-letter queue.
|
2130
2332
|
# When the `ReceiveCount` for a message exceeds the
|
2131
2333
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -2137,22 +2339,22 @@ module Aws::SQS
|
|
2137
2339
|
#
|
2138
2340
|
# </note>
|
2139
2341
|
#
|
2140
|
-
# * `VisibilityTimeout`
|
2141
|
-
# seconds. Valid values:
|
2342
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2343
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2142
2344
|
# Default: 30. For more information about the visibility timeout,
|
2143
2345
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2144
2346
|
# Developer Guide*.
|
2145
2347
|
#
|
2146
2348
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2147
2349
|
#
|
2148
|
-
# * `KmsMasterKeyId`
|
2350
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2149
2351
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
2150
2352
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
2151
2353
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
2152
2354
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
2153
2355
|
# the *AWS Key Management Service API Reference*.
|
2154
2356
|
#
|
2155
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2357
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
2156
2358
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
2157
2359
|
# decrypt messages before calling AWS KMS again. An integer
|
2158
2360
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -2164,11 +2366,11 @@ module Aws::SQS
|
|
2164
2366
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2165
2367
|
# queues][9]\:
|
2166
2368
|
#
|
2167
|
-
# * `ContentBasedDeduplication`
|
2369
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2168
2370
|
# For more information, see [Exactly-Once Processing][10] in the
|
2169
|
-
# *Amazon Simple Queue Service Developer Guide*.
|
2371
|
+
# *Amazon Simple Queue Service Developer Guide*. Note the following:
|
2170
2372
|
#
|
2171
|
-
# * Every message must have a unique `MessageDeduplicationId
|
2373
|
+
# * Every message must have a unique `MessageDeduplicationId`.
|
2172
2374
|
#
|
2173
2375
|
# * You may provide a `MessageDeduplicationId` explicitly.
|
2174
2376
|
#
|
@@ -2196,6 +2398,50 @@ module Aws::SQS
|
|
2196
2398
|
# `MessageDeduplicationId`, the two messages are treated as
|
2197
2399
|
# duplicates and only one copy of the message is delivered.
|
2198
2400
|
#
|
2401
|
+
# **Preview: High throughput for FIFO queues**
|
2402
|
+
#
|
2403
|
+
# **High throughput for Amazon SQS FIFO queues is in preview release
|
2404
|
+
# and is subject to change.** This feature provides a high number of
|
2405
|
+
# transactions per second (TPS) for messages in FIFO queues. For
|
2406
|
+
# information on throughput quotas, see [Quotas related to
|
2407
|
+
# messages][11] in the *Amazon Simple Queue Service Developer Guide*.
|
2408
|
+
#
|
2409
|
+
# This preview includes two new attributes:
|
2410
|
+
#
|
2411
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
2412
|
+
# occurs at the message group or queue level. Valid values are
|
2413
|
+
# `messageGroup` and `queue`.
|
2414
|
+
#
|
2415
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue
|
2416
|
+
# throughput quota applies to the entire queue or per message group.
|
2417
|
+
# Valid values are `perQueue` and `perMessageGroupId`. The
|
2418
|
+
# `perMessageGroupId` value is allowed only when the value for
|
2419
|
+
# `DeduplicationScope` is `messageGroup`.
|
2420
|
+
#
|
2421
|
+
# To enable high throughput for FIFO queues, do the following:
|
2422
|
+
#
|
2423
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
2424
|
+
#
|
2425
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
2426
|
+
#
|
2427
|
+
# If you set these attributes to anything other than the values shown
|
2428
|
+
# for enabling high throughput, standard throughput is in effect and
|
2429
|
+
# deduplication occurs as specified.
|
2430
|
+
#
|
2431
|
+
# This preview is available in the following AWS Regions:
|
2432
|
+
#
|
2433
|
+
# * US East (Ohio); us-east-2
|
2434
|
+
#
|
2435
|
+
# * US East (N. Virginia); us-east-1
|
2436
|
+
#
|
2437
|
+
# * US West (Oregon); us-west-2
|
2438
|
+
#
|
2439
|
+
# * Europe (Ireland); eu-west-1
|
2440
|
+
#
|
2441
|
+
# For more information about high throughput for FIFO queues, see
|
2442
|
+
# [Preview: High throughput for FIFO queues][12] in the *Amazon Simple
|
2443
|
+
# Queue Service Developer Guide*.
|
2444
|
+
#
|
2199
2445
|
#
|
2200
2446
|
#
|
2201
2447
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -2208,6 +2454,8 @@ module Aws::SQS
|
|
2208
2454
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2209
2455
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2210
2456
|
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
2457
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2458
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2211
2459
|
# @return [Hash<String,String>]
|
2212
2460
|
#
|
2213
2461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation
|
@@ -2215,6 +2463,7 @@ module Aws::SQS
|
|
2215
2463
|
class SetQueueAttributesRequest < Struct.new(
|
2216
2464
|
:queue_url,
|
2217
2465
|
:attributes)
|
2466
|
+
SENSITIVE = []
|
2218
2467
|
include Aws::Structure
|
2219
2468
|
end
|
2220
2469
|
|
@@ -2241,6 +2490,7 @@ module Aws::SQS
|
|
2241
2490
|
class TagQueueRequest < Struct.new(
|
2242
2491
|
:queue_url,
|
2243
2492
|
:tags)
|
2493
|
+
SENSITIVE = []
|
2244
2494
|
include Aws::Structure
|
2245
2495
|
end
|
2246
2496
|
|
@@ -2277,6 +2527,7 @@ module Aws::SQS
|
|
2277
2527
|
class UntagQueueRequest < Struct.new(
|
2278
2528
|
:queue_url,
|
2279
2529
|
:tag_keys)
|
2530
|
+
SENSITIVE = []
|
2280
2531
|
include Aws::Structure
|
2281
2532
|
end
|
2282
2533
|
|