aws-sdk-sqs 1.52.0 → 1.54.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 +17 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +240 -149
- data/lib/aws-sdk-sqs/client_api.rb +219 -51
- data/lib/aws-sdk-sqs/endpoint_provider.rb +41 -100
- data/lib/aws-sdk-sqs/errors.rb +246 -0
- data/lib/aws-sdk-sqs/queue.rb +60 -26
- data/lib/aws-sdk-sqs/queue_poller.rb +6 -0
- data/lib/aws-sdk-sqs/resource.rb +61 -27
- data/lib/aws-sdk-sqs/types.rb +449 -391
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +2 -2
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
|
#
|
@@ -77,15 +67,29 @@ module Aws::SQS
|
|
77
67
|
|
78
68
|
# Two or more batch entries in the request have the same `Id`.
|
79
69
|
#
|
70
|
+
# @!attribute [rw] message
|
71
|
+
# @return [String]
|
72
|
+
#
|
80
73
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchEntryIdsNotDistinct AWS API Documentation
|
81
74
|
#
|
82
|
-
class BatchEntryIdsNotDistinct <
|
75
|
+
class BatchEntryIdsNotDistinct < Struct.new(
|
76
|
+
:message)
|
77
|
+
SENSITIVE = []
|
78
|
+
include Aws::Structure
|
79
|
+
end
|
83
80
|
|
84
81
|
# The length of all the messages put together is more than the limit.
|
85
82
|
#
|
83
|
+
# @!attribute [rw] message
|
84
|
+
# @return [String]
|
85
|
+
#
|
86
86
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchRequestTooLong AWS API Documentation
|
87
87
|
#
|
88
|
-
class BatchRequestTooLong <
|
88
|
+
class BatchRequestTooLong < Struct.new(
|
89
|
+
:message)
|
90
|
+
SENSITIVE = []
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
89
93
|
|
90
94
|
# Gives a detailed description of the result of an action on each entry
|
91
95
|
# in the request.
|
@@ -118,20 +122,6 @@ module Aws::SQS
|
|
118
122
|
include Aws::Structure
|
119
123
|
end
|
120
124
|
|
121
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityBatchRequest
|
122
|
-
# data as a hash:
|
123
|
-
#
|
124
|
-
# {
|
125
|
-
# queue_url: "String", # required
|
126
|
-
# entries: [ # required
|
127
|
-
# {
|
128
|
-
# id: "String", # required
|
129
|
-
# receipt_handle: "String", # required
|
130
|
-
# visibility_timeout: 1,
|
131
|
-
# },
|
132
|
-
# ],
|
133
|
-
# }
|
134
|
-
#
|
135
125
|
# @!attribute [rw] queue_url
|
136
126
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
137
127
|
# changed.
|
@@ -156,26 +146,6 @@ module Aws::SQS
|
|
156
146
|
# Encloses a receipt handle and an entry id for each message in `
|
157
147
|
# ChangeMessageVisibilityBatch.`
|
158
148
|
#
|
159
|
-
# All of the following list parameters must be prefixed with
|
160
|
-
# `ChangeMessageVisibilityBatchRequestEntry.n`, where `n` is an integer
|
161
|
-
# value starting with `1`. For example, a parameter list for this action
|
162
|
-
# might look like this:
|
163
|
-
#
|
164
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
|
165
|
-
#
|
166
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle`
|
167
|
-
#
|
168
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
|
169
|
-
#
|
170
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityBatchRequestEntry
|
171
|
-
# data as a hash:
|
172
|
-
#
|
173
|
-
# {
|
174
|
-
# id: "String", # required
|
175
|
-
# receipt_handle: "String", # required
|
176
|
-
# visibility_timeout: 1,
|
177
|
-
# }
|
178
|
-
#
|
179
149
|
# @!attribute [rw] id
|
180
150
|
# An identifier for this particular receipt handle used to communicate
|
181
151
|
# the result.
|
@@ -243,15 +213,6 @@ module Aws::SQS
|
|
243
213
|
include Aws::Structure
|
244
214
|
end
|
245
215
|
|
246
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityRequest
|
247
|
-
# data as a hash:
|
248
|
-
#
|
249
|
-
# {
|
250
|
-
# queue_url: "String", # required
|
251
|
-
# receipt_handle: "String", # required
|
252
|
-
# visibility_timeout: 1, # required
|
253
|
-
# }
|
254
|
-
#
|
255
216
|
# @!attribute [rw] queue_url
|
256
217
|
# The URL of the Amazon SQS queue whose message's visibility is
|
257
218
|
# changed.
|
@@ -280,19 +241,6 @@ module Aws::SQS
|
|
280
241
|
include Aws::Structure
|
281
242
|
end
|
282
243
|
|
283
|
-
# @note When making an API call, you may pass CreateQueueRequest
|
284
|
-
# data as a hash:
|
285
|
-
#
|
286
|
-
# {
|
287
|
-
# queue_name: "String", # required
|
288
|
-
# attributes: {
|
289
|
-
# "All" => "String",
|
290
|
-
# },
|
291
|
-
# tags: {
|
292
|
-
# "TagKey" => "TagValue",
|
293
|
-
# },
|
294
|
-
# }
|
295
|
-
#
|
296
244
|
# @!attribute [rw] queue_name
|
297
245
|
# The name of the new queue. The following limits apply to this name:
|
298
246
|
#
|
@@ -324,23 +272,33 @@ module Aws::SQS
|
|
324
272
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
325
273
|
# which Amazon SQS retains a message. Valid values: An integer from
|
326
274
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
327
|
-
# 345,600 (4 days).
|
275
|
+
# 345,600 (4 days). When you change a queue's attributes, the
|
276
|
+
# change can take up to 60 seconds for most of the attributes to
|
277
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
278
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
279
|
+
# will impact existing messages in the queue potentially causing
|
280
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
281
|
+
# reduced below the age of existing messages.
|
328
282
|
#
|
329
283
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
330
284
|
# policy. For more information about policy structure, see [Overview
|
331
|
-
# of Amazon Web Services IAM Policies][1] in the *
|
332
|
-
# Guide*.
|
285
|
+
# of Amazon Web Services IAM Policies][1] in the *IAM User Guide*.
|
333
286
|
#
|
334
287
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
335
288
|
# for which a ` ReceiveMessage ` action waits for a message to
|
336
289
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
337
290
|
# 0.
|
338
291
|
#
|
292
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
293
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
294
|
+
# Default: 30. For more information about the visibility timeout,
|
295
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
296
|
+
#
|
297
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
298
|
+
#
|
339
299
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
300
|
# 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 SQS Developer Guide*.
|
301
|
+
# object. The parameters are as follows:
|
344
302
|
#
|
345
303
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
346
304
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -348,22 +306,44 @@ module Aws::SQS
|
|
348
306
|
#
|
349
307
|
# * `maxReceiveCount` – The number of times a message is delivered
|
350
308
|
# to the source queue before being moved to the dead-letter queue.
|
351
|
-
# When the `ReceiveCount` for a message exceeds the
|
309
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
352
310
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
353
311
|
# the dead-letter-queue.
|
354
312
|
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
# a
|
313
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
314
|
+
# the permissions for the dead-letter queue redrive permission and
|
315
|
+
# which source queues can specify dead-letter queues as a JSON
|
316
|
+
# object. The parameters are as follows:
|
358
317
|
#
|
359
|
-
#
|
318
|
+
# * `redrivePermission` – The permission type that defines which
|
319
|
+
# source queues can specify the current queue as the dead-letter
|
320
|
+
# queue. Valid values are:
|
360
321
|
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
322
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
323
|
+
# Services account in the same Region can specify this queue as
|
324
|
+
# the dead-letter queue.
|
325
|
+
#
|
326
|
+
# * `denyAll` – No source queues can specify this queue as the
|
327
|
+
# dead-letter queue.
|
365
328
|
#
|
366
|
-
#
|
329
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
330
|
+
# parameter can specify this queue as the dead-letter queue.
|
331
|
+
#
|
332
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
333
|
+
# source queues that can specify this queue as the dead-letter
|
334
|
+
# queue and redrive messages. You can specify this parameter only
|
335
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
336
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
337
|
+
# source queues to specify dead-letter queues, set the
|
338
|
+
# `redrivePermission` parameter to `allowAll`.
|
339
|
+
#
|
340
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
341
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
342
|
+
# standard queue.
|
343
|
+
#
|
344
|
+
# </note>
|
345
|
+
#
|
346
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
367
347
|
#
|
368
348
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
369
349
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -380,15 +360,15 @@ module Aws::SQS
|
|
380
360
|
# hours). Default: 300 (5 minutes). A shorter time period provides
|
381
361
|
# better security but results in more calls to KMS which might incur
|
382
362
|
# charges after Free Tier. For more information, see [How Does the
|
383
|
-
# Data Key Reuse Period Work?][8]
|
363
|
+
# Data Key Reuse Period Work?][8]
|
384
364
|
#
|
385
365
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
386
366
|
# using SQS owned encryption keys. Only one server-side encryption
|
387
|
-
# option is supported per queue (
|
367
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
388
368
|
# [SSE-SQS][10]).
|
389
369
|
#
|
390
370
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
391
|
-
# queues][11]
|
371
|
+
# queues][11]:
|
392
372
|
#
|
393
373
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
394
374
|
# and `false`. If you don't specify the `FifoQueue` attribute,
|
@@ -434,7 +414,7 @@ module Aws::SQS
|
|
434
414
|
# duplicates and only one copy of the message is delivered.
|
435
415
|
#
|
436
416
|
# The following attributes apply only to [high throughput for FIFO
|
437
|
-
# queues][14]
|
417
|
+
# queues][14]:
|
438
418
|
#
|
439
419
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
440
420
|
# occurs at the message group or queue level. Valid values are
|
@@ -462,8 +442,8 @@ module Aws::SQS
|
|
462
442
|
#
|
463
443
|
#
|
464
444
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
465
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
466
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
445
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
446
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
467
447
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
468
448
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
469
449
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -503,7 +483,7 @@ module Aws::SQS
|
|
503
483
|
#
|
504
484
|
# Cross-account permissions don't apply to this action. For more
|
505
485
|
# information, see [Grant cross-account permissions to a role and a
|
506
|
-
#
|
486
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
507
487
|
#
|
508
488
|
# </note>
|
509
489
|
#
|
@@ -538,19 +518,6 @@ module Aws::SQS
|
|
538
518
|
include Aws::Structure
|
539
519
|
end
|
540
520
|
|
541
|
-
# @note When making an API call, you may pass DeleteMessageBatchRequest
|
542
|
-
# data as a hash:
|
543
|
-
#
|
544
|
-
# {
|
545
|
-
# queue_url: "String", # required
|
546
|
-
# entries: [ # required
|
547
|
-
# {
|
548
|
-
# id: "String", # required
|
549
|
-
# receipt_handle: "String", # required
|
550
|
-
# },
|
551
|
-
# ],
|
552
|
-
# }
|
553
|
-
#
|
554
521
|
# @!attribute [rw] queue_url
|
555
522
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
556
523
|
#
|
@@ -572,14 +539,6 @@ module Aws::SQS
|
|
572
539
|
|
573
540
|
# Encloses a receipt handle and an identifier for it.
|
574
541
|
#
|
575
|
-
# @note When making an API call, you may pass DeleteMessageBatchRequestEntry
|
576
|
-
# data as a hash:
|
577
|
-
#
|
578
|
-
# {
|
579
|
-
# id: "String", # required
|
580
|
-
# receipt_handle: "String", # required
|
581
|
-
# }
|
582
|
-
#
|
583
542
|
# @!attribute [rw] id
|
584
543
|
# An identifier for this particular receipt handle. This is used to
|
585
544
|
# communicate the result.
|
@@ -641,14 +600,6 @@ module Aws::SQS
|
|
641
600
|
include Aws::Structure
|
642
601
|
end
|
643
602
|
|
644
|
-
# @note When making an API call, you may pass DeleteMessageRequest
|
645
|
-
# data as a hash:
|
646
|
-
#
|
647
|
-
# {
|
648
|
-
# queue_url: "String", # required
|
649
|
-
# receipt_handle: "String", # required
|
650
|
-
# }
|
651
|
-
#
|
652
603
|
# @!attribute [rw] queue_url
|
653
604
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
654
605
|
#
|
@@ -668,13 +619,6 @@ module Aws::SQS
|
|
668
619
|
include Aws::Structure
|
669
620
|
end
|
670
621
|
|
671
|
-
# @note When making an API call, you may pass DeleteQueueRequest
|
672
|
-
# data as a hash:
|
673
|
-
#
|
674
|
-
# {
|
675
|
-
# queue_url: "String", # required
|
676
|
-
# }
|
677
|
-
#
|
678
622
|
# @!attribute [rw] queue_url
|
679
623
|
# The URL of the Amazon SQS queue to delete.
|
680
624
|
#
|
@@ -691,18 +635,17 @@ module Aws::SQS
|
|
691
635
|
|
692
636
|
# The batch request doesn't contain any entries.
|
693
637
|
#
|
638
|
+
# @!attribute [rw] message
|
639
|
+
# @return [String]
|
640
|
+
#
|
694
641
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/EmptyBatchRequest AWS API Documentation
|
695
642
|
#
|
696
|
-
class EmptyBatchRequest <
|
643
|
+
class EmptyBatchRequest < Struct.new(
|
644
|
+
:message)
|
645
|
+
SENSITIVE = []
|
646
|
+
include Aws::Structure
|
647
|
+
end
|
697
648
|
|
698
|
-
# @note When making an API call, you may pass GetQueueAttributesRequest
|
699
|
-
# data as a hash:
|
700
|
-
#
|
701
|
-
# {
|
702
|
-
# queue_url: "String", # required
|
703
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
704
|
-
# }
|
705
|
-
#
|
706
649
|
# @!attribute [rw] queue_url
|
707
650
|
# The URL of the Amazon SQS queue whose attribute information is
|
708
651
|
# retrieved.
|
@@ -713,7 +656,7 @@ module Aws::SQS
|
|
713
656
|
# @!attribute [rw] attribute_names
|
714
657
|
# A list of attributes for which to retrieve information.
|
715
658
|
#
|
716
|
-
# The `
|
659
|
+
# The `AttributeNames` parameter is optional, but if you don't
|
717
660
|
# specify values for this parameter, the request returns empty
|
718
661
|
# results.
|
719
662
|
#
|
@@ -727,10 +670,10 @@ module Aws::SQS
|
|
727
670
|
#
|
728
671
|
# The `ApproximateNumberOfMessagesDelayed`,
|
729
672
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
730
|
-
# `
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
673
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
674
|
+
# until at least 1 minute after the producers stop sending messages.
|
675
|
+
# This period is required for the queue metadata to reach eventual
|
676
|
+
# consistency.
|
734
677
|
#
|
735
678
|
# * `All` – Returns all values.
|
736
679
|
#
|
@@ -762,7 +705,14 @@ module Aws::SQS
|
|
762
705
|
# message can contain before Amazon SQS rejects it.
|
763
706
|
#
|
764
707
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
765
|
-
# for which Amazon SQS retains a message.
|
708
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
709
|
+
# attributes, the change can take up to 60 seconds for most of the
|
710
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
711
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
712
|
+
# minutes and will impact existing messages in the queue potentially
|
713
|
+
# causing them to be expired and deleted if the
|
714
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
715
|
+
# messages.
|
766
716
|
#
|
767
717
|
# * `Policy` – Returns the policy of the queue.
|
768
718
|
#
|
@@ -772,11 +722,15 @@ module Aws::SQS
|
|
772
722
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
773
723
|
# to arrive.
|
774
724
|
#
|
725
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
726
|
+
# queue. For more information about the visibility timeout, see
|
727
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
728
|
+
#
|
729
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
730
|
+
#
|
775
731
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
776
732
|
# dead-letter queue functionality of the source queue as a JSON
|
777
|
-
# object.
|
778
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
779
|
-
# in the *Amazon SQS Developer Guide*.
|
733
|
+
# object. The parameters are as follows:
|
780
734
|
#
|
781
735
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
782
736
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -784,15 +738,44 @@ module Aws::SQS
|
|
784
738
|
#
|
785
739
|
# * `maxReceiveCount` – The number of times a message is delivered
|
786
740
|
# to the source queue before being moved to the dead-letter queue.
|
787
|
-
# When the `ReceiveCount` for a message exceeds the
|
741
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
788
742
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
789
743
|
# the dead-letter-queue.
|
790
744
|
#
|
791
|
-
# * `
|
792
|
-
#
|
793
|
-
#
|
745
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
746
|
+
# the permissions for the dead-letter queue redrive permission and
|
747
|
+
# which source queues can specify dead-letter queues as a JSON
|
748
|
+
# object. The parameters are as follows:
|
794
749
|
#
|
795
|
-
#
|
750
|
+
# * `redrivePermission` – The permission type that defines which
|
751
|
+
# source queues can specify the current queue as the dead-letter
|
752
|
+
# queue. Valid values are:
|
753
|
+
#
|
754
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
755
|
+
# Services account in the same Region can specify this queue as
|
756
|
+
# the dead-letter queue.
|
757
|
+
#
|
758
|
+
# * `denyAll` – No source queues can specify this queue as the
|
759
|
+
# dead-letter queue.
|
760
|
+
#
|
761
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
762
|
+
# parameter can specify this queue as the dead-letter queue.
|
763
|
+
#
|
764
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
765
|
+
# source queues that can specify this queue as the dead-letter
|
766
|
+
# queue and redrive messages. You can specify this parameter only
|
767
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
768
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
769
|
+
# source queues to specify dead-letter queues, set the
|
770
|
+
# `redrivePermission` parameter to `allowAll`.
|
771
|
+
#
|
772
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
773
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
774
|
+
# standard queue.
|
775
|
+
#
|
776
|
+
# </note>
|
777
|
+
#
|
778
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
796
779
|
#
|
797
780
|
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
|
798
781
|
# managed customer master key (CMK) for Amazon SQS or a custom CMK.
|
@@ -805,11 +788,11 @@ module Aws::SQS
|
|
805
788
|
#
|
806
789
|
# * `SqsManagedSseEnabled` – Returns information about whether the
|
807
790
|
# queue is using SSE-SQS encryption using SQS owned encryption keys.
|
808
|
-
# Only one server-side encryption option is supported per queue
|
809
|
-
#
|
791
|
+
# Only one server-side encryption option is supported per queue (for
|
792
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
810
793
|
#
|
811
794
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
812
|
-
# queues][9]
|
795
|
+
# queues][9]:
|
813
796
|
#
|
814
797
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
815
798
|
# For more information, see [FIFO queue logic][10] in the *Amazon
|
@@ -825,7 +808,7 @@ module Aws::SQS
|
|
825
808
|
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
826
809
|
#
|
827
810
|
# The following attributes apply only to [high throughput for FIFO
|
828
|
-
# queues][12]
|
811
|
+
# queues][12]:
|
829
812
|
#
|
830
813
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
831
814
|
# occurs at the message group or queue level. Valid values are
|
@@ -853,8 +836,8 @@ module Aws::SQS
|
|
853
836
|
#
|
854
837
|
#
|
855
838
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
856
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
857
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
839
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
840
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
858
841
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
859
842
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
860
843
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -890,14 +873,6 @@ module Aws::SQS
|
|
890
873
|
include Aws::Structure
|
891
874
|
end
|
892
875
|
|
893
|
-
# @note When making an API call, you may pass GetQueueUrlRequest
|
894
|
-
# data as a hash:
|
895
|
-
#
|
896
|
-
# {
|
897
|
-
# queue_name: "String", # required
|
898
|
-
# queue_owner_aws_account_id: "String",
|
899
|
-
# }
|
900
|
-
#
|
901
876
|
# @!attribute [rw] queue_name
|
902
877
|
# The name of the queue whose URL must be fetched. Maximum 80
|
903
878
|
# characters. Valid values: alphanumeric characters, hyphens (`-`),
|
@@ -939,18 +914,58 @@ module Aws::SQS
|
|
939
914
|
include Aws::Structure
|
940
915
|
end
|
941
916
|
|
917
|
+
# The `accountId` is invalid.
|
918
|
+
#
|
919
|
+
# @!attribute [rw] message
|
920
|
+
# @return [String]
|
921
|
+
#
|
922
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAddress AWS API Documentation
|
923
|
+
#
|
924
|
+
class InvalidAddress < Struct.new(
|
925
|
+
:message)
|
926
|
+
SENSITIVE = []
|
927
|
+
include Aws::Structure
|
928
|
+
end
|
929
|
+
|
942
930
|
# The specified attribute doesn't exist.
|
943
931
|
#
|
932
|
+
# @!attribute [rw] message
|
933
|
+
# @return [String]
|
934
|
+
#
|
944
935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeName AWS API Documentation
|
945
936
|
#
|
946
|
-
class InvalidAttributeName <
|
937
|
+
class InvalidAttributeName < Struct.new(
|
938
|
+
:message)
|
939
|
+
SENSITIVE = []
|
940
|
+
include Aws::Structure
|
941
|
+
end
|
942
|
+
|
943
|
+
# A queue attribute value is invalid.
|
944
|
+
#
|
945
|
+
# @!attribute [rw] message
|
946
|
+
# @return [String]
|
947
|
+
#
|
948
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeValue AWS API Documentation
|
949
|
+
#
|
950
|
+
class InvalidAttributeValue < Struct.new(
|
951
|
+
:message)
|
952
|
+
SENSITIVE = []
|
953
|
+
include Aws::Structure
|
954
|
+
end
|
947
955
|
|
948
956
|
# The `Id` of a batch entry in a batch request doesn't abide by the
|
949
957
|
# specification.
|
950
958
|
#
|
959
|
+
# @!attribute [rw] message
|
960
|
+
# @return [String]
|
961
|
+
#
|
951
962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidBatchEntryId AWS API Documentation
|
952
963
|
#
|
953
|
-
class InvalidBatchEntryId <
|
964
|
+
class InvalidBatchEntryId < Struct.new(
|
965
|
+
:message)
|
966
|
+
SENSITIVE = []
|
967
|
+
include Aws::Structure
|
968
|
+
end
|
954
969
|
|
955
970
|
# The specified receipt handle isn't valid for the current version.
|
956
971
|
#
|
@@ -960,19 +975,132 @@ module Aws::SQS
|
|
960
975
|
|
961
976
|
# The message contains characters outside the allowed set.
|
962
977
|
#
|
978
|
+
# @!attribute [rw] message
|
979
|
+
# @return [String]
|
980
|
+
#
|
963
981
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidMessageContents AWS API Documentation
|
964
982
|
#
|
965
|
-
class InvalidMessageContents <
|
983
|
+
class InvalidMessageContents < Struct.new(
|
984
|
+
:message)
|
985
|
+
SENSITIVE = []
|
986
|
+
include Aws::Structure
|
987
|
+
end
|
988
|
+
|
989
|
+
# When the request to a queue is not HTTPS and SigV4.
|
990
|
+
#
|
991
|
+
# @!attribute [rw] message
|
992
|
+
# @return [String]
|
993
|
+
#
|
994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidSecurity AWS API Documentation
|
995
|
+
#
|
996
|
+
class InvalidSecurity < Struct.new(
|
997
|
+
:message)
|
998
|
+
SENSITIVE = []
|
999
|
+
include Aws::Structure
|
1000
|
+
end
|
1001
|
+
|
1002
|
+
# The caller doesn't have the required KMS access.
|
1003
|
+
#
|
1004
|
+
# @!attribute [rw] message
|
1005
|
+
# @return [String]
|
1006
|
+
#
|
1007
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsAccessDenied AWS API Documentation
|
1008
|
+
#
|
1009
|
+
class KmsAccessDenied < Struct.new(
|
1010
|
+
:message)
|
1011
|
+
SENSITIVE = []
|
1012
|
+
include Aws::Structure
|
1013
|
+
end
|
966
1014
|
|
967
|
-
#
|
968
|
-
# data as a hash:
|
1015
|
+
# The request was denied due to request throttling.
|
969
1016
|
#
|
970
|
-
#
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
1017
|
+
# @!attribute [rw] message
|
1018
|
+
# @return [String]
|
1019
|
+
#
|
1020
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsDisabled AWS API Documentation
|
1021
|
+
#
|
1022
|
+
class KmsDisabled < Struct.new(
|
1023
|
+
:message)
|
1024
|
+
SENSITIVE = []
|
1025
|
+
include Aws::Structure
|
1026
|
+
end
|
1027
|
+
|
1028
|
+
# The request was rejected for one of the following reasons:
|
1029
|
+
#
|
1030
|
+
# * The KeyUsage value of the KMS key is incompatible with the API
|
1031
|
+
# operation.
|
1032
|
+
#
|
1033
|
+
# * The encryption algorithm or signing algorithm specified for the
|
1034
|
+
# operation is incompatible with the type of key material in the KMS
|
1035
|
+
# key (KeySpec).
|
1036
|
+
#
|
1037
|
+
# @!attribute [rw] message
|
1038
|
+
# @return [String]
|
975
1039
|
#
|
1040
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsInvalidKeyUsage AWS API Documentation
|
1041
|
+
#
|
1042
|
+
class KmsInvalidKeyUsage < Struct.new(
|
1043
|
+
:message)
|
1044
|
+
SENSITIVE = []
|
1045
|
+
include Aws::Structure
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# The request was rejected because the state of the specified resource
|
1049
|
+
# is not valid for this request.
|
1050
|
+
#
|
1051
|
+
# @!attribute [rw] message
|
1052
|
+
# @return [String]
|
1053
|
+
#
|
1054
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsInvalidState AWS API Documentation
|
1055
|
+
#
|
1056
|
+
class KmsInvalidState < Struct.new(
|
1057
|
+
:message)
|
1058
|
+
SENSITIVE = []
|
1059
|
+
include Aws::Structure
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
# The request was rejected because the specified entity or resource
|
1063
|
+
# could not be found.
|
1064
|
+
#
|
1065
|
+
# @!attribute [rw] message
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsNotFound AWS API Documentation
|
1069
|
+
#
|
1070
|
+
class KmsNotFound < Struct.new(
|
1071
|
+
:message)
|
1072
|
+
SENSITIVE = []
|
1073
|
+
include Aws::Structure
|
1074
|
+
end
|
1075
|
+
|
1076
|
+
# The request was rejected because the specified key policy isn't
|
1077
|
+
# syntactically or semantically correct.
|
1078
|
+
#
|
1079
|
+
# @!attribute [rw] message
|
1080
|
+
# @return [String]
|
1081
|
+
#
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsOptInRequired AWS API Documentation
|
1083
|
+
#
|
1084
|
+
class KmsOptInRequired < Struct.new(
|
1085
|
+
:message)
|
1086
|
+
SENSITIVE = []
|
1087
|
+
include Aws::Structure
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# Amazon Web Services KMS throttles requests for the following
|
1091
|
+
# conditions.
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] message
|
1094
|
+
# @return [String]
|
1095
|
+
#
|
1096
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsThrottled AWS API Documentation
|
1097
|
+
#
|
1098
|
+
class KmsThrottled < Struct.new(
|
1099
|
+
:message)
|
1100
|
+
SENSITIVE = []
|
1101
|
+
include Aws::Structure
|
1102
|
+
end
|
1103
|
+
|
976
1104
|
# @!attribute [rw] queue_url
|
977
1105
|
# The URL of a dead-letter queue.
|
978
1106
|
#
|
@@ -1021,13 +1149,6 @@ module Aws::SQS
|
|
1021
1149
|
include Aws::Structure
|
1022
1150
|
end
|
1023
1151
|
|
1024
|
-
# @note When making an API call, you may pass ListQueueTagsRequest
|
1025
|
-
# data as a hash:
|
1026
|
-
#
|
1027
|
-
# {
|
1028
|
-
# queue_url: "String", # required
|
1029
|
-
# }
|
1030
|
-
#
|
1031
1152
|
# @!attribute [rw] queue_url
|
1032
1153
|
# The URL of the queue.
|
1033
1154
|
# @return [String]
|
@@ -1052,15 +1173,6 @@ module Aws::SQS
|
|
1052
1173
|
include Aws::Structure
|
1053
1174
|
end
|
1054
1175
|
|
1055
|
-
# @note When making an API call, you may pass ListQueuesRequest
|
1056
|
-
# data as a hash:
|
1057
|
-
#
|
1058
|
-
# {
|
1059
|
-
# queue_name_prefix: "String",
|
1060
|
-
# next_token: "Token",
|
1061
|
-
# max_results: 1,
|
1062
|
-
# }
|
1063
|
-
#
|
1064
1176
|
# @!attribute [rw] queue_name_prefix
|
1065
1177
|
# A string to use for filtering the list results. Only those queues
|
1066
1178
|
# whose name begins with the specified string are returned.
|
@@ -1202,20 +1314,9 @@ module Aws::SQS
|
|
1202
1314
|
#
|
1203
1315
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1204
1316
|
# null. All parts of the message attribute, including `Name`, `Type`,
|
1205
|
-
# and `Value`, are part of the message size restriction (256
|
1317
|
+
# and `Value`, are part of the message size restriction (256 KiB or
|
1206
1318
|
# 262,144 bytes).
|
1207
1319
|
#
|
1208
|
-
# @note When making an API call, you may pass MessageAttributeValue
|
1209
|
-
# data as a hash:
|
1210
|
-
#
|
1211
|
-
# {
|
1212
|
-
# string_value: "String",
|
1213
|
-
# binary_value: "data",
|
1214
|
-
# string_list_values: ["String"],
|
1215
|
-
# binary_list_values: ["data"],
|
1216
|
-
# data_type: "String", # required
|
1217
|
-
# }
|
1218
|
-
#
|
1219
1320
|
# @!attribute [rw] string_value
|
1220
1321
|
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1221
1322
|
# values, see [ASCII Printable Characters][1].
|
@@ -1276,17 +1377,6 @@ module Aws::SQS
|
|
1276
1377
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1277
1378
|
# null.
|
1278
1379
|
#
|
1279
|
-
# @note When making an API call, you may pass MessageSystemAttributeValue
|
1280
|
-
# data as a hash:
|
1281
|
-
#
|
1282
|
-
# {
|
1283
|
-
# string_value: "String",
|
1284
|
-
# binary_value: "data",
|
1285
|
-
# string_list_values: ["String"],
|
1286
|
-
# binary_list_values: ["data"],
|
1287
|
-
# data_type: "String", # required
|
1288
|
-
# }
|
1289
|
-
#
|
1290
1380
|
# @!attribute [rw] string_value
|
1291
1381
|
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1292
1382
|
# values, see [ASCII Printable Characters][1].
|
@@ -1335,29 +1425,36 @@ module Aws::SQS
|
|
1335
1425
|
end
|
1336
1426
|
|
1337
1427
|
# The specified action violates a limit. For example, `ReceiveMessage`
|
1338
|
-
# returns this error if the maximum number of
|
1428
|
+
# returns this error if the maximum number of in flight messages is
|
1339
1429
|
# reached and `AddPermission` returns this error if the maximum number
|
1340
1430
|
# of permissions for the queue is reached.
|
1341
1431
|
#
|
1432
|
+
# @!attribute [rw] message
|
1433
|
+
# @return [String]
|
1434
|
+
#
|
1342
1435
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/OverLimit AWS API Documentation
|
1343
1436
|
#
|
1344
|
-
class OverLimit <
|
1437
|
+
class OverLimit < Struct.new(
|
1438
|
+
:message)
|
1439
|
+
SENSITIVE = []
|
1440
|
+
include Aws::Structure
|
1441
|
+
end
|
1345
1442
|
|
1346
1443
|
# Indicates that the specified queue previously received a `PurgeQueue`
|
1347
1444
|
# request within the last 60 seconds (the time it can take to delete the
|
1348
1445
|
# messages in the queue).
|
1349
1446
|
#
|
1447
|
+
# @!attribute [rw] message
|
1448
|
+
# @return [String]
|
1449
|
+
#
|
1350
1450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueInProgress AWS API Documentation
|
1351
1451
|
#
|
1352
|
-
class PurgeQueueInProgress <
|
1452
|
+
class PurgeQueueInProgress < Struct.new(
|
1453
|
+
:message)
|
1454
|
+
SENSITIVE = []
|
1455
|
+
include Aws::Structure
|
1456
|
+
end
|
1353
1457
|
|
1354
|
-
# @note When making an API call, you may pass PurgeQueueRequest
|
1355
|
-
# data as a hash:
|
1356
|
-
#
|
1357
|
-
# {
|
1358
|
-
# queue_url: "String", # required
|
1359
|
-
# }
|
1360
|
-
#
|
1361
1458
|
# @!attribute [rw] queue_url
|
1362
1459
|
# The URL of the queue from which the `PurgeQueue` action deletes
|
1363
1460
|
# messages.
|
@@ -1376,43 +1473,58 @@ module Aws::SQS
|
|
1376
1473
|
# You must wait 60 seconds after deleting a queue before you can create
|
1377
1474
|
# another queue with the same name.
|
1378
1475
|
#
|
1476
|
+
# @!attribute [rw] message
|
1477
|
+
# @return [String]
|
1478
|
+
#
|
1379
1479
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDeletedRecently AWS API Documentation
|
1380
1480
|
#
|
1381
|
-
class QueueDeletedRecently <
|
1481
|
+
class QueueDeletedRecently < Struct.new(
|
1482
|
+
:message)
|
1483
|
+
SENSITIVE = []
|
1484
|
+
include Aws::Structure
|
1485
|
+
end
|
1382
1486
|
|
1383
1487
|
# The specified queue doesn't exist.
|
1384
1488
|
#
|
1489
|
+
# @!attribute [rw] message
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1385
1492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDoesNotExist AWS API Documentation
|
1386
1493
|
#
|
1387
|
-
class QueueDoesNotExist <
|
1494
|
+
class QueueDoesNotExist < Struct.new(
|
1495
|
+
:message)
|
1496
|
+
SENSITIVE = []
|
1497
|
+
include Aws::Structure
|
1498
|
+
end
|
1388
1499
|
|
1389
1500
|
# A queue with this name already exists. Amazon SQS returns this error
|
1390
1501
|
# only if the request includes attributes whose values differ from those
|
1391
1502
|
# of the existing queue.
|
1392
1503
|
#
|
1504
|
+
# @!attribute [rw] message
|
1505
|
+
# @return [String]
|
1506
|
+
#
|
1393
1507
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueNameExists AWS API Documentation
|
1394
1508
|
#
|
1395
|
-
class QueueNameExists <
|
1509
|
+
class QueueNameExists < Struct.new(
|
1510
|
+
:message)
|
1511
|
+
SENSITIVE = []
|
1512
|
+
include Aws::Structure
|
1513
|
+
end
|
1396
1514
|
|
1397
1515
|
# The specified receipt handle isn't valid.
|
1398
1516
|
#
|
1517
|
+
# @!attribute [rw] message
|
1518
|
+
# @return [String]
|
1519
|
+
#
|
1399
1520
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiptHandleIsInvalid AWS API Documentation
|
1400
1521
|
#
|
1401
|
-
class ReceiptHandleIsInvalid <
|
1522
|
+
class ReceiptHandleIsInvalid < Struct.new(
|
1523
|
+
:message)
|
1524
|
+
SENSITIVE = []
|
1525
|
+
include Aws::Structure
|
1526
|
+
end
|
1402
1527
|
|
1403
|
-
# @note When making an API call, you may pass ReceiveMessageRequest
|
1404
|
-
# data as a hash:
|
1405
|
-
#
|
1406
|
-
# {
|
1407
|
-
# queue_url: "String", # required
|
1408
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
1409
|
-
# message_attribute_names: ["MessageAttributeName"],
|
1410
|
-
# max_number_of_messages: 1,
|
1411
|
-
# visibility_timeout: 1,
|
1412
|
-
# wait_time_seconds: 1,
|
1413
|
-
# receive_request_attempt_id: "String",
|
1414
|
-
# }
|
1415
|
-
#
|
1416
1528
|
# @!attribute [rw] queue_url
|
1417
1529
|
# The URL of the Amazon SQS queue from which messages are received.
|
1418
1530
|
#
|
@@ -1436,7 +1548,7 @@ module Aws::SQS
|
|
1436
1548
|
#
|
1437
1549
|
# * `SenderId`
|
1438
1550
|
#
|
1439
|
-
# * For
|
1551
|
+
# * For a user, returns the user ID, for example
|
1440
1552
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1441
1553
|
#
|
1442
1554
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1447,7 +1559,8 @@ module Aws::SQS
|
|
1447
1559
|
#
|
1448
1560
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1449
1561
|
# using SQS owned encryption keys. Only one server-side encryption
|
1450
|
-
# option is supported per queue (
|
1562
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1563
|
+
# [SSE-SQS][3]).
|
1451
1564
|
#
|
1452
1565
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1453
1566
|
# producer that calls the ` SendMessage ` action.
|
@@ -1616,14 +1729,6 @@ module Aws::SQS
|
|
1616
1729
|
include Aws::Structure
|
1617
1730
|
end
|
1618
1731
|
|
1619
|
-
# @note When making an API call, you may pass RemovePermissionRequest
|
1620
|
-
# data as a hash:
|
1621
|
-
#
|
1622
|
-
# {
|
1623
|
-
# queue_url: "String", # required
|
1624
|
-
# label: "String", # required
|
1625
|
-
# }
|
1626
|
-
#
|
1627
1732
|
# @!attribute [rw] queue_url
|
1628
1733
|
# The URL of the Amazon SQS queue from which permissions are removed.
|
1629
1734
|
#
|
@@ -1644,40 +1749,32 @@ module Aws::SQS
|
|
1644
1749
|
include Aws::Structure
|
1645
1750
|
end
|
1646
1751
|
|
1647
|
-
#
|
1648
|
-
#
|
1649
|
-
#
|
1650
|
-
#
|
1651
|
-
#
|
1652
|
-
#
|
1653
|
-
#
|
1654
|
-
#
|
1655
|
-
#
|
1656
|
-
#
|
1657
|
-
#
|
1658
|
-
#
|
1659
|
-
#
|
1660
|
-
#
|
1661
|
-
# string_list_values: ["String"],
|
1662
|
-
# binary_list_values: ["data"],
|
1663
|
-
# data_type: "String", # required
|
1664
|
-
# },
|
1665
|
-
# },
|
1666
|
-
# message_system_attributes: {
|
1667
|
-
# "AWSTraceHeader" => {
|
1668
|
-
# string_value: "String",
|
1669
|
-
# binary_value: "data",
|
1670
|
-
# string_list_values: ["String"],
|
1671
|
-
# binary_list_values: ["data"],
|
1672
|
-
# data_type: "String", # required
|
1673
|
-
# },
|
1674
|
-
# },
|
1675
|
-
# message_deduplication_id: "String",
|
1676
|
-
# message_group_id: "String",
|
1677
|
-
# },
|
1678
|
-
# ],
|
1679
|
-
# }
|
1752
|
+
# The request was denied due to request throttling.
|
1753
|
+
#
|
1754
|
+
# * The rate of requests per second exceeds the AWS KMS request quota
|
1755
|
+
# for an account and Region.
|
1756
|
+
#
|
1757
|
+
# * A burst or sustained high rate of requests to change the state of
|
1758
|
+
# the same KMS key. This condition is often known as a "hot key."
|
1759
|
+
#
|
1760
|
+
# * Requests for operations on KMS keys in a Amazon Web Services
|
1761
|
+
# CloudHSM key store might be throttled at a lower-than-expected rate
|
1762
|
+
# when the Amazon Web Services CloudHSM cluster associated with the
|
1763
|
+
# Amazon Web Services CloudHSM key store is processing numerous
|
1764
|
+
# commands, including those unrelated to the Amazon Web Services
|
1765
|
+
# CloudHSM key store.
|
1680
1766
|
#
|
1767
|
+
# @!attribute [rw] message
|
1768
|
+
# @return [String]
|
1769
|
+
#
|
1770
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RequestThrottled AWS API Documentation
|
1771
|
+
#
|
1772
|
+
class RequestThrottled < Struct.new(
|
1773
|
+
:message)
|
1774
|
+
SENSITIVE = []
|
1775
|
+
include Aws::Structure
|
1776
|
+
end
|
1777
|
+
|
1681
1778
|
# @!attribute [rw] queue_url
|
1682
1779
|
# The URL of the Amazon SQS queue to which batched messages are sent.
|
1683
1780
|
#
|
@@ -1700,35 +1797,6 @@ module Aws::SQS
|
|
1700
1797
|
# Contains the details of a single Amazon SQS message along with an
|
1701
1798
|
# `Id`.
|
1702
1799
|
#
|
1703
|
-
# @note When making an API call, you may pass SendMessageBatchRequestEntry
|
1704
|
-
# data as a hash:
|
1705
|
-
#
|
1706
|
-
# {
|
1707
|
-
# id: "String", # required
|
1708
|
-
# message_body: "String", # required
|
1709
|
-
# delay_seconds: 1,
|
1710
|
-
# message_attributes: {
|
1711
|
-
# "String" => {
|
1712
|
-
# string_value: "String",
|
1713
|
-
# binary_value: "data",
|
1714
|
-
# string_list_values: ["String"],
|
1715
|
-
# binary_list_values: ["data"],
|
1716
|
-
# data_type: "String", # required
|
1717
|
-
# },
|
1718
|
-
# },
|
1719
|
-
# message_system_attributes: {
|
1720
|
-
# "AWSTraceHeader" => {
|
1721
|
-
# string_value: "String",
|
1722
|
-
# binary_value: "data",
|
1723
|
-
# string_list_values: ["String"],
|
1724
|
-
# binary_list_values: ["data"],
|
1725
|
-
# data_type: "String", # required
|
1726
|
-
# },
|
1727
|
-
# },
|
1728
|
-
# message_deduplication_id: "String",
|
1729
|
-
# message_group_id: "String",
|
1730
|
-
# }
|
1731
|
-
#
|
1732
1800
|
# @!attribute [rw] id
|
1733
1801
|
# An identifier for a message in this batch used to communicate the
|
1734
1802
|
# result.
|
@@ -1987,35 +2055,6 @@ module Aws::SQS
|
|
1987
2055
|
include Aws::Structure
|
1988
2056
|
end
|
1989
2057
|
|
1990
|
-
# @note When making an API call, you may pass SendMessageRequest
|
1991
|
-
# data as a hash:
|
1992
|
-
#
|
1993
|
-
# {
|
1994
|
-
# queue_url: "String", # required
|
1995
|
-
# message_body: "String", # required
|
1996
|
-
# delay_seconds: 1,
|
1997
|
-
# message_attributes: {
|
1998
|
-
# "String" => {
|
1999
|
-
# string_value: "String",
|
2000
|
-
# binary_value: "data",
|
2001
|
-
# string_list_values: ["String"],
|
2002
|
-
# binary_list_values: ["data"],
|
2003
|
-
# data_type: "String", # required
|
2004
|
-
# },
|
2005
|
-
# },
|
2006
|
-
# message_system_attributes: {
|
2007
|
-
# "AWSTraceHeader" => {
|
2008
|
-
# string_value: "String",
|
2009
|
-
# binary_value: "data",
|
2010
|
-
# string_list_values: ["String"],
|
2011
|
-
# binary_list_values: ["data"],
|
2012
|
-
# data_type: "String", # required
|
2013
|
-
# },
|
2014
|
-
# },
|
2015
|
-
# message_deduplication_id: "String",
|
2016
|
-
# message_group_id: "String",
|
2017
|
-
# }
|
2018
|
-
#
|
2019
2058
|
# @!attribute [rw] queue_url
|
2020
2059
|
# The URL of the Amazon SQS queue to which a message is sent.
|
2021
2060
|
#
|
@@ -2024,7 +2063,7 @@ module Aws::SQS
|
|
2024
2063
|
#
|
2025
2064
|
# @!attribute [rw] message_body
|
2026
2065
|
# The message to send. The minimum size is one character. The maximum
|
2027
|
-
# size is 256
|
2066
|
+
# size is 256 KiB.
|
2028
2067
|
#
|
2029
2068
|
# A message can include only XML, JSON, and unformatted text. The
|
2030
2069
|
# following Unicode characters are allowed:
|
@@ -2254,16 +2293,6 @@ module Aws::SQS
|
|
2254
2293
|
include Aws::Structure
|
2255
2294
|
end
|
2256
2295
|
|
2257
|
-
# @note When making an API call, you may pass SetQueueAttributesRequest
|
2258
|
-
# data as a hash:
|
2259
|
-
#
|
2260
|
-
# {
|
2261
|
-
# queue_url: "String", # required
|
2262
|
-
# attributes: { # required
|
2263
|
-
# "All" => "String",
|
2264
|
-
# },
|
2265
|
-
# }
|
2266
|
-
#
|
2267
2296
|
# @!attribute [rw] queue_url
|
2268
2297
|
# The URL of the Amazon SQS queue whose attributes are set.
|
2269
2298
|
#
|
@@ -2289,7 +2318,13 @@ module Aws::SQS
|
|
2289
2318
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2290
2319
|
# which Amazon SQS retains a message. Valid values: An integer
|
2291
2320
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2292
|
-
# Default: 345,600 (4 days).
|
2321
|
+
# Default: 345,600 (4 days). When you change a queue's attributes,
|
2322
|
+
# the change can take up to 60 seconds for most of the attributes to
|
2323
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
2324
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
2325
|
+
# will impact existing messages in the queue potentially causing
|
2326
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
2327
|
+
# reduced below the age of existing messages.
|
2293
2328
|
#
|
2294
2329
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2295
2330
|
# policy. For more information about policy structure, see [Overview
|
@@ -2301,11 +2336,16 @@ module Aws::SQS
|
|
2301
2336
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2302
2337
|
# 0.
|
2303
2338
|
#
|
2339
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2340
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2341
|
+
# Default: 30. For more information about the visibility timeout,
|
2342
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2343
|
+
#
|
2344
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2345
|
+
#
|
2304
2346
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2305
2347
|
# dead-letter queue functionality of the source queue as a JSON
|
2306
|
-
# object.
|
2307
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2308
|
-
# in the *Amazon SQS Developer Guide*.
|
2348
|
+
# object. The parameters are as follows:
|
2309
2349
|
#
|
2310
2350
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2311
2351
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2313,22 +2353,44 @@ module Aws::SQS
|
|
2313
2353
|
#
|
2314
2354
|
# * `maxReceiveCount` – The number of times a message is delivered
|
2315
2355
|
# to the source queue before being moved to the dead-letter queue.
|
2316
|
-
# When the `ReceiveCount` for a message exceeds the
|
2356
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2317
2357
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2318
2358
|
# the dead-letter-queue.
|
2319
2359
|
#
|
2320
|
-
#
|
2321
|
-
#
|
2322
|
-
# a
|
2360
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2361
|
+
# the permissions for the dead-letter queue redrive permission and
|
2362
|
+
# which source queues can specify dead-letter queues as a JSON
|
2363
|
+
# object. The parameters are as follows:
|
2323
2364
|
#
|
2324
|
-
#
|
2365
|
+
# * `redrivePermission` – The permission type that defines which
|
2366
|
+
# source queues can specify the current queue as the dead-letter
|
2367
|
+
# queue. Valid values are:
|
2325
2368
|
#
|
2326
|
-
#
|
2327
|
-
#
|
2328
|
-
#
|
2329
|
-
#
|
2369
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2370
|
+
# Services account in the same Region can specify this queue as
|
2371
|
+
# the dead-letter queue.
|
2372
|
+
#
|
2373
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2374
|
+
# dead-letter queue.
|
2375
|
+
#
|
2376
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2377
|
+
# parameter can specify this queue as the dead-letter queue.
|
2378
|
+
#
|
2379
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2380
|
+
# source queues that can specify this queue as the dead-letter
|
2381
|
+
# queue and redrive messages. You can specify this parameter only
|
2382
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2383
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
2384
|
+
# source queues to specify dead-letter queues, set the
|
2385
|
+
# `redrivePermission` parameter to `allowAll`.
|
2386
|
+
#
|
2387
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2388
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2389
|
+
# standard queue.
|
2390
|
+
#
|
2391
|
+
# </note>
|
2330
2392
|
#
|
2331
|
-
# The following attributes apply only to [server-side-encryption][4]
|
2393
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
2332
2394
|
#
|
2333
2395
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
2334
2396
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -2349,11 +2411,11 @@ module Aws::SQS
|
|
2349
2411
|
#
|
2350
2412
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
2351
2413
|
# using SQS owned encryption keys. Only one server-side encryption
|
2352
|
-
# option is supported per queue (
|
2414
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
2353
2415
|
# [SSE-SQS][10]).
|
2354
2416
|
#
|
2355
2417
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2356
|
-
# queues][11]
|
2418
|
+
# queues][11]:
|
2357
2419
|
#
|
2358
2420
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2359
2421
|
# For more information, see [Exactly-once processing][12] in the
|
@@ -2388,7 +2450,7 @@ module Aws::SQS
|
|
2388
2450
|
# duplicates and only one copy of the message is delivered.
|
2389
2451
|
#
|
2390
2452
|
# The following attributes apply only to [high throughput for FIFO
|
2391
|
-
# queues][13]
|
2453
|
+
# queues][13]:
|
2392
2454
|
#
|
2393
2455
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2394
2456
|
# occurs at the message group or queue level. Valid values are
|
@@ -2416,8 +2478,8 @@ module Aws::SQS
|
|
2416
2478
|
#
|
2417
2479
|
#
|
2418
2480
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2419
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2420
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2481
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2482
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2421
2483
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2422
2484
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2423
2485
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2440,16 +2502,6 @@ module Aws::SQS
|
|
2440
2502
|
include Aws::Structure
|
2441
2503
|
end
|
2442
2504
|
|
2443
|
-
# @note When making an API call, you may pass TagQueueRequest
|
2444
|
-
# data as a hash:
|
2445
|
-
#
|
2446
|
-
# {
|
2447
|
-
# queue_url: "String", # required
|
2448
|
-
# tags: { # required
|
2449
|
-
# "TagKey" => "TagValue",
|
2450
|
-
# },
|
2451
|
-
# }
|
2452
|
-
#
|
2453
2505
|
# @!attribute [rw] queue_url
|
2454
2506
|
# The URL of the queue.
|
2455
2507
|
# @return [String]
|
@@ -2469,24 +2521,30 @@ module Aws::SQS
|
|
2469
2521
|
|
2470
2522
|
# The batch request contains more entries than permissible.
|
2471
2523
|
#
|
2524
|
+
# @!attribute [rw] message
|
2525
|
+
# @return [String]
|
2526
|
+
#
|
2472
2527
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TooManyEntriesInBatchRequest AWS API Documentation
|
2473
2528
|
#
|
2474
|
-
class TooManyEntriesInBatchRequest <
|
2529
|
+
class TooManyEntriesInBatchRequest < Struct.new(
|
2530
|
+
:message)
|
2531
|
+
SENSITIVE = []
|
2532
|
+
include Aws::Structure
|
2533
|
+
end
|
2475
2534
|
|
2476
2535
|
# Error code 400. Unsupported operation.
|
2477
2536
|
#
|
2537
|
+
# @!attribute [rw] message
|
2538
|
+
# @return [String]
|
2539
|
+
#
|
2478
2540
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UnsupportedOperation AWS API Documentation
|
2479
2541
|
#
|
2480
|
-
class UnsupportedOperation <
|
2542
|
+
class UnsupportedOperation < Struct.new(
|
2543
|
+
:message)
|
2544
|
+
SENSITIVE = []
|
2545
|
+
include Aws::Structure
|
2546
|
+
end
|
2481
2547
|
|
2482
|
-
# @note When making an API call, you may pass UntagQueueRequest
|
2483
|
-
# data as a hash:
|
2484
|
-
#
|
2485
|
-
# {
|
2486
|
-
# queue_url: "String", # required
|
2487
|
-
# tag_keys: ["TagKey"], # required
|
2488
|
-
# }
|
2489
|
-
#
|
2490
2548
|
# @!attribute [rw] queue_url
|
2491
2549
|
# The URL of the queue.
|
2492
2550
|
# @return [String]
|