aws-sdk-sqs 1.39.0 → 1.86.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +248 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +800 -329
- data/lib/aws-sdk-sqs/client_api.rb +325 -52
- data/lib/aws-sdk-sqs/customizations.rb +5 -1
- data/lib/aws-sdk-sqs/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-sqs/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-sqs/endpoints.rb +269 -0
- data/lib/aws-sdk-sqs/errors.rb +262 -0
- data/lib/aws-sdk-sqs/message.rb +13 -6
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +128 -0
- data/lib/aws-sdk-sqs/plugins/md5s.rb +84 -35
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +20 -18
- data/lib/aws-sdk-sqs/queue.rb +209 -93
- data/lib/aws-sdk-sqs/queue_poller.rb +71 -35
- data/lib/aws-sdk-sqs/resource.rb +106 -59
- data/lib/aws-sdk-sqs/types.rb +827 -502
- data/lib/aws-sdk-sqs.rb +17 -9
- data/sig/client.rbs +367 -0
- data/sig/errors.rbs +98 -0
- data/sig/message.rbs +73 -0
- data/sig/queue.rbs +164 -0
- data/sig/resource.rbs +108 -0
- data/sig/types.rbs +472 -0
- data/sig/waiters.rbs +13 -0
- metadata +22 -11
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -10,16 +10,6 @@
|
|
10
10
|
module Aws::SQS
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# @note When making an API call, you may pass AddPermissionRequest
|
14
|
-
# data as a hash:
|
15
|
-
#
|
16
|
-
# {
|
17
|
-
# queue_url: "String", # required
|
18
|
-
# label: "String", # required
|
19
|
-
# aws_account_ids: ["String"], # required
|
20
|
-
# actions: ["String"], # required
|
21
|
-
# }
|
22
|
-
#
|
23
13
|
# @!attribute [rw] queue_url
|
24
14
|
# The URL of the Amazon SQS queue to which permissions are added.
|
25
15
|
#
|
@@ -34,11 +24,10 @@ module Aws::SQS
|
|
34
24
|
# @return [String]
|
35
25
|
#
|
36
26
|
# @!attribute [rw] aws_account_ids
|
37
|
-
# The
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
# *Amazon Simple Queue Service Developer Guide*.
|
27
|
+
# The Amazon Web Services account numbers of the [principals][1] who
|
28
|
+
# are to receive permission. For information about locating the Amazon
|
29
|
+
# Web Services account identification, see [Your Amazon Web Services
|
30
|
+
# Identifiers][2] in the *Amazon SQS Developer Guide*.
|
42
31
|
#
|
43
32
|
#
|
44
33
|
#
|
@@ -52,7 +41,7 @@ module Aws::SQS
|
|
52
41
|
#
|
53
42
|
# For more information about these actions, see [Overview of Managing
|
54
43
|
# Access Permissions to Your Amazon Simple Queue Service Resource][1]
|
55
|
-
# in the *Amazon
|
44
|
+
# in the *Amazon SQS Developer Guide*.
|
56
45
|
#
|
57
46
|
# Specifying `SendMessage`, `DeleteMessage`, or
|
58
47
|
# `ChangeMessageVisibility` for `ActionName.n` also grants permissions
|
@@ -78,15 +67,29 @@ module Aws::SQS
|
|
78
67
|
|
79
68
|
# Two or more batch entries in the request have the same `Id`.
|
80
69
|
#
|
70
|
+
# @!attribute [rw] message
|
71
|
+
# @return [String]
|
72
|
+
#
|
81
73
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchEntryIdsNotDistinct AWS API Documentation
|
82
74
|
#
|
83
|
-
class BatchEntryIdsNotDistinct <
|
75
|
+
class BatchEntryIdsNotDistinct < Struct.new(
|
76
|
+
:message)
|
77
|
+
SENSITIVE = []
|
78
|
+
include Aws::Structure
|
79
|
+
end
|
84
80
|
|
85
81
|
# The length of all the messages put together is more than the limit.
|
86
82
|
#
|
83
|
+
# @!attribute [rw] message
|
84
|
+
# @return [String]
|
85
|
+
#
|
87
86
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchRequestTooLong AWS API Documentation
|
88
87
|
#
|
89
|
-
class BatchRequestTooLong <
|
88
|
+
class BatchRequestTooLong < Struct.new(
|
89
|
+
:message)
|
90
|
+
SENSITIVE = []
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
90
93
|
|
91
94
|
# Gives a detailed description of the result of an action on each entry
|
92
95
|
# in the request.
|
@@ -119,20 +122,31 @@ module Aws::SQS
|
|
119
122
|
include Aws::Structure
|
120
123
|
end
|
121
124
|
|
122
|
-
#
|
123
|
-
#
|
125
|
+
# @!attribute [rw] task_handle
|
126
|
+
# An identifier associated with a message movement task.
|
127
|
+
# @return [String]
|
128
|
+
#
|
129
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTaskRequest AWS API Documentation
|
130
|
+
#
|
131
|
+
class CancelMessageMoveTaskRequest < Struct.new(
|
132
|
+
:task_handle)
|
133
|
+
SENSITIVE = []
|
134
|
+
include Aws::Structure
|
135
|
+
end
|
136
|
+
|
137
|
+
# @!attribute [rw] approximate_number_of_messages_moved
|
138
|
+
# The approximate number of messages already moved to the destination
|
139
|
+
# queue.
|
140
|
+
# @return [Integer]
|
124
141
|
#
|
125
|
-
#
|
126
|
-
# queue_url: "String", # required
|
127
|
-
# entries: [ # required
|
128
|
-
# {
|
129
|
-
# id: "String", # required
|
130
|
-
# receipt_handle: "String", # required
|
131
|
-
# visibility_timeout: 1,
|
132
|
-
# },
|
133
|
-
# ],
|
134
|
-
# }
|
142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTaskResult AWS API Documentation
|
135
143
|
#
|
144
|
+
class CancelMessageMoveTaskResult < Struct.new(
|
145
|
+
:approximate_number_of_messages_moved)
|
146
|
+
SENSITIVE = []
|
147
|
+
include Aws::Structure
|
148
|
+
end
|
149
|
+
|
136
150
|
# @!attribute [rw] queue_url
|
137
151
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
138
152
|
# changed.
|
@@ -141,7 +155,7 @@ module Aws::SQS
|
|
141
155
|
# @return [String]
|
142
156
|
#
|
143
157
|
# @!attribute [rw] entries
|
144
|
-
#
|
158
|
+
# Lists the receipt handles of the messages for which the visibility
|
145
159
|
# timeout must be changed.
|
146
160
|
# @return [Array<Types::ChangeMessageVisibilityBatchRequestEntry>]
|
147
161
|
#
|
@@ -154,29 +168,9 @@ module Aws::SQS
|
|
154
168
|
include Aws::Structure
|
155
169
|
end
|
156
170
|
|
157
|
-
# Encloses a receipt handle and an entry
|
171
|
+
# Encloses a receipt handle and an entry ID for each message in `
|
158
172
|
# ChangeMessageVisibilityBatch.`
|
159
173
|
#
|
160
|
-
# All of the following list parameters must be prefixed with
|
161
|
-
# `ChangeMessageVisibilityBatchRequestEntry.n`, where `n` is an integer
|
162
|
-
# value starting with `1`. For example, a parameter list for this action
|
163
|
-
# might look like this:
|
164
|
-
#
|
165
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
|
166
|
-
#
|
167
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle`
|
168
|
-
#
|
169
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
|
170
|
-
#
|
171
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityBatchRequestEntry
|
172
|
-
# data as a hash:
|
173
|
-
#
|
174
|
-
# {
|
175
|
-
# id: "String", # required
|
176
|
-
# receipt_handle: "String", # required
|
177
|
-
# visibility_timeout: 1,
|
178
|
-
# }
|
179
|
-
#
|
180
174
|
# @!attribute [rw] id
|
181
175
|
# An identifier for this particular receipt handle used to communicate
|
182
176
|
# the result.
|
@@ -244,15 +238,6 @@ module Aws::SQS
|
|
244
238
|
include Aws::Structure
|
245
239
|
end
|
246
240
|
|
247
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityRequest
|
248
|
-
# data as a hash:
|
249
|
-
#
|
250
|
-
# {
|
251
|
-
# queue_url: "String", # required
|
252
|
-
# receipt_handle: "String", # required
|
253
|
-
# visibility_timeout: 1, # required
|
254
|
-
# }
|
255
|
-
#
|
256
241
|
# @!attribute [rw] queue_url
|
257
242
|
# The URL of the Amazon SQS queue whose message's visibility is
|
258
243
|
# changed.
|
@@ -261,7 +246,7 @@ module Aws::SQS
|
|
261
246
|
# @return [String]
|
262
247
|
#
|
263
248
|
# @!attribute [rw] receipt_handle
|
264
|
-
# The receipt handle associated with the message whose visibility
|
249
|
+
# The receipt handle associated with the message, whose visibility
|
265
250
|
# timeout is changed. This parameter is returned by the `
|
266
251
|
# ReceiveMessage ` action.
|
267
252
|
# @return [String]
|
@@ -281,19 +266,6 @@ module Aws::SQS
|
|
281
266
|
include Aws::Structure
|
282
267
|
end
|
283
268
|
|
284
|
-
# @note When making an API call, you may pass CreateQueueRequest
|
285
|
-
# data as a hash:
|
286
|
-
#
|
287
|
-
# {
|
288
|
-
# queue_name: "String", # required
|
289
|
-
# attributes: {
|
290
|
-
# "All" => "String",
|
291
|
-
# },
|
292
|
-
# tags: {
|
293
|
-
# "TagKey" => "TagValue",
|
294
|
-
# },
|
295
|
-
# }
|
296
|
-
#
|
297
269
|
# @!attribute [rw] queue_name
|
298
270
|
# The name of the new queue. The following limits apply to this name:
|
299
271
|
#
|
@@ -325,22 +297,33 @@ module Aws::SQS
|
|
325
297
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
326
298
|
# which Amazon SQS retains a message. Valid values: An integer from
|
327
299
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
328
|
-
# 345,600 (4 days).
|
329
|
-
#
|
330
|
-
#
|
331
|
-
#
|
332
|
-
#
|
300
|
+
# 345,600 (4 days). When you change a queue's attributes, the
|
301
|
+
# change can take up to 60 seconds for most of the attributes to
|
302
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
303
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
304
|
+
# will impact existing messages in the queue potentially causing
|
305
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
306
|
+
# reduced below the age of existing messages.
|
307
|
+
#
|
308
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
309
|
+
# policy. For more information about policy structure, see [Overview
|
310
|
+
# of Amazon Web Services IAM Policies][1] in the *IAM User Guide*.
|
333
311
|
#
|
334
312
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
335
313
|
# for which a ` ReceiveMessage ` action waits for a message to
|
336
314
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
337
315
|
# 0.
|
338
316
|
#
|
317
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
318
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
319
|
+
# Default: 30. For more information about the visibility timeout,
|
320
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
321
|
+
#
|
322
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
323
|
+
#
|
339
324
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
325
|
# dead-letter queue functionality of the source queue as a JSON
|
341
|
-
# object.
|
342
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
326
|
+
# object. The parameters are as follows:
|
344
327
|
#
|
345
328
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
346
329
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -348,42 +331,69 @@ module Aws::SQS
|
|
348
331
|
#
|
349
332
|
# * `maxReceiveCount` – The number of times a message is delivered
|
350
333
|
# to the source queue before being moved to the dead-letter queue.
|
351
|
-
# When the `ReceiveCount` for a message exceeds the
|
334
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
352
335
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
353
336
|
# the dead-letter-queue.
|
354
337
|
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
# a
|
338
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
339
|
+
# the permissions for the dead-letter queue redrive permission and
|
340
|
+
# which source queues can specify dead-letter queues as a JSON
|
341
|
+
# object. The parameters are as follows:
|
358
342
|
#
|
359
|
-
#
|
343
|
+
# * `redrivePermission` – The permission type that defines which
|
344
|
+
# source queues can specify the current queue as the dead-letter
|
345
|
+
# queue. Valid values are:
|
360
346
|
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
#
|
347
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
348
|
+
# Services account in the same Region can specify this queue as
|
349
|
+
# the dead-letter queue.
|
350
|
+
#
|
351
|
+
# * `denyAll` – No source queues can specify this queue as the
|
352
|
+
# dead-letter queue.
|
366
353
|
#
|
367
|
-
#
|
354
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
355
|
+
# parameter can specify this queue as the dead-letter queue.
|
368
356
|
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
357
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
358
|
+
# source queues that can specify this queue as the dead-letter
|
359
|
+
# queue and redrive messages. You can specify this parameter only
|
360
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
361
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
362
|
+
# source queues to specify dead-letter queues, set the
|
363
|
+
# `redrivePermission` parameter to `allowAll`.
|
364
|
+
#
|
365
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
366
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
367
|
+
# standard queue.
|
368
|
+
#
|
369
|
+
# </note>
|
370
|
+
#
|
371
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
372
|
+
#
|
373
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
374
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
375
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
376
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
377
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
378
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
379
|
+
# Reference*.
|
375
380
|
#
|
376
381
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
377
382
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
378
|
-
# decrypt messages before calling
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
383
|
-
#
|
383
|
+
# decrypt messages before calling KMS again. An integer representing
|
384
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
385
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
386
|
+
# better security but results in more calls to KMS which might incur
|
387
|
+
# charges after Free Tier. For more information, see [How Does the
|
388
|
+
# Data Key Reuse Period Work?][8]
|
389
|
+
#
|
390
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
391
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
392
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
393
|
+
# [SSE-SQS][10]).
|
384
394
|
#
|
385
395
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
386
|
-
# queues][
|
396
|
+
# queues][11]:
|
387
397
|
#
|
388
398
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
389
399
|
# and `false`. If you don't specify the `FifoQueue` attribute,
|
@@ -392,13 +402,13 @@ module Aws::SQS
|
|
392
402
|
# existing queue. When you set this attribute, you must also provide
|
393
403
|
# the `MessageGroupId` for your messages explicitly.
|
394
404
|
#
|
395
|
-
# For more information, see [FIFO queue logic][
|
396
|
-
#
|
405
|
+
# For more information, see [FIFO queue logic][12] in the *Amazon
|
406
|
+
# SQS Developer Guide*.
|
397
407
|
#
|
398
408
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
399
409
|
# Valid values are `true` and `false`. For more information, see
|
400
|
-
# [Exactly-once processing][
|
401
|
-
#
|
410
|
+
# [Exactly-once processing][13] in the *Amazon SQS Developer Guide*.
|
411
|
+
# Note the following:
|
402
412
|
#
|
403
413
|
# * Every message must have a unique `MessageDeduplicationId`.
|
404
414
|
#
|
@@ -429,7 +439,7 @@ module Aws::SQS
|
|
429
439
|
# duplicates and only one copy of the message is delivered.
|
430
440
|
#
|
431
441
|
# The following attributes apply only to [high throughput for FIFO
|
432
|
-
# queues][
|
442
|
+
# queues][14]:
|
433
443
|
#
|
434
444
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
435
445
|
# occurs at the message group or queue level. Valid values are
|
@@ -452,29 +462,31 @@ module Aws::SQS
|
|
452
462
|
# deduplication occurs as specified.
|
453
463
|
#
|
454
464
|
# For information on throughput quotas, see [Quotas related to
|
455
|
-
# messages][
|
465
|
+
# messages][15] in the *Amazon SQS Developer Guide*.
|
456
466
|
#
|
457
467
|
#
|
458
468
|
#
|
459
469
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
460
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
461
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
470
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
471
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
462
472
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
463
473
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
464
474
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
465
475
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
466
476
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
467
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
468
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
469
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
470
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
471
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
477
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
478
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
479
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
480
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
481
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
482
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
483
|
+
# [15]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
472
484
|
# @return [Hash<String,String>]
|
473
485
|
#
|
474
486
|
# @!attribute [rw] tags
|
475
487
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
476
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
477
|
-
#
|
488
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
489
|
+
# Developer Guide*.
|
478
490
|
#
|
479
491
|
# When you use queue tags, keep the following guidelines in mind:
|
480
492
|
#
|
@@ -488,15 +500,15 @@ module Aws::SQS
|
|
488
500
|
# * A new tag with a key identical to that of an existing tag
|
489
501
|
# overwrites the existing tag.
|
490
502
|
#
|
491
|
-
# For a full list of tag restrictions, see [
|
492
|
-
#
|
503
|
+
# For a full list of tag restrictions, see [Quotas related to
|
504
|
+
# queues][2] in the *Amazon SQS Developer Guide*.
|
493
505
|
#
|
494
506
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
495
507
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
496
508
|
#
|
497
509
|
# Cross-account permissions don't apply to this action. For more
|
498
510
|
# information, see [Grant cross-account permissions to a role and a
|
499
|
-
#
|
511
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
500
512
|
#
|
501
513
|
# </note>
|
502
514
|
#
|
@@ -531,19 +543,6 @@ module Aws::SQS
|
|
531
543
|
include Aws::Structure
|
532
544
|
end
|
533
545
|
|
534
|
-
# @note When making an API call, you may pass DeleteMessageBatchRequest
|
535
|
-
# data as a hash:
|
536
|
-
#
|
537
|
-
# {
|
538
|
-
# queue_url: "String", # required
|
539
|
-
# entries: [ # required
|
540
|
-
# {
|
541
|
-
# id: "String", # required
|
542
|
-
# receipt_handle: "String", # required
|
543
|
-
# },
|
544
|
-
# ],
|
545
|
-
# }
|
546
|
-
#
|
547
546
|
# @!attribute [rw] queue_url
|
548
547
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
549
548
|
#
|
@@ -551,7 +550,7 @@ module Aws::SQS
|
|
551
550
|
# @return [String]
|
552
551
|
#
|
553
552
|
# @!attribute [rw] entries
|
554
|
-
#
|
553
|
+
# Lists the receipt handles for the messages to be deleted.
|
555
554
|
# @return [Array<Types::DeleteMessageBatchRequestEntry>]
|
556
555
|
#
|
557
556
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchRequest AWS API Documentation
|
@@ -565,16 +564,8 @@ module Aws::SQS
|
|
565
564
|
|
566
565
|
# Encloses a receipt handle and an identifier for it.
|
567
566
|
#
|
568
|
-
# @note When making an API call, you may pass DeleteMessageBatchRequestEntry
|
569
|
-
# data as a hash:
|
570
|
-
#
|
571
|
-
# {
|
572
|
-
# id: "String", # required
|
573
|
-
# receipt_handle: "String", # required
|
574
|
-
# }
|
575
|
-
#
|
576
567
|
# @!attribute [rw] id
|
577
|
-
#
|
568
|
+
# The identifier for this particular receipt handle. This is used to
|
578
569
|
# communicate the result.
|
579
570
|
#
|
580
571
|
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
@@ -634,14 +625,6 @@ module Aws::SQS
|
|
634
625
|
include Aws::Structure
|
635
626
|
end
|
636
627
|
|
637
|
-
# @note When making an API call, you may pass DeleteMessageRequest
|
638
|
-
# data as a hash:
|
639
|
-
#
|
640
|
-
# {
|
641
|
-
# queue_url: "String", # required
|
642
|
-
# receipt_handle: "String", # required
|
643
|
-
# }
|
644
|
-
#
|
645
628
|
# @!attribute [rw] queue_url
|
646
629
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
647
630
|
#
|
@@ -661,13 +644,6 @@ module Aws::SQS
|
|
661
644
|
include Aws::Structure
|
662
645
|
end
|
663
646
|
|
664
|
-
# @note When making an API call, you may pass DeleteQueueRequest
|
665
|
-
# data as a hash:
|
666
|
-
#
|
667
|
-
# {
|
668
|
-
# queue_url: "String", # required
|
669
|
-
# }
|
670
|
-
#
|
671
647
|
# @!attribute [rw] queue_url
|
672
648
|
# The URL of the Amazon SQS queue to delete.
|
673
649
|
#
|
@@ -684,18 +660,17 @@ module Aws::SQS
|
|
684
660
|
|
685
661
|
# The batch request doesn't contain any entries.
|
686
662
|
#
|
663
|
+
# @!attribute [rw] message
|
664
|
+
# @return [String]
|
665
|
+
#
|
687
666
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/EmptyBatchRequest AWS API Documentation
|
688
667
|
#
|
689
|
-
class EmptyBatchRequest <
|
668
|
+
class EmptyBatchRequest < Struct.new(
|
669
|
+
:message)
|
670
|
+
SENSITIVE = []
|
671
|
+
include Aws::Structure
|
672
|
+
end
|
690
673
|
|
691
|
-
# @note When making an API call, you may pass GetQueueAttributesRequest
|
692
|
-
# data as a hash:
|
693
|
-
#
|
694
|
-
# {
|
695
|
-
# queue_url: "String", # required
|
696
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
697
|
-
# }
|
698
|
-
#
|
699
674
|
# @!attribute [rw] queue_url
|
700
675
|
# The URL of the Amazon SQS queue whose attribute information is
|
701
676
|
# retrieved.
|
@@ -706,6 +681,10 @@ module Aws::SQS
|
|
706
681
|
# @!attribute [rw] attribute_names
|
707
682
|
# A list of attributes for which to retrieve information.
|
708
683
|
#
|
684
|
+
# The `AttributeNames` parameter is optional, but if you don't
|
685
|
+
# specify values for this parameter, the request returns empty
|
686
|
+
# results.
|
687
|
+
#
|
709
688
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
710
689
|
# calls this action, we recommend that you structure your code so that
|
711
690
|
# it can handle new attributes gracefully.
|
@@ -716,10 +695,10 @@ module Aws::SQS
|
|
716
695
|
#
|
717
696
|
# The `ApproximateNumberOfMessagesDelayed`,
|
718
697
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
719
|
-
# `
|
720
|
-
#
|
721
|
-
#
|
722
|
-
#
|
698
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
699
|
+
# until at least 1 minute after the producers stop sending messages.
|
700
|
+
# This period is required for the queue metadata to reach eventual
|
701
|
+
# consistency.
|
723
702
|
#
|
724
703
|
# * `All` – Returns all values.
|
725
704
|
#
|
@@ -751,7 +730,14 @@ module Aws::SQS
|
|
751
730
|
# message can contain before Amazon SQS rejects it.
|
752
731
|
#
|
753
732
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
754
|
-
# for which Amazon SQS retains a message.
|
733
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
734
|
+
# attributes, the change can take up to 60 seconds for most of the
|
735
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
736
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
737
|
+
# minutes and will impact existing messages in the queue potentially
|
738
|
+
# causing them to be expired and deleted if the
|
739
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
740
|
+
# messages.
|
755
741
|
#
|
756
742
|
# * `Policy` – Returns the policy of the queue.
|
757
743
|
#
|
@@ -761,11 +747,15 @@ module Aws::SQS
|
|
761
747
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
762
748
|
# to arrive.
|
763
749
|
#
|
750
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
751
|
+
# queue. For more information about the visibility timeout, see
|
752
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
753
|
+
#
|
754
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
755
|
+
#
|
764
756
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
765
757
|
# dead-letter queue functionality of the source queue as a JSON
|
766
|
-
# object.
|
767
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
768
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
758
|
+
# object. The parameters are as follows:
|
769
759
|
#
|
770
760
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
771
761
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -773,45 +763,77 @@ module Aws::SQS
|
|
773
763
|
#
|
774
764
|
# * `maxReceiveCount` – The number of times a message is delivered
|
775
765
|
# to the source queue before being moved to the dead-letter queue.
|
776
|
-
# When the `ReceiveCount` for a message exceeds the
|
766
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
777
767
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
778
768
|
# the dead-letter-queue.
|
779
769
|
#
|
780
|
-
# * `
|
781
|
-
#
|
782
|
-
#
|
783
|
-
#
|
770
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
771
|
+
# the permissions for the dead-letter queue redrive permission and
|
772
|
+
# which source queues can specify dead-letter queues as a JSON
|
773
|
+
# object. The parameters are as follows:
|
774
|
+
#
|
775
|
+
# * `redrivePermission` – The permission type that defines which
|
776
|
+
# source queues can specify the current queue as the dead-letter
|
777
|
+
# queue. Valid values are:
|
778
|
+
#
|
779
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
780
|
+
# Services account in the same Region can specify this queue as
|
781
|
+
# the dead-letter queue.
|
782
|
+
#
|
783
|
+
# * `denyAll` – No source queues can specify this queue as the
|
784
|
+
# dead-letter queue.
|
785
|
+
#
|
786
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
787
|
+
# parameter can specify this queue as the dead-letter queue.
|
784
788
|
#
|
785
|
-
#
|
789
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
790
|
+
# source queues that can specify this queue as the dead-letter
|
791
|
+
# queue and redrive messages. You can specify this parameter only
|
792
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
793
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
794
|
+
# source queues to specify dead-letter queues, set the
|
795
|
+
# `redrivePermission` parameter to `allowAll`.
|
786
796
|
#
|
787
|
-
#
|
788
|
-
#
|
789
|
-
#
|
797
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
798
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
799
|
+
# standard queue.
|
800
|
+
#
|
801
|
+
# </note>
|
802
|
+
#
|
803
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
804
|
+
#
|
805
|
+
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
|
806
|
+
# managed customer master key (CMK) for Amazon SQS or a custom CMK.
|
807
|
+
# For more information, see [Key Terms][5].
|
790
808
|
#
|
791
809
|
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
792
810
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
793
|
-
# decrypt messages before calling
|
794
|
-
#
|
811
|
+
# decrypt messages before calling KMS again. For more information,
|
812
|
+
# see [How Does the Data Key Reuse Period Work?][6].
|
813
|
+
#
|
814
|
+
# * `SqsManagedSseEnabled` – Returns information about whether the
|
815
|
+
# queue is using SSE-SQS encryption using SQS owned encryption keys.
|
816
|
+
# Only one server-side encryption option is supported per queue (for
|
817
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
795
818
|
#
|
796
819
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
797
|
-
# queues][
|
820
|
+
# queues][9]:
|
798
821
|
#
|
799
822
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
800
|
-
# For more information, see [FIFO queue logic][
|
801
|
-
#
|
823
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon
|
824
|
+
# SQS Developer Guide*.
|
802
825
|
#
|
803
|
-
# <note markdown="1"> To determine whether a queue is [FIFO][
|
826
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][9], you can check whether
|
804
827
|
# `QueueName` ends with the `.fifo` suffix.
|
805
828
|
#
|
806
829
|
# </note>
|
807
830
|
#
|
808
831
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
809
832
|
# deduplication is enabled for the queue. For more information, see
|
810
|
-
# [Exactly-once processing][
|
811
|
-
# Developer Guide*.
|
833
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
812
834
|
#
|
813
835
|
# The following attributes apply only to [high throughput for FIFO
|
814
|
-
# queues][
|
836
|
+
# queues][12]:
|
815
837
|
#
|
816
838
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
817
839
|
# occurs at the message group or queue level. Valid values are
|
@@ -834,21 +856,23 @@ module Aws::SQS
|
|
834
856
|
# deduplication occurs as specified.
|
835
857
|
#
|
836
858
|
# For information on throughput quotas, see [Quotas related to
|
837
|
-
# messages][
|
859
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
838
860
|
#
|
839
861
|
#
|
840
862
|
#
|
841
863
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
842
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
843
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
864
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
865
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
844
866
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
845
867
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
846
868
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
847
|
-
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
848
|
-
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
849
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
850
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
851
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
869
|
+
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
870
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
871
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
872
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
873
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
874
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
875
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
852
876
|
# @return [Array<String>]
|
853
877
|
#
|
854
878
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -874,14 +898,6 @@ module Aws::SQS
|
|
874
898
|
include Aws::Structure
|
875
899
|
end
|
876
900
|
|
877
|
-
# @note When making an API call, you may pass GetQueueUrlRequest
|
878
|
-
# data as a hash:
|
879
|
-
#
|
880
|
-
# {
|
881
|
-
# queue_name: "String", # required
|
882
|
-
# queue_owner_aws_account_id: "String",
|
883
|
-
# }
|
884
|
-
#
|
885
901
|
# @!attribute [rw] queue_name
|
886
902
|
# The name of the queue whose URL must be fetched. Maximum 80
|
887
903
|
# characters. Valid values: alphanumeric characters, hyphens (`-`),
|
@@ -891,7 +907,8 @@ module Aws::SQS
|
|
891
907
|
# @return [String]
|
892
908
|
#
|
893
909
|
# @!attribute [rw] queue_owner_aws_account_id
|
894
|
-
# The
|
910
|
+
# The Amazon Web Services account ID of the account that created the
|
911
|
+
# queue.
|
895
912
|
# @return [String]
|
896
913
|
#
|
897
914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
|
@@ -904,7 +921,7 @@ module Aws::SQS
|
|
904
921
|
end
|
905
922
|
|
906
923
|
# For more information, see [Interpreting Responses][1] in the *Amazon
|
907
|
-
#
|
924
|
+
# SQS Developer Guide*.
|
908
925
|
#
|
909
926
|
#
|
910
927
|
#
|
@@ -922,18 +939,58 @@ module Aws::SQS
|
|
922
939
|
include Aws::Structure
|
923
940
|
end
|
924
941
|
|
942
|
+
# The `accountId` is invalid.
|
943
|
+
#
|
944
|
+
# @!attribute [rw] message
|
945
|
+
# @return [String]
|
946
|
+
#
|
947
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAddress AWS API Documentation
|
948
|
+
#
|
949
|
+
class InvalidAddress < Struct.new(
|
950
|
+
:message)
|
951
|
+
SENSITIVE = []
|
952
|
+
include Aws::Structure
|
953
|
+
end
|
954
|
+
|
925
955
|
# The specified attribute doesn't exist.
|
926
956
|
#
|
957
|
+
# @!attribute [rw] message
|
958
|
+
# @return [String]
|
959
|
+
#
|
927
960
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeName AWS API Documentation
|
928
961
|
#
|
929
|
-
class InvalidAttributeName <
|
962
|
+
class InvalidAttributeName < Struct.new(
|
963
|
+
:message)
|
964
|
+
SENSITIVE = []
|
965
|
+
include Aws::Structure
|
966
|
+
end
|
967
|
+
|
968
|
+
# A queue attribute value is invalid.
|
969
|
+
#
|
970
|
+
# @!attribute [rw] message
|
971
|
+
# @return [String]
|
972
|
+
#
|
973
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeValue AWS API Documentation
|
974
|
+
#
|
975
|
+
class InvalidAttributeValue < Struct.new(
|
976
|
+
:message)
|
977
|
+
SENSITIVE = []
|
978
|
+
include Aws::Structure
|
979
|
+
end
|
930
980
|
|
931
981
|
# The `Id` of a batch entry in a batch request doesn't abide by the
|
932
982
|
# specification.
|
933
983
|
#
|
984
|
+
# @!attribute [rw] message
|
985
|
+
# @return [String]
|
986
|
+
#
|
934
987
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidBatchEntryId AWS API Documentation
|
935
988
|
#
|
936
|
-
class InvalidBatchEntryId <
|
989
|
+
class InvalidBatchEntryId < Struct.new(
|
990
|
+
:message)
|
991
|
+
SENSITIVE = []
|
992
|
+
include Aws::Structure
|
993
|
+
end
|
937
994
|
|
938
995
|
# The specified receipt handle isn't valid for the current version.
|
939
996
|
#
|
@@ -943,19 +1000,132 @@ module Aws::SQS
|
|
943
1000
|
|
944
1001
|
# The message contains characters outside the allowed set.
|
945
1002
|
#
|
1003
|
+
# @!attribute [rw] message
|
1004
|
+
# @return [String]
|
1005
|
+
#
|
946
1006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidMessageContents AWS API Documentation
|
947
1007
|
#
|
948
|
-
class InvalidMessageContents <
|
1008
|
+
class InvalidMessageContents < Struct.new(
|
1009
|
+
:message)
|
1010
|
+
SENSITIVE = []
|
1011
|
+
include Aws::Structure
|
1012
|
+
end
|
949
1013
|
|
950
|
-
#
|
951
|
-
#
|
1014
|
+
# When the request to a queue is not HTTPS and SigV4.
|
1015
|
+
#
|
1016
|
+
# @!attribute [rw] message
|
1017
|
+
# @return [String]
|
1018
|
+
#
|
1019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidSecurity AWS API Documentation
|
1020
|
+
#
|
1021
|
+
class InvalidSecurity < Struct.new(
|
1022
|
+
:message)
|
1023
|
+
SENSITIVE = []
|
1024
|
+
include Aws::Structure
|
1025
|
+
end
|
1026
|
+
|
1027
|
+
# The caller doesn't have the required KMS access.
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] message
|
1030
|
+
# @return [String]
|
1031
|
+
#
|
1032
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsAccessDenied AWS API Documentation
|
1033
|
+
#
|
1034
|
+
class KmsAccessDenied < Struct.new(
|
1035
|
+
:message)
|
1036
|
+
SENSITIVE = []
|
1037
|
+
include Aws::Structure
|
1038
|
+
end
|
1039
|
+
|
1040
|
+
# The request was denied due to request throttling.
|
1041
|
+
#
|
1042
|
+
# @!attribute [rw] message
|
1043
|
+
# @return [String]
|
1044
|
+
#
|
1045
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsDisabled AWS API Documentation
|
1046
|
+
#
|
1047
|
+
class KmsDisabled < Struct.new(
|
1048
|
+
:message)
|
1049
|
+
SENSITIVE = []
|
1050
|
+
include Aws::Structure
|
1051
|
+
end
|
1052
|
+
|
1053
|
+
# The request was rejected for one of the following reasons:
|
1054
|
+
#
|
1055
|
+
# * The KeyUsage value of the KMS key is incompatible with the API
|
1056
|
+
# operation.
|
1057
|
+
#
|
1058
|
+
# * The encryption algorithm or signing algorithm specified for the
|
1059
|
+
# operation is incompatible with the type of key material in the KMS
|
1060
|
+
# key (KeySpec).
|
1061
|
+
#
|
1062
|
+
# @!attribute [rw] message
|
1063
|
+
# @return [String]
|
1064
|
+
#
|
1065
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsInvalidKeyUsage AWS API Documentation
|
1066
|
+
#
|
1067
|
+
class KmsInvalidKeyUsage < Struct.new(
|
1068
|
+
:message)
|
1069
|
+
SENSITIVE = []
|
1070
|
+
include Aws::Structure
|
1071
|
+
end
|
1072
|
+
|
1073
|
+
# The request was rejected because the state of the specified resource
|
1074
|
+
# is not valid for this request.
|
1075
|
+
#
|
1076
|
+
# @!attribute [rw] message
|
1077
|
+
# @return [String]
|
1078
|
+
#
|
1079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsInvalidState AWS API Documentation
|
1080
|
+
#
|
1081
|
+
class KmsInvalidState < Struct.new(
|
1082
|
+
:message)
|
1083
|
+
SENSITIVE = []
|
1084
|
+
include Aws::Structure
|
1085
|
+
end
|
1086
|
+
|
1087
|
+
# The request was rejected because the specified entity or resource
|
1088
|
+
# could not be found.
|
1089
|
+
#
|
1090
|
+
# @!attribute [rw] message
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsNotFound AWS API Documentation
|
1094
|
+
#
|
1095
|
+
class KmsNotFound < Struct.new(
|
1096
|
+
:message)
|
1097
|
+
SENSITIVE = []
|
1098
|
+
include Aws::Structure
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
# The request was rejected because the specified key policy isn't
|
1102
|
+
# syntactically or semantically correct.
|
1103
|
+
#
|
1104
|
+
# @!attribute [rw] message
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsOptInRequired AWS API Documentation
|
1108
|
+
#
|
1109
|
+
class KmsOptInRequired < Struct.new(
|
1110
|
+
:message)
|
1111
|
+
SENSITIVE = []
|
1112
|
+
include Aws::Structure
|
1113
|
+
end
|
1114
|
+
|
1115
|
+
# Amazon Web Services KMS throttles requests for the following
|
1116
|
+
# conditions.
|
1117
|
+
#
|
1118
|
+
# @!attribute [rw] message
|
1119
|
+
# @return [String]
|
952
1120
|
#
|
953
|
-
#
|
954
|
-
# queue_url: "String", # required
|
955
|
-
# next_token: "Token",
|
956
|
-
# max_results: 1,
|
957
|
-
# }
|
1121
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsThrottled AWS API Documentation
|
958
1122
|
#
|
1123
|
+
class KmsThrottled < Struct.new(
|
1124
|
+
:message)
|
1125
|
+
SENSITIVE = []
|
1126
|
+
include Aws::Structure
|
1127
|
+
end
|
1128
|
+
|
959
1129
|
# @!attribute [rw] queue_url
|
960
1130
|
# The URL of a dead-letter queue.
|
961
1131
|
#
|
@@ -1004,13 +1174,107 @@ module Aws::SQS
|
|
1004
1174
|
include Aws::Structure
|
1005
1175
|
end
|
1006
1176
|
|
1007
|
-
#
|
1008
|
-
#
|
1177
|
+
# @!attribute [rw] source_arn
|
1178
|
+
# The ARN of the queue whose message movement tasks are to be listed.
|
1179
|
+
# @return [String]
|
1180
|
+
#
|
1181
|
+
# @!attribute [rw] max_results
|
1182
|
+
# The maximum number of results to include in the response. The
|
1183
|
+
# default is 1, which provides the most recent message movement task.
|
1184
|
+
# The upper limit is 10.
|
1185
|
+
# @return [Integer]
|
1186
|
+
#
|
1187
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksRequest AWS API Documentation
|
1188
|
+
#
|
1189
|
+
class ListMessageMoveTasksRequest < Struct.new(
|
1190
|
+
:source_arn,
|
1191
|
+
:max_results)
|
1192
|
+
SENSITIVE = []
|
1193
|
+
include Aws::Structure
|
1194
|
+
end
|
1195
|
+
|
1196
|
+
# @!attribute [rw] results
|
1197
|
+
# A list of message movement tasks and their attributes.
|
1198
|
+
# @return [Array<Types::ListMessageMoveTasksResultEntry>]
|
1199
|
+
#
|
1200
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksResult AWS API Documentation
|
1201
|
+
#
|
1202
|
+
class ListMessageMoveTasksResult < Struct.new(
|
1203
|
+
:results)
|
1204
|
+
SENSITIVE = []
|
1205
|
+
include Aws::Structure
|
1206
|
+
end
|
1207
|
+
|
1208
|
+
# Contains the details of a message movement task.
|
1209
|
+
#
|
1210
|
+
# @!attribute [rw] task_handle
|
1211
|
+
# An identifier associated with a message movement task. When this
|
1212
|
+
# field is returned in the response of the `ListMessageMoveTasks`
|
1213
|
+
# action, it is only populated for tasks that are in RUNNING status.
|
1214
|
+
# @return [String]
|
1009
1215
|
#
|
1010
|
-
#
|
1011
|
-
#
|
1012
|
-
#
|
1216
|
+
# @!attribute [rw] status
|
1217
|
+
# The status of the message movement task. Possible values are:
|
1218
|
+
# RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.
|
1219
|
+
# @return [String]
|
1013
1220
|
#
|
1221
|
+
# @!attribute [rw] source_arn
|
1222
|
+
# The ARN of the queue that contains the messages to be moved to
|
1223
|
+
# another queue.
|
1224
|
+
# @return [String]
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] destination_arn
|
1227
|
+
# The ARN of the destination queue if it has been specified in the
|
1228
|
+
# `StartMessageMoveTask` request. If a `DestinationArn` has not been
|
1229
|
+
# specified in the `StartMessageMoveTask` request, this field value
|
1230
|
+
# will be NULL.
|
1231
|
+
# @return [String]
|
1232
|
+
#
|
1233
|
+
# @!attribute [rw] max_number_of_messages_per_second
|
1234
|
+
# The number of messages to be moved per second (the message movement
|
1235
|
+
# rate), if it has been specified in the `StartMessageMoveTask`
|
1236
|
+
# request. If a `MaxNumberOfMessagesPerSecond` has not been specified
|
1237
|
+
# in the `StartMessageMoveTask` request, this field value will be
|
1238
|
+
# NULL.
|
1239
|
+
# @return [Integer]
|
1240
|
+
#
|
1241
|
+
# @!attribute [rw] approximate_number_of_messages_moved
|
1242
|
+
# The approximate number of messages already moved to the destination
|
1243
|
+
# queue.
|
1244
|
+
# @return [Integer]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] approximate_number_of_messages_to_move
|
1247
|
+
# The number of messages to be moved from the source queue. This
|
1248
|
+
# number is obtained at the time of starting the message movement task
|
1249
|
+
# and is only included after the message movement task is selected to
|
1250
|
+
# start.
|
1251
|
+
# @return [Integer]
|
1252
|
+
#
|
1253
|
+
# @!attribute [rw] failure_reason
|
1254
|
+
# The task failure reason (only included if the task status is
|
1255
|
+
# FAILED).
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] started_timestamp
|
1259
|
+
# The timestamp of starting the message movement task.
|
1260
|
+
# @return [Integer]
|
1261
|
+
#
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksResultEntry AWS API Documentation
|
1263
|
+
#
|
1264
|
+
class ListMessageMoveTasksResultEntry < Struct.new(
|
1265
|
+
:task_handle,
|
1266
|
+
:status,
|
1267
|
+
:source_arn,
|
1268
|
+
:destination_arn,
|
1269
|
+
:max_number_of_messages_per_second,
|
1270
|
+
:approximate_number_of_messages_moved,
|
1271
|
+
:approximate_number_of_messages_to_move,
|
1272
|
+
:failure_reason,
|
1273
|
+
:started_timestamp)
|
1274
|
+
SENSITIVE = []
|
1275
|
+
include Aws::Structure
|
1276
|
+
end
|
1277
|
+
|
1014
1278
|
# @!attribute [rw] queue_url
|
1015
1279
|
# The URL of the queue.
|
1016
1280
|
# @return [String]
|
@@ -1035,15 +1299,6 @@ module Aws::SQS
|
|
1035
1299
|
include Aws::Structure
|
1036
1300
|
end
|
1037
1301
|
|
1038
|
-
# @note When making an API call, you may pass ListQueuesRequest
|
1039
|
-
# data as a hash:
|
1040
|
-
#
|
1041
|
-
# {
|
1042
|
-
# queue_name_prefix: "String",
|
1043
|
-
# next_token: "Token",
|
1044
|
-
# max_results: 1,
|
1045
|
-
# }
|
1046
|
-
#
|
1047
1302
|
# @!attribute [rw] queue_name_prefix
|
1048
1303
|
# A string to use for filtering the list results. Only those queues
|
1049
1304
|
# whose name begins with the specified string are returned.
|
@@ -1075,7 +1330,7 @@ module Aws::SQS
|
|
1075
1330
|
#
|
1076
1331
|
# @!attribute [rw] queue_urls
|
1077
1332
|
# A list of queue URLs, up to 1,000 entries, or the value of
|
1078
|
-
# MaxResults that you sent in the request.
|
1333
|
+
# `MaxResults` that you sent in the request.
|
1079
1334
|
# @return [Array<String>]
|
1080
1335
|
#
|
1081
1336
|
# @!attribute [rw] next_token
|
@@ -1097,7 +1352,8 @@ module Aws::SQS
|
|
1097
1352
|
#
|
1098
1353
|
# @!attribute [rw] message_id
|
1099
1354
|
# A unique identifier for the message. A `MessageId`is considered
|
1100
|
-
# unique across all
|
1355
|
+
# unique across all Amazon Web Services accounts for an extended
|
1356
|
+
# period of time.
|
1101
1357
|
# @return [String]
|
1102
1358
|
#
|
1103
1359
|
# @!attribute [rw] receipt_handle
|
@@ -1156,8 +1412,8 @@ module Aws::SQS
|
|
1156
1412
|
#
|
1157
1413
|
# @!attribute [rw] message_attributes
|
1158
1414
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
1159
|
-
# For more information, see [Amazon SQS
|
1160
|
-
# *Amazon
|
1415
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
1416
|
+
# *Amazon SQS Developer Guide*.
|
1161
1417
|
#
|
1162
1418
|
#
|
1163
1419
|
#
|
@@ -1184,20 +1440,9 @@ module Aws::SQS
|
|
1184
1440
|
#
|
1185
1441
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1186
1442
|
# null. All parts of the message attribute, including `Name`, `Type`,
|
1187
|
-
# and `Value`, are part of the message size restriction (256
|
1443
|
+
# and `Value`, are part of the message size restriction (256 KiB or
|
1188
1444
|
# 262,144 bytes).
|
1189
1445
|
#
|
1190
|
-
# @note When making an API call, you may pass MessageAttributeValue
|
1191
|
-
# data as a hash:
|
1192
|
-
#
|
1193
|
-
# {
|
1194
|
-
# string_value: "String",
|
1195
|
-
# binary_value: "data",
|
1196
|
-
# string_list_values: ["String"],
|
1197
|
-
# binary_list_values: ["data"],
|
1198
|
-
# data_type: "String", # required
|
1199
|
-
# }
|
1200
|
-
#
|
1201
1446
|
# @!attribute [rw] string_value
|
1202
1447
|
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1203
1448
|
# values, see [ASCII Printable Characters][1].
|
@@ -1226,8 +1471,7 @@ module Aws::SQS
|
|
1226
1471
|
# `StringValue`.
|
1227
1472
|
#
|
1228
1473
|
# You can also append custom labels. For more information, see [Amazon
|
1229
|
-
# SQS Message Attributes][1] in the *Amazon
|
1230
|
-
# Developer Guide*.
|
1474
|
+
# SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
|
1231
1475
|
#
|
1232
1476
|
#
|
1233
1477
|
#
|
@@ -1259,17 +1503,6 @@ module Aws::SQS
|
|
1259
1503
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1260
1504
|
# null.
|
1261
1505
|
#
|
1262
|
-
# @note When making an API call, you may pass MessageSystemAttributeValue
|
1263
|
-
# data as a hash:
|
1264
|
-
#
|
1265
|
-
# {
|
1266
|
-
# string_value: "String",
|
1267
|
-
# binary_value: "data",
|
1268
|
-
# string_list_values: ["String"],
|
1269
|
-
# binary_list_values: ["data"],
|
1270
|
-
# data_type: "String", # required
|
1271
|
-
# }
|
1272
|
-
#
|
1273
1506
|
# @!attribute [rw] string_value
|
1274
1507
|
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1275
1508
|
# values, see [ASCII Printable Characters][1].
|
@@ -1298,8 +1531,7 @@ module Aws::SQS
|
|
1298
1531
|
# `StringValue`.
|
1299
1532
|
#
|
1300
1533
|
# You can also append custom labels. For more information, see [Amazon
|
1301
|
-
# SQS Message Attributes][1] in the *Amazon
|
1302
|
-
# Developer Guide*.
|
1534
|
+
# SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
|
1303
1535
|
#
|
1304
1536
|
#
|
1305
1537
|
#
|
@@ -1319,29 +1551,36 @@ module Aws::SQS
|
|
1319
1551
|
end
|
1320
1552
|
|
1321
1553
|
# The specified action violates a limit. For example, `ReceiveMessage`
|
1322
|
-
# returns this error if the maximum number of
|
1554
|
+
# returns this error if the maximum number of in flight messages is
|
1323
1555
|
# reached and `AddPermission` returns this error if the maximum number
|
1324
1556
|
# of permissions for the queue is reached.
|
1325
1557
|
#
|
1558
|
+
# @!attribute [rw] message
|
1559
|
+
# @return [String]
|
1560
|
+
#
|
1326
1561
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/OverLimit AWS API Documentation
|
1327
1562
|
#
|
1328
|
-
class OverLimit <
|
1563
|
+
class OverLimit < Struct.new(
|
1564
|
+
:message)
|
1565
|
+
SENSITIVE = []
|
1566
|
+
include Aws::Structure
|
1567
|
+
end
|
1329
1568
|
|
1330
1569
|
# Indicates that the specified queue previously received a `PurgeQueue`
|
1331
1570
|
# request within the last 60 seconds (the time it can take to delete the
|
1332
1571
|
# messages in the queue).
|
1333
1572
|
#
|
1573
|
+
# @!attribute [rw] message
|
1574
|
+
# @return [String]
|
1575
|
+
#
|
1334
1576
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueInProgress AWS API Documentation
|
1335
1577
|
#
|
1336
|
-
class PurgeQueueInProgress <
|
1578
|
+
class PurgeQueueInProgress < Struct.new(
|
1579
|
+
:message)
|
1580
|
+
SENSITIVE = []
|
1581
|
+
include Aws::Structure
|
1582
|
+
end
|
1337
1583
|
|
1338
|
-
# @note When making an API call, you may pass PurgeQueueRequest
|
1339
|
-
# data as a hash:
|
1340
|
-
#
|
1341
|
-
# {
|
1342
|
-
# queue_url: "String", # required
|
1343
|
-
# }
|
1344
|
-
#
|
1345
1584
|
# @!attribute [rw] queue_url
|
1346
1585
|
# The URL of the queue from which the `PurgeQueue` action deletes
|
1347
1586
|
# messages.
|
@@ -1360,43 +1599,58 @@ module Aws::SQS
|
|
1360
1599
|
# You must wait 60 seconds after deleting a queue before you can create
|
1361
1600
|
# another queue with the same name.
|
1362
1601
|
#
|
1602
|
+
# @!attribute [rw] message
|
1603
|
+
# @return [String]
|
1604
|
+
#
|
1363
1605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDeletedRecently AWS API Documentation
|
1364
1606
|
#
|
1365
|
-
class QueueDeletedRecently <
|
1607
|
+
class QueueDeletedRecently < Struct.new(
|
1608
|
+
:message)
|
1609
|
+
SENSITIVE = []
|
1610
|
+
include Aws::Structure
|
1611
|
+
end
|
1366
1612
|
|
1367
1613
|
# The specified queue doesn't exist.
|
1368
1614
|
#
|
1615
|
+
# @!attribute [rw] message
|
1616
|
+
# @return [String]
|
1617
|
+
#
|
1369
1618
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDoesNotExist AWS API Documentation
|
1370
1619
|
#
|
1371
|
-
class QueueDoesNotExist <
|
1620
|
+
class QueueDoesNotExist < Struct.new(
|
1621
|
+
:message)
|
1622
|
+
SENSITIVE = []
|
1623
|
+
include Aws::Structure
|
1624
|
+
end
|
1372
1625
|
|
1373
1626
|
# A queue with this name already exists. Amazon SQS returns this error
|
1374
1627
|
# only if the request includes attributes whose values differ from those
|
1375
1628
|
# of the existing queue.
|
1376
1629
|
#
|
1630
|
+
# @!attribute [rw] message
|
1631
|
+
# @return [String]
|
1632
|
+
#
|
1377
1633
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueNameExists AWS API Documentation
|
1378
1634
|
#
|
1379
|
-
class QueueNameExists <
|
1635
|
+
class QueueNameExists < Struct.new(
|
1636
|
+
:message)
|
1637
|
+
SENSITIVE = []
|
1638
|
+
include Aws::Structure
|
1639
|
+
end
|
1380
1640
|
|
1381
1641
|
# The specified receipt handle isn't valid.
|
1382
1642
|
#
|
1643
|
+
# @!attribute [rw] message
|
1644
|
+
# @return [String]
|
1645
|
+
#
|
1383
1646
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiptHandleIsInvalid AWS API Documentation
|
1384
1647
|
#
|
1385
|
-
class ReceiptHandleIsInvalid <
|
1648
|
+
class ReceiptHandleIsInvalid < Struct.new(
|
1649
|
+
:message)
|
1650
|
+
SENSITIVE = []
|
1651
|
+
include Aws::Structure
|
1652
|
+
end
|
1386
1653
|
|
1387
|
-
# @note When making an API call, you may pass ReceiveMessageRequest
|
1388
|
-
# data as a hash:
|
1389
|
-
#
|
1390
|
-
# {
|
1391
|
-
# queue_url: "String", # required
|
1392
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
1393
|
-
# message_attribute_names: ["MessageAttributeName"],
|
1394
|
-
# max_number_of_messages: 1,
|
1395
|
-
# visibility_timeout: 1,
|
1396
|
-
# wait_time_seconds: 1,
|
1397
|
-
# receive_request_attempt_id: "String",
|
1398
|
-
# }
|
1399
|
-
#
|
1400
1654
|
# @!attribute [rw] queue_url
|
1401
1655
|
# The URL of the Amazon SQS queue from which messages are received.
|
1402
1656
|
#
|
@@ -1404,6 +1658,10 @@ module Aws::SQS
|
|
1404
1658
|
# @return [String]
|
1405
1659
|
#
|
1406
1660
|
# @!attribute [rw] attribute_names
|
1661
|
+
# This parameter has been deprecated but will be supported for
|
1662
|
+
# backward compatibility. To provide attribute names, you are
|
1663
|
+
# encouraged to use `MessageSystemAttributeNames`.
|
1664
|
+
#
|
1407
1665
|
# A list of attributes that need to be returned along with each
|
1408
1666
|
# message. These attributes include:
|
1409
1667
|
#
|
@@ -1416,11 +1674,11 @@ module Aws::SQS
|
|
1416
1674
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1417
1675
|
# has been received across all queues but not deleted.
|
1418
1676
|
#
|
1419
|
-
# * `AWSTraceHeader` – Returns the
|
1677
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1420
1678
|
#
|
1421
1679
|
# * `SenderId`
|
1422
1680
|
#
|
1423
|
-
# * For
|
1681
|
+
# * For a user, returns the user ID, for example
|
1424
1682
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1425
1683
|
#
|
1426
1684
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1429,6 +1687,11 @@ module Aws::SQS
|
|
1429
1687
|
# * `SentTimestamp` – Returns the time the message was sent to the
|
1430
1688
|
# queue ([epoch time][1] in milliseconds).
|
1431
1689
|
#
|
1690
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1691
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
1692
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1693
|
+
# [SSE-SQS][3]).
|
1694
|
+
#
|
1432
1695
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1433
1696
|
# producer that calls the ` SendMessage ` action.
|
1434
1697
|
#
|
@@ -1441,6 +1704,55 @@ module Aws::SQS
|
|
1441
1704
|
#
|
1442
1705
|
#
|
1443
1706
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1707
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1708
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1709
|
+
# @return [Array<String>]
|
1710
|
+
#
|
1711
|
+
# @!attribute [rw] message_system_attribute_names
|
1712
|
+
# A list of attributes that need to be returned along with each
|
1713
|
+
# message. These attributes include:
|
1714
|
+
#
|
1715
|
+
# * `All` – Returns all values.
|
1716
|
+
#
|
1717
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1718
|
+
# was first received from the queue ([epoch time][1] in
|
1719
|
+
# milliseconds).
|
1720
|
+
#
|
1721
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1722
|
+
# has been received across all queues but not deleted.
|
1723
|
+
#
|
1724
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1725
|
+
#
|
1726
|
+
# * `SenderId`
|
1727
|
+
#
|
1728
|
+
# * For a user, returns the user ID, for example
|
1729
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1730
|
+
#
|
1731
|
+
# * For an IAM role, returns the IAM role ID, for example
|
1732
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1733
|
+
#
|
1734
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1735
|
+
# queue ([epoch time][1] in milliseconds).
|
1736
|
+
#
|
1737
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1738
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
1739
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1740
|
+
# [SSE-SQS][3]).
|
1741
|
+
#
|
1742
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1743
|
+
# producer that calls the ` SendMessage ` action.
|
1744
|
+
#
|
1745
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1746
|
+
# calls the ` SendMessage ` action. Messages with the same
|
1747
|
+
# `MessageGroupId` are returned in sequence.
|
1748
|
+
#
|
1749
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1750
|
+
#
|
1751
|
+
#
|
1752
|
+
#
|
1753
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1754
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1755
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1444
1756
|
# @return [Array<String>]
|
1445
1757
|
#
|
1446
1758
|
# @!attribute [rw] message_attribute_names
|
@@ -1482,8 +1794,8 @@ module Aws::SQS
|
|
1482
1794
|
# The duration (in seconds) for which the call waits for a message to
|
1483
1795
|
# arrive in the queue before returning. If a message is available, the
|
1484
1796
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1485
|
-
# available and the wait time expires, the call
|
1486
|
-
#
|
1797
|
+
# available and the wait time expires, the call does not return a
|
1798
|
+
# message list.
|
1487
1799
|
#
|
1488
1800
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1489
1801
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1514,10 +1826,6 @@ module Aws::SQS
|
|
1514
1826
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
1515
1827
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
1516
1828
|
#
|
1517
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
1518
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1519
|
-
# `ReceiveRequestAttemptId`.
|
1520
|
-
#
|
1521
1829
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
1522
1830
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1523
1831
|
# modified (deleted or had their visibility changes).
|
@@ -1526,8 +1834,7 @@ module Aws::SQS
|
|
1526
1834
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
1527
1835
|
# handles. If a retry occurs within the deduplication interval, it
|
1528
1836
|
# resets the visibility timeout. For more information, see
|
1529
|
-
# [Visibility Timeout][1] in the *Amazon
|
1530
|
-
# Developer Guide*.
|
1837
|
+
# [Visibility Timeout][1] in the *Amazon SQS Developer Guide*.
|
1531
1838
|
#
|
1532
1839
|
# If a caller of the `ReceiveMessage` action still processes
|
1533
1840
|
# messages when the visibility timeout expires and messages become
|
@@ -1558,8 +1865,8 @@ module Aws::SQS
|
|
1558
1865
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
1559
1866
|
#
|
1560
1867
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using
|
1561
|
-
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
1562
|
-
#
|
1868
|
+
# the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
1869
|
+
# Developer Guide*.
|
1563
1870
|
#
|
1564
1871
|
#
|
1565
1872
|
#
|
@@ -1572,6 +1879,7 @@ module Aws::SQS
|
|
1572
1879
|
class ReceiveMessageRequest < Struct.new(
|
1573
1880
|
:queue_url,
|
1574
1881
|
:attribute_names,
|
1882
|
+
:message_system_attribute_names,
|
1575
1883
|
:message_attribute_names,
|
1576
1884
|
:max_number_of_messages,
|
1577
1885
|
:visibility_timeout,
|
@@ -1595,14 +1903,6 @@ module Aws::SQS
|
|
1595
1903
|
include Aws::Structure
|
1596
1904
|
end
|
1597
1905
|
|
1598
|
-
# @note When making an API call, you may pass RemovePermissionRequest
|
1599
|
-
# data as a hash:
|
1600
|
-
#
|
1601
|
-
# {
|
1602
|
-
# queue_url: "String", # required
|
1603
|
-
# label: "String", # required
|
1604
|
-
# }
|
1605
|
-
#
|
1606
1906
|
# @!attribute [rw] queue_url
|
1607
1907
|
# The URL of the Amazon SQS queue from which permissions are removed.
|
1608
1908
|
#
|
@@ -1623,40 +1923,45 @@ module Aws::SQS
|
|
1623
1923
|
include Aws::Structure
|
1624
1924
|
end
|
1625
1925
|
|
1626
|
-
#
|
1627
|
-
#
|
1628
|
-
#
|
1629
|
-
#
|
1630
|
-
#
|
1631
|
-
#
|
1632
|
-
#
|
1633
|
-
# id: "String", # required
|
1634
|
-
# message_body: "String", # required
|
1635
|
-
# delay_seconds: 1,
|
1636
|
-
# message_attributes: {
|
1637
|
-
# "String" => {
|
1638
|
-
# string_value: "String",
|
1639
|
-
# binary_value: "data",
|
1640
|
-
# string_list_values: ["String"],
|
1641
|
-
# binary_list_values: ["data"],
|
1642
|
-
# data_type: "String", # required
|
1643
|
-
# },
|
1644
|
-
# },
|
1645
|
-
# message_system_attributes: {
|
1646
|
-
# "AWSTraceHeader" => {
|
1647
|
-
# string_value: "String",
|
1648
|
-
# binary_value: "data",
|
1649
|
-
# string_list_values: ["String"],
|
1650
|
-
# binary_list_values: ["data"],
|
1651
|
-
# data_type: "String", # required
|
1652
|
-
# },
|
1653
|
-
# },
|
1654
|
-
# message_deduplication_id: "String",
|
1655
|
-
# message_group_id: "String",
|
1656
|
-
# },
|
1657
|
-
# ],
|
1658
|
-
# }
|
1926
|
+
# The request was denied due to request throttling.
|
1927
|
+
#
|
1928
|
+
# * The rate of requests per second exceeds the Amazon Web Services KMS
|
1929
|
+
# request quota for an account and Region.
|
1930
|
+
#
|
1931
|
+
# * A burst or sustained high rate of requests to change the state of
|
1932
|
+
# the same KMS key. This condition is often known as a "hot key."
|
1659
1933
|
#
|
1934
|
+
# * Requests for operations on KMS keys in a Amazon Web Services
|
1935
|
+
# CloudHSM key store might be throttled at a lower-than-expected rate
|
1936
|
+
# when the Amazon Web Services CloudHSM cluster associated with the
|
1937
|
+
# Amazon Web Services CloudHSM key store is processing numerous
|
1938
|
+
# commands, including those unrelated to the Amazon Web Services
|
1939
|
+
# CloudHSM key store.
|
1940
|
+
#
|
1941
|
+
# @!attribute [rw] message
|
1942
|
+
# @return [String]
|
1943
|
+
#
|
1944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RequestThrottled AWS API Documentation
|
1945
|
+
#
|
1946
|
+
class RequestThrottled < Struct.new(
|
1947
|
+
:message)
|
1948
|
+
SENSITIVE = []
|
1949
|
+
include Aws::Structure
|
1950
|
+
end
|
1951
|
+
|
1952
|
+
# One or more specified resources don't exist.
|
1953
|
+
#
|
1954
|
+
# @!attribute [rw] message
|
1955
|
+
# @return [String]
|
1956
|
+
#
|
1957
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ResourceNotFoundException AWS API Documentation
|
1958
|
+
#
|
1959
|
+
class ResourceNotFoundException < Struct.new(
|
1960
|
+
:message)
|
1961
|
+
SENSITIVE = []
|
1962
|
+
include Aws::Structure
|
1963
|
+
end
|
1964
|
+
|
1660
1965
|
# @!attribute [rw] queue_url
|
1661
1966
|
# The URL of the Amazon SQS queue to which batched messages are sent.
|
1662
1967
|
#
|
@@ -1679,35 +1984,6 @@ module Aws::SQS
|
|
1679
1984
|
# Contains the details of a single Amazon SQS message along with an
|
1680
1985
|
# `Id`.
|
1681
1986
|
#
|
1682
|
-
# @note When making an API call, you may pass SendMessageBatchRequestEntry
|
1683
|
-
# data as a hash:
|
1684
|
-
#
|
1685
|
-
# {
|
1686
|
-
# id: "String", # required
|
1687
|
-
# message_body: "String", # required
|
1688
|
-
# delay_seconds: 1,
|
1689
|
-
# message_attributes: {
|
1690
|
-
# "String" => {
|
1691
|
-
# string_value: "String",
|
1692
|
-
# binary_value: "data",
|
1693
|
-
# string_list_values: ["String"],
|
1694
|
-
# binary_list_values: ["data"],
|
1695
|
-
# data_type: "String", # required
|
1696
|
-
# },
|
1697
|
-
# },
|
1698
|
-
# message_system_attributes: {
|
1699
|
-
# "AWSTraceHeader" => {
|
1700
|
-
# string_value: "String",
|
1701
|
-
# binary_value: "data",
|
1702
|
-
# string_list_values: ["String"],
|
1703
|
-
# binary_list_values: ["data"],
|
1704
|
-
# data_type: "String", # required
|
1705
|
-
# },
|
1706
|
-
# },
|
1707
|
-
# message_deduplication_id: "String",
|
1708
|
-
# message_group_id: "String",
|
1709
|
-
# }
|
1710
|
-
#
|
1711
1987
|
# @!attribute [rw] id
|
1712
1988
|
# An identifier for a message in this batch used to communicate the
|
1713
1989
|
# result.
|
@@ -1740,8 +2016,8 @@ module Aws::SQS
|
|
1740
2016
|
#
|
1741
2017
|
# @!attribute [rw] message_attributes
|
1742
2018
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
1743
|
-
# For more information, see [Amazon SQS
|
1744
|
-
# *Amazon
|
2019
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
2020
|
+
# *Amazon SQS Developer Guide*.
|
1745
2021
|
#
|
1746
2022
|
#
|
1747
2023
|
#
|
@@ -1754,7 +2030,7 @@ module Aws::SQS
|
|
1754
2030
|
#
|
1755
2031
|
# * Currently, the only supported message system attribute is
|
1756
2032
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1757
|
-
# a correctly formatted
|
2033
|
+
# a correctly formatted X-Ray trace header string.
|
1758
2034
|
#
|
1759
2035
|
# * The size of a message system attribute doesn't count towards the
|
1760
2036
|
# total size of a message.
|
@@ -1768,7 +2044,7 @@ module Aws::SQS
|
|
1768
2044
|
# `MessageDeduplicationId` is sent successfully, subsequent messages
|
1769
2045
|
# with the same `MessageDeduplicationId` are accepted successfully but
|
1770
2046
|
# aren't delivered. For more information, see [ Exactly-once
|
1771
|
-
# processing][1] in the *Amazon
|
2047
|
+
# processing][1] in the *Amazon SQS Developer Guide*.
|
1772
2048
|
#
|
1773
2049
|
# * Every message must have a unique `MessageDeduplicationId`,
|
1774
2050
|
#
|
@@ -1817,8 +2093,8 @@ module Aws::SQS
|
|
1817
2093
|
# ``).
|
1818
2094
|
#
|
1819
2095
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
1820
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
1821
|
-
#
|
2096
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
2097
|
+
# Guide*.
|
1822
2098
|
#
|
1823
2099
|
#
|
1824
2100
|
#
|
@@ -1851,8 +2127,7 @@ module Aws::SQS
|
|
1851
2127
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1852
2128
|
#
|
1853
2129
|
# For best practices of using `MessageGroupId`, see [Using the
|
1854
|
-
# MessageGroupId Property][1] in the *Amazon
|
1855
|
-
# Developer Guide*.
|
2130
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
1856
2131
|
#
|
1857
2132
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
1858
2133
|
# Standard queues.
|
@@ -1967,35 +2242,6 @@ module Aws::SQS
|
|
1967
2242
|
include Aws::Structure
|
1968
2243
|
end
|
1969
2244
|
|
1970
|
-
# @note When making an API call, you may pass SendMessageRequest
|
1971
|
-
# data as a hash:
|
1972
|
-
#
|
1973
|
-
# {
|
1974
|
-
# queue_url: "String", # required
|
1975
|
-
# message_body: "String", # required
|
1976
|
-
# delay_seconds: 1,
|
1977
|
-
# message_attributes: {
|
1978
|
-
# "String" => {
|
1979
|
-
# string_value: "String",
|
1980
|
-
# binary_value: "data",
|
1981
|
-
# string_list_values: ["String"],
|
1982
|
-
# binary_list_values: ["data"],
|
1983
|
-
# data_type: "String", # required
|
1984
|
-
# },
|
1985
|
-
# },
|
1986
|
-
# message_system_attributes: {
|
1987
|
-
# "AWSTraceHeader" => {
|
1988
|
-
# string_value: "String",
|
1989
|
-
# binary_value: "data",
|
1990
|
-
# string_list_values: ["String"],
|
1991
|
-
# binary_list_values: ["data"],
|
1992
|
-
# data_type: "String", # required
|
1993
|
-
# },
|
1994
|
-
# },
|
1995
|
-
# message_deduplication_id: "String",
|
1996
|
-
# message_group_id: "String",
|
1997
|
-
# }
|
1998
|
-
#
|
1999
2245
|
# @!attribute [rw] queue_url
|
2000
2246
|
# The URL of the Amazon SQS queue to which a message is sent.
|
2001
2247
|
#
|
@@ -2004,16 +2250,20 @@ module Aws::SQS
|
|
2004
2250
|
#
|
2005
2251
|
# @!attribute [rw] message_body
|
2006
2252
|
# The message to send. The minimum size is one character. The maximum
|
2007
|
-
# size is 256
|
2253
|
+
# size is 256 KiB.
|
2008
2254
|
#
|
2009
2255
|
# A message can include only XML, JSON, and unformatted text. The
|
2010
|
-
# following Unicode characters are allowed
|
2256
|
+
# following Unicode characters are allowed. For more information, see
|
2257
|
+
# the [W3C specification for characters][1].
|
2011
2258
|
#
|
2012
2259
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to
|
2013
2260
|
# `#xFFFD` \| `#x10000` to `#x10FFFF`
|
2014
2261
|
#
|
2015
|
-
#
|
2016
|
-
#
|
2262
|
+
# Amazon SQS does not throw an exception or completely reject the
|
2263
|
+
# message if it contains invalid characters. Instead, it replaces
|
2264
|
+
# those invalid characters with `U+FFFD` before storing the message in
|
2265
|
+
# the queue, as long as the message body contains at least one valid
|
2266
|
+
# character.
|
2017
2267
|
#
|
2018
2268
|
#
|
2019
2269
|
#
|
@@ -2035,8 +2285,8 @@ module Aws::SQS
|
|
2035
2285
|
#
|
2036
2286
|
# @!attribute [rw] message_attributes
|
2037
2287
|
# Each message attribute consists of a `Name`, `Type`, and `Value`.
|
2038
|
-
# For more information, see [Amazon SQS
|
2039
|
-
# *Amazon
|
2288
|
+
# For more information, see [Amazon SQS message attributes][1] in the
|
2289
|
+
# *Amazon SQS Developer Guide*.
|
2040
2290
|
#
|
2041
2291
|
#
|
2042
2292
|
#
|
@@ -2049,7 +2299,7 @@ module Aws::SQS
|
|
2049
2299
|
#
|
2050
2300
|
# * Currently, the only supported message system attribute is
|
2051
2301
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
2052
|
-
# a correctly formatted
|
2302
|
+
# a correctly formatted X-Ray trace header string.
|
2053
2303
|
#
|
2054
2304
|
# * The size of a message system attribute doesn't count towards the
|
2055
2305
|
# total size of a message.
|
@@ -2063,7 +2313,7 @@ module Aws::SQS
|
|
2063
2313
|
# messages sent with the same `MessageDeduplicationId` are accepted
|
2064
2314
|
# successfully but aren't delivered during the 5-minute deduplication
|
2065
2315
|
# interval. For more information, see [ Exactly-once processing][1] in
|
2066
|
-
# the *Amazon
|
2316
|
+
# the *Amazon SQS Developer Guide*.
|
2067
2317
|
#
|
2068
2318
|
# * Every message must have a unique `MessageDeduplicationId`,
|
2069
2319
|
#
|
@@ -2112,8 +2362,8 @@ module Aws::SQS
|
|
2112
2362
|
# ``).
|
2113
2363
|
#
|
2114
2364
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
2115
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
2116
|
-
#
|
2365
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
2366
|
+
# Guide*.
|
2117
2367
|
#
|
2118
2368
|
#
|
2119
2369
|
#
|
@@ -2141,13 +2391,12 @@ module Aws::SQS
|
|
2141
2391
|
# are sorted by time sent. The caller can't specify a
|
2142
2392
|
# `MessageGroupId`.
|
2143
2393
|
#
|
2144
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
2145
|
-
# alphanumeric characters and punctuation ``
|
2394
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
2395
|
+
# values: alphanumeric characters and punctuation ``
|
2146
2396
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
2147
2397
|
#
|
2148
2398
|
# For best practices of using `MessageGroupId`, see [Using the
|
2149
|
-
# MessageGroupId Property][1] in the *Amazon
|
2150
|
-
# Developer Guide*.
|
2399
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2151
2400
|
#
|
2152
2401
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2153
2402
|
# Standard queues.
|
@@ -2206,7 +2455,7 @@ module Aws::SQS
|
|
2206
2455
|
# @!attribute [rw] message_id
|
2207
2456
|
# An attribute containing the `MessageId` of the message sent to the
|
2208
2457
|
# queue. For more information, see [Queue and Message Identifiers][1]
|
2209
|
-
# in the *Amazon
|
2458
|
+
# in the *Amazon SQS Developer Guide*.
|
2210
2459
|
#
|
2211
2460
|
#
|
2212
2461
|
#
|
@@ -2235,16 +2484,6 @@ module Aws::SQS
|
|
2235
2484
|
include Aws::Structure
|
2236
2485
|
end
|
2237
2486
|
|
2238
|
-
# @note When making an API call, you may pass SetQueueAttributesRequest
|
2239
|
-
# data as a hash:
|
2240
|
-
#
|
2241
|
-
# {
|
2242
|
-
# queue_url: "String", # required
|
2243
|
-
# attributes: { # required
|
2244
|
-
# "All" => "String",
|
2245
|
-
# },
|
2246
|
-
# }
|
2247
|
-
#
|
2248
2487
|
# @!attribute [rw] queue_url
|
2249
2488
|
# The URL of the Amazon SQS queue whose attributes are set.
|
2250
2489
|
#
|
@@ -2270,22 +2509,34 @@ module Aws::SQS
|
|
2270
2509
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2271
2510
|
# which Amazon SQS retains a message. Valid values: An integer
|
2272
2511
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2273
|
-
# Default: 345,600 (4 days).
|
2274
|
-
#
|
2275
|
-
#
|
2276
|
-
#
|
2277
|
-
#
|
2512
|
+
# Default: 345,600 (4 days). When you change a queue's attributes,
|
2513
|
+
# the change can take up to 60 seconds for most of the attributes to
|
2514
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
2515
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
2516
|
+
# will impact existing messages in the queue potentially causing
|
2517
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
2518
|
+
# reduced below the age of existing messages.
|
2519
|
+
#
|
2520
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2521
|
+
# policy. For more information about policy structure, see [Overview
|
2522
|
+
# of Amazon Web Services IAM Policies][1] in the *Identity and
|
2523
|
+
# Access Management User Guide*.
|
2278
2524
|
#
|
2279
2525
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2280
2526
|
# for which a ` ReceiveMessage ` action waits for a message to
|
2281
2527
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2282
2528
|
# 0.
|
2283
2529
|
#
|
2530
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2531
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2532
|
+
# Default: 30. For more information about the visibility timeout,
|
2533
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2534
|
+
#
|
2535
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2536
|
+
#
|
2284
2537
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2285
2538
|
# dead-letter queue functionality of the source queue as a JSON
|
2286
|
-
# object.
|
2287
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2288
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
2539
|
+
# object. The parameters are as follows:
|
2289
2540
|
#
|
2290
2541
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2291
2542
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2293,46 +2544,73 @@ module Aws::SQS
|
|
2293
2544
|
#
|
2294
2545
|
# * `maxReceiveCount` – The number of times a message is delivered
|
2295
2546
|
# to the source queue before being moved to the dead-letter queue.
|
2296
|
-
# When the `ReceiveCount` for a message exceeds the
|
2547
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2297
2548
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2298
2549
|
# the dead-letter-queue.
|
2299
2550
|
#
|
2300
|
-
#
|
2301
|
-
#
|
2302
|
-
# a
|
2551
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2552
|
+
# the permissions for the dead-letter queue redrive permission and
|
2553
|
+
# which source queues can specify dead-letter queues as a JSON
|
2554
|
+
# object. The parameters are as follows:
|
2303
2555
|
#
|
2304
|
-
#
|
2556
|
+
# * `redrivePermission` – The permission type that defines which
|
2557
|
+
# source queues can specify the current queue as the dead-letter
|
2558
|
+
# queue. Valid values are:
|
2305
2559
|
#
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
#
|
2309
|
-
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2310
|
-
# Developer Guide*.
|
2560
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2561
|
+
# Services account in the same Region can specify this queue as
|
2562
|
+
# the dead-letter queue.
|
2311
2563
|
#
|
2312
|
-
#
|
2564
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2565
|
+
# dead-letter queue.
|
2313
2566
|
#
|
2314
|
-
#
|
2315
|
-
#
|
2316
|
-
#
|
2317
|
-
#
|
2318
|
-
#
|
2319
|
-
#
|
2567
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2568
|
+
# parameter can specify this queue as the dead-letter queue.
|
2569
|
+
#
|
2570
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2571
|
+
# source queues that can specify this queue as the dead-letter
|
2572
|
+
# queue and redrive messages. You can specify this parameter only
|
2573
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2574
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
2575
|
+
# source queues to specify dead-letter queues, set the
|
2576
|
+
# `redrivePermission` parameter to `allowAll`.
|
2577
|
+
#
|
2578
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2579
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2580
|
+
# standard queue.
|
2581
|
+
#
|
2582
|
+
# </note>
|
2583
|
+
#
|
2584
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
2585
|
+
#
|
2586
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
2587
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
2588
|
+
# information, see [Key Terms][5]. While the alias of the
|
2589
|
+
# AWS-managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
2590
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
2591
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
2592
|
+
# Reference*.
|
2320
2593
|
#
|
2321
2594
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
2322
2595
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
2323
|
-
# decrypt messages before calling
|
2324
|
-
#
|
2325
|
-
#
|
2326
|
-
#
|
2327
|
-
#
|
2328
|
-
#
|
2596
|
+
# decrypt messages before calling KMS again. An integer representing
|
2597
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
2598
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
2599
|
+
# better security but results in more calls to KMS which might incur
|
2600
|
+
# charges after Free Tier. For more information, see [How Does the
|
2601
|
+
# Data Key Reuse Period Work?][8].
|
2602
|
+
#
|
2603
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
2604
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
2605
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
2606
|
+
# [SSE-SQS][10]).
|
2329
2607
|
#
|
2330
2608
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2331
|
-
# queues][
|
2609
|
+
# queues][11]:
|
2332
2610
|
#
|
2333
2611
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2334
|
-
# For more information, see [Exactly-once processing][
|
2335
|
-
# *Amazon
|
2612
|
+
# For more information, see [Exactly-once processing][12] in the
|
2613
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
2336
2614
|
#
|
2337
2615
|
# * Every message must have a unique `MessageDeduplicationId`.
|
2338
2616
|
#
|
@@ -2363,7 +2641,7 @@ module Aws::SQS
|
|
2363
2641
|
# duplicates and only one copy of the message is delivered.
|
2364
2642
|
#
|
2365
2643
|
# The following attributes apply only to [high throughput for FIFO
|
2366
|
-
# queues][
|
2644
|
+
# queues][13]:
|
2367
2645
|
#
|
2368
2646
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2369
2647
|
# occurs at the message group or queue level. Valid values are
|
@@ -2386,22 +2664,24 @@ module Aws::SQS
|
|
2386
2664
|
# deduplication occurs as specified.
|
2387
2665
|
#
|
2388
2666
|
# For information on throughput quotas, see [Quotas related to
|
2389
|
-
# messages][
|
2667
|
+
# messages][14] in the *Amazon SQS Developer Guide*.
|
2390
2668
|
#
|
2391
2669
|
#
|
2392
2670
|
#
|
2393
2671
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2394
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2395
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2672
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2673
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2396
2674
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2397
2675
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2398
2676
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
2399
2677
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
2400
2678
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2401
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2402
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2403
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2404
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2679
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
2680
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
2681
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2682
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
2683
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2684
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2405
2685
|
# @return [Hash<String,String>]
|
2406
2686
|
#
|
2407
2687
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation
|
@@ -2413,16 +2693,54 @@ module Aws::SQS
|
|
2413
2693
|
include Aws::Structure
|
2414
2694
|
end
|
2415
2695
|
|
2416
|
-
#
|
2417
|
-
#
|
2696
|
+
# @!attribute [rw] source_arn
|
2697
|
+
# The ARN of the queue that contains the messages to be moved to
|
2698
|
+
# another queue. Currently, only ARNs of dead-letter queues (DLQs)
|
2699
|
+
# whose sources are other Amazon SQS queues are accepted. DLQs whose
|
2700
|
+
# sources are non-SQS queues, such as Lambda or Amazon SNS topics, are
|
2701
|
+
# not currently supported.
|
2702
|
+
# @return [String]
|
2703
|
+
#
|
2704
|
+
# @!attribute [rw] destination_arn
|
2705
|
+
# The ARN of the queue that receives the moved messages. You can use
|
2706
|
+
# this field to specify the destination queue where you would like to
|
2707
|
+
# redrive messages. If this field is left blank, the messages will be
|
2708
|
+
# redriven back to their respective original source queues.
|
2709
|
+
# @return [String]
|
2710
|
+
#
|
2711
|
+
# @!attribute [rw] max_number_of_messages_per_second
|
2712
|
+
# The number of messages to be moved per second (the message movement
|
2713
|
+
# rate). You can use this field to define a fixed message movement
|
2714
|
+
# rate. The maximum value for messages per second is 500. If this
|
2715
|
+
# field is left blank, the system will optimize the rate based on the
|
2716
|
+
# queue message backlog size, which may vary throughout the duration
|
2717
|
+
# of the message movement task.
|
2718
|
+
# @return [Integer]
|
2719
|
+
#
|
2720
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTaskRequest AWS API Documentation
|
2721
|
+
#
|
2722
|
+
class StartMessageMoveTaskRequest < Struct.new(
|
2723
|
+
:source_arn,
|
2724
|
+
:destination_arn,
|
2725
|
+
:max_number_of_messages_per_second)
|
2726
|
+
SENSITIVE = []
|
2727
|
+
include Aws::Structure
|
2728
|
+
end
|
2729
|
+
|
2730
|
+
# @!attribute [rw] task_handle
|
2731
|
+
# An identifier associated with a message movement task. You can use
|
2732
|
+
# this identifier to cancel a specified message movement task using
|
2733
|
+
# the `CancelMessageMoveTask` action.
|
2734
|
+
# @return [String]
|
2418
2735
|
#
|
2419
|
-
#
|
2420
|
-
# queue_url: "String", # required
|
2421
|
-
# tags: { # required
|
2422
|
-
# "TagKey" => "TagValue",
|
2423
|
-
# },
|
2424
|
-
# }
|
2736
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTaskResult AWS API Documentation
|
2425
2737
|
#
|
2738
|
+
class StartMessageMoveTaskResult < Struct.new(
|
2739
|
+
:task_handle)
|
2740
|
+
SENSITIVE = []
|
2741
|
+
include Aws::Structure
|
2742
|
+
end
|
2743
|
+
|
2426
2744
|
# @!attribute [rw] queue_url
|
2427
2745
|
# The URL of the queue.
|
2428
2746
|
# @return [String]
|
@@ -2442,24 +2760,30 @@ module Aws::SQS
|
|
2442
2760
|
|
2443
2761
|
# The batch request contains more entries than permissible.
|
2444
2762
|
#
|
2763
|
+
# @!attribute [rw] message
|
2764
|
+
# @return [String]
|
2765
|
+
#
|
2445
2766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TooManyEntriesInBatchRequest AWS API Documentation
|
2446
2767
|
#
|
2447
|
-
class TooManyEntriesInBatchRequest <
|
2768
|
+
class TooManyEntriesInBatchRequest < Struct.new(
|
2769
|
+
:message)
|
2770
|
+
SENSITIVE = []
|
2771
|
+
include Aws::Structure
|
2772
|
+
end
|
2448
2773
|
|
2449
2774
|
# Error code 400. Unsupported operation.
|
2450
2775
|
#
|
2776
|
+
# @!attribute [rw] message
|
2777
|
+
# @return [String]
|
2778
|
+
#
|
2451
2779
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UnsupportedOperation AWS API Documentation
|
2452
2780
|
#
|
2453
|
-
class UnsupportedOperation <
|
2781
|
+
class UnsupportedOperation < Struct.new(
|
2782
|
+
:message)
|
2783
|
+
SENSITIVE = []
|
2784
|
+
include Aws::Structure
|
2785
|
+
end
|
2454
2786
|
|
2455
|
-
# @note When making an API call, you may pass UntagQueueRequest
|
2456
|
-
# data as a hash:
|
2457
|
-
#
|
2458
|
-
# {
|
2459
|
-
# queue_url: "String", # required
|
2460
|
-
# tag_keys: ["TagKey"], # required
|
2461
|
-
# }
|
2462
|
-
#
|
2463
2787
|
# @!attribute [rw] queue_url
|
2464
2788
|
# The URL of the queue.
|
2465
2789
|
# @return [String]
|
@@ -2479,3 +2803,4 @@ module Aws::SQS
|
|
2479
2803
|
|
2480
2804
|
end
|
2481
2805
|
end
|
2806
|
+
|