aws-sdk-sqs 1.27.1 → 1.32.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/lib/aws-sdk-sqs.rb +4 -2
- data/lib/aws-sdk-sqs/client.rb +188 -111
- data/lib/aws-sdk-sqs/client_api.rb +22 -0
- data/lib/aws-sdk-sqs/customizations.rb +2 -0
- data/lib/aws-sdk-sqs/errors.rb +2 -0
- data/lib/aws-sdk-sqs/message.rb +4 -2
- data/lib/aws-sdk-sqs/plugins/md5s.rb +2 -0
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +2 -0
- data/lib/aws-sdk-sqs/queue.rb +59 -43
- data/lib/aws-sdk-sqs/queue_poller.rb +2 -0
- data/lib/aws-sdk-sqs/resource.rb +28 -24
- data/lib/aws-sdk-sqs/types.rb +208 -93
- metadata +2 -2
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -70,6 +72,7 @@ module Aws::SQS
|
|
70
72
|
:label,
|
71
73
|
:aws_account_ids,
|
72
74
|
:actions)
|
75
|
+
SENSITIVE = []
|
73
76
|
include Aws::Structure
|
74
77
|
end
|
75
78
|
|
@@ -93,7 +96,8 @@ module Aws::SQS
|
|
93
96
|
# @return [String]
|
94
97
|
#
|
95
98
|
# @!attribute [rw] sender_fault
|
96
|
-
# Specifies whether the error happened due to the
|
99
|
+
# Specifies whether the error happened due to the caller of the batch
|
100
|
+
# API action.
|
97
101
|
# @return [Boolean]
|
98
102
|
#
|
99
103
|
# @!attribute [rw] code
|
@@ -111,6 +115,7 @@ module Aws::SQS
|
|
111
115
|
:sender_fault,
|
112
116
|
:code,
|
113
117
|
:message)
|
118
|
+
SENSITIVE = []
|
114
119
|
include Aws::Structure
|
115
120
|
end
|
116
121
|
|
@@ -145,6 +150,7 @@ module Aws::SQS
|
|
145
150
|
class ChangeMessageVisibilityBatchRequest < Struct.new(
|
146
151
|
:queue_url,
|
147
152
|
:entries)
|
153
|
+
SENSITIVE = []
|
148
154
|
include Aws::Structure
|
149
155
|
end
|
150
156
|
|
@@ -175,7 +181,11 @@ module Aws::SQS
|
|
175
181
|
# An identifier for this particular receipt handle used to communicate
|
176
182
|
# the result.
|
177
183
|
#
|
178
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
184
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
185
|
+
#
|
186
|
+
# This identifier can have up to 80 characters. The following
|
187
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
188
|
+
# underscores (\_).
|
179
189
|
#
|
180
190
|
# </note>
|
181
191
|
# @return [String]
|
@@ -194,6 +204,7 @@ module Aws::SQS
|
|
194
204
|
:id,
|
195
205
|
:receipt_handle,
|
196
206
|
:visibility_timeout)
|
207
|
+
SENSITIVE = []
|
197
208
|
include Aws::Structure
|
198
209
|
end
|
199
210
|
|
@@ -214,6 +225,7 @@ module Aws::SQS
|
|
214
225
|
class ChangeMessageVisibilityBatchResult < Struct.new(
|
215
226
|
:successful,
|
216
227
|
:failed)
|
228
|
+
SENSITIVE = []
|
217
229
|
include Aws::Structure
|
218
230
|
end
|
219
231
|
|
@@ -228,6 +240,7 @@ module Aws::SQS
|
|
228
240
|
#
|
229
241
|
class ChangeMessageVisibilityBatchResultEntry < Struct.new(
|
230
242
|
:id)
|
243
|
+
SENSITIVE = []
|
231
244
|
include Aws::Structure
|
232
245
|
end
|
233
246
|
|
@@ -255,7 +268,7 @@ module Aws::SQS
|
|
255
268
|
#
|
256
269
|
# @!attribute [rw] visibility_timeout
|
257
270
|
# The new value for the message's visibility timeout (in seconds).
|
258
|
-
# Values
|
271
|
+
# Values range: `0` to `43200`. Maximum: 12 hours.
|
259
272
|
# @return [Integer]
|
260
273
|
#
|
261
274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityRequest AWS API Documentation
|
@@ -264,6 +277,7 @@ module Aws::SQS
|
|
264
277
|
:queue_url,
|
265
278
|
:receipt_handle,
|
266
279
|
:visibility_timeout)
|
280
|
+
SENSITIVE = []
|
267
281
|
include Aws::Structure
|
268
282
|
end
|
269
283
|
|
@@ -299,40 +313,40 @@ module Aws::SQS
|
|
299
313
|
# The following lists the names, descriptions, and values of the
|
300
314
|
# special request parameters that the `CreateQueue` action uses:
|
301
315
|
#
|
302
|
-
# * `DelaySeconds`
|
316
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
303
317
|
# delivery of all messages in the queue is delayed. Valid values: An
|
304
318
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
305
319
|
#
|
306
|
-
# * `MaximumMessageSize`
|
320
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
307
321
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
308
322
|
# from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
|
309
323
|
# 262,144 (256 KiB).
|
310
324
|
#
|
311
|
-
# * `MessageRetentionPeriod`
|
325
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
312
326
|
# which Amazon SQS retains a message. Valid values: An integer from
|
313
327
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
314
328
|
# 345,600 (4 days).
|
315
329
|
#
|
316
|
-
# * `Policy`
|
330
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
317
331
|
# information about policy structure, see [Overview of AWS IAM
|
318
332
|
# Policies][1] in the *Amazon IAM User Guide*.
|
319
333
|
#
|
320
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
334
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
321
335
|
# for which a ` ReceiveMessage ` action waits for a message to
|
322
336
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
323
337
|
# 0.
|
324
338
|
#
|
325
|
-
# * `RedrivePolicy`
|
326
|
-
# dead-letter queue functionality of the source queue
|
327
|
-
# information about the redrive policy and
|
328
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
329
|
-
# Queue Service Developer Guide*.
|
339
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
|
+
# dead-letter queue functionality of the source queue as a JSON
|
341
|
+
# object. For more information about the redrive policy and
|
342
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
330
344
|
#
|
331
|
-
# * `deadLetterTargetArn`
|
345
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
332
346
|
# dead-letter queue to which Amazon SQS moves messages after the
|
333
347
|
# value of `maxReceiveCount` is exceeded.
|
334
348
|
#
|
335
|
-
# * `maxReceiveCount`
|
349
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
336
350
|
# to the source queue before being moved to the dead-letter queue.
|
337
351
|
# When the `ReceiveCount` for a message exceeds the
|
338
352
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -344,7 +358,7 @@ module Aws::SQS
|
|
344
358
|
#
|
345
359
|
# </note>
|
346
360
|
#
|
347
|
-
# * `VisibilityTimeout`
|
361
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
348
362
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
349
363
|
# Default: 30. For more information about the visibility timeout,
|
350
364
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -352,14 +366,14 @@ module Aws::SQS
|
|
352
366
|
#
|
353
367
|
# The following attributes apply only to [server-side-encryption][4]\:
|
354
368
|
#
|
355
|
-
# * `KmsMasterKeyId`
|
369
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
356
370
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
357
371
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
358
372
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
359
373
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
360
374
|
# the *AWS Key Management Service API Reference*.
|
361
375
|
#
|
362
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
376
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
363
377
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
364
378
|
# decrypt messages before calling AWS KMS again. An integer
|
365
379
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -371,7 +385,7 @@ module Aws::SQS
|
|
371
385
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
372
386
|
# queues][9]\:
|
373
387
|
#
|
374
|
-
# * `FifoQueue`
|
388
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
375
389
|
# `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
376
390
|
# SQS creates a standard queue. You can provide this attribute only
|
377
391
|
# during queue creation. You can't change it for an existing queue.
|
@@ -381,7 +395,7 @@ module Aws::SQS
|
|
381
395
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
382
396
|
# Simple Queue Service Developer Guide*.
|
383
397
|
#
|
384
|
-
# * `ContentBasedDeduplication`
|
398
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
385
399
|
# Valid values: `true`, `false`. For more information, see
|
386
400
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
387
401
|
# Developer Guide*.
|
@@ -471,6 +485,7 @@ module Aws::SQS
|
|
471
485
|
:queue_name,
|
472
486
|
:attributes,
|
473
487
|
:tags)
|
488
|
+
SENSITIVE = []
|
474
489
|
include Aws::Structure
|
475
490
|
end
|
476
491
|
|
@@ -484,6 +499,7 @@ module Aws::SQS
|
|
484
499
|
#
|
485
500
|
class CreateQueueResult < Struct.new(
|
486
501
|
:queue_url)
|
502
|
+
SENSITIVE = []
|
487
503
|
include Aws::Structure
|
488
504
|
end
|
489
505
|
|
@@ -515,6 +531,7 @@ module Aws::SQS
|
|
515
531
|
class DeleteMessageBatchRequest < Struct.new(
|
516
532
|
:queue_url,
|
517
533
|
:entries)
|
534
|
+
SENSITIVE = []
|
518
535
|
include Aws::Structure
|
519
536
|
end
|
520
537
|
|
@@ -532,7 +549,11 @@ module Aws::SQS
|
|
532
549
|
# An identifier for this particular receipt handle. This is used to
|
533
550
|
# communicate the result.
|
534
551
|
#
|
535
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
552
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
553
|
+
#
|
554
|
+
# This identifier can have up to 80 characters. The following
|
555
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
556
|
+
# underscores (\_).
|
536
557
|
#
|
537
558
|
# </note>
|
538
559
|
# @return [String]
|
@@ -546,6 +567,7 @@ module Aws::SQS
|
|
546
567
|
class DeleteMessageBatchRequestEntry < Struct.new(
|
547
568
|
:id,
|
548
569
|
:receipt_handle)
|
570
|
+
SENSITIVE = []
|
549
571
|
include Aws::Structure
|
550
572
|
end
|
551
573
|
|
@@ -566,6 +588,7 @@ module Aws::SQS
|
|
566
588
|
class DeleteMessageBatchResult < Struct.new(
|
567
589
|
:successful,
|
568
590
|
:failed)
|
591
|
+
SENSITIVE = []
|
569
592
|
include Aws::Structure
|
570
593
|
end
|
571
594
|
|
@@ -579,6 +602,7 @@ module Aws::SQS
|
|
579
602
|
#
|
580
603
|
class DeleteMessageBatchResultEntry < Struct.new(
|
581
604
|
:id)
|
605
|
+
SENSITIVE = []
|
582
606
|
include Aws::Structure
|
583
607
|
end
|
584
608
|
|
@@ -605,6 +629,7 @@ module Aws::SQS
|
|
605
629
|
class DeleteMessageRequest < Struct.new(
|
606
630
|
:queue_url,
|
607
631
|
:receipt_handle)
|
632
|
+
SENSITIVE = []
|
608
633
|
include Aws::Structure
|
609
634
|
end
|
610
635
|
|
@@ -625,6 +650,7 @@ module Aws::SQS
|
|
625
650
|
#
|
626
651
|
class DeleteQueueRequest < Struct.new(
|
627
652
|
:queue_url)
|
653
|
+
SENSITIVE = []
|
628
654
|
include Aws::Structure
|
629
655
|
end
|
630
656
|
|
@@ -660,74 +686,81 @@ module Aws::SQS
|
|
660
686
|
#
|
661
687
|
# The following attributes are supported:
|
662
688
|
#
|
663
|
-
#
|
689
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
690
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
691
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
692
|
+
# consistency until at least 1 minute after the producers stop sending
|
693
|
+
# messages. This period is required for the queue metadata to reach
|
694
|
+
# eventual consistency.
|
695
|
+
#
|
696
|
+
# * `All` – Returns all values.
|
664
697
|
#
|
665
|
-
# * `ApproximateNumberOfMessages`
|
698
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
666
699
|
# messages available for retrieval from the queue.
|
667
700
|
#
|
668
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
701
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
669
702
|
# number of messages in the queue that are delayed and not available
|
670
703
|
# for reading immediately. This can happen when the queue is
|
671
704
|
# configured as a delay queue or when a message has been sent with a
|
672
705
|
# delay parameter.
|
673
706
|
#
|
674
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
707
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
675
708
|
# number of messages that are in flight. Messages are considered to
|
676
709
|
# be *in flight* if they have been sent to a client but have not yet
|
677
710
|
# been deleted or have not yet reached the end of their visibility
|
678
711
|
# window.
|
679
712
|
#
|
680
|
-
# * `CreatedTimestamp`
|
713
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created
|
681
714
|
# in seconds ([epoch time][1]).
|
682
715
|
#
|
683
|
-
# * `DelaySeconds`
|
716
|
+
# * `DelaySeconds` – Returns the default delay on the queue in
|
684
717
|
# seconds.
|
685
718
|
#
|
686
|
-
# * `LastModifiedTimestamp`
|
719
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
687
720
|
# changed in seconds ([epoch time][1]).
|
688
721
|
#
|
689
|
-
# * `MaximumMessageSize`
|
722
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a
|
690
723
|
# message can contain before Amazon SQS rejects it.
|
691
724
|
#
|
692
|
-
# * `MessageRetentionPeriod`
|
725
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
693
726
|
# for which Amazon SQS retains a message.
|
694
727
|
#
|
695
|
-
# * `Policy`
|
728
|
+
# * `Policy` – Returns the policy of the queue.
|
696
729
|
#
|
697
|
-
# * `QueueArn`
|
730
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
698
731
|
#
|
699
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
732
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
700
733
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
701
734
|
# to arrive.
|
702
735
|
#
|
703
|
-
# * `RedrivePolicy`
|
704
|
-
#
|
705
|
-
# information about the redrive policy and
|
706
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
707
|
-
# Queue Service Developer Guide*.
|
736
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
737
|
+
# dead-letter queue functionality of the source queue as a JSON
|
738
|
+
# object. For more information about the redrive policy and
|
739
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
740
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
708
741
|
#
|
709
|
-
# * `deadLetterTargetArn`
|
742
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
710
743
|
# dead-letter queue to which Amazon SQS moves messages after the
|
711
744
|
# value of `maxReceiveCount` is exceeded.
|
712
745
|
#
|
713
|
-
# * `maxReceiveCount`
|
746
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
714
747
|
# to the source queue before being moved to the dead-letter queue.
|
715
748
|
# When the `ReceiveCount` for a message exceeds the
|
716
749
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
717
750
|
# the dead-letter-queue.
|
718
751
|
#
|
719
|
-
# * `VisibilityTimeout`
|
752
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
720
753
|
# queue. For more information about the visibility timeout, see
|
721
754
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
722
755
|
# Developer Guide*.
|
723
756
|
#
|
724
757
|
# The following attributes apply only to [server-side-encryption][4]\:
|
725
758
|
#
|
726
|
-
# * `KmsMasterKeyId`
|
759
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer
|
727
760
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
728
761
|
# information, see [Key Terms][5].
|
729
762
|
#
|
730
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
763
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
731
764
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
732
765
|
# decrypt messages before calling AWS KMS again. For more
|
733
766
|
# information, see [How Does the Data Key Reuse Period Work?][6].
|
@@ -735,7 +768,7 @@ module Aws::SQS
|
|
735
768
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
736
769
|
# queues][7]\:
|
737
770
|
#
|
738
|
-
# * `FifoQueue`
|
771
|
+
# * `FifoQueue` – Returns whether the queue is FIFO. For more
|
739
772
|
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
740
773
|
# Service Developer Guide*.
|
741
774
|
#
|
@@ -744,7 +777,7 @@ module Aws::SQS
|
|
744
777
|
#
|
745
778
|
# </note>
|
746
779
|
#
|
747
|
-
# * `ContentBasedDeduplication`
|
780
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
748
781
|
# deduplication is enabled for the queue. For more information, see
|
749
782
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
750
783
|
# Developer Guide*.
|
@@ -767,6 +800,7 @@ module Aws::SQS
|
|
767
800
|
class GetQueueAttributesRequest < Struct.new(
|
768
801
|
:queue_url,
|
769
802
|
:attribute_names)
|
803
|
+
SENSITIVE = []
|
770
804
|
include Aws::Structure
|
771
805
|
end
|
772
806
|
|
@@ -780,6 +814,7 @@ module Aws::SQS
|
|
780
814
|
#
|
781
815
|
class GetQueueAttributesResult < Struct.new(
|
782
816
|
:attributes)
|
817
|
+
SENSITIVE = []
|
783
818
|
include Aws::Structure
|
784
819
|
end
|
785
820
|
|
@@ -808,6 +843,7 @@ module Aws::SQS
|
|
808
843
|
class GetQueueUrlRequest < Struct.new(
|
809
844
|
:queue_name,
|
810
845
|
:queue_owner_aws_account_id)
|
846
|
+
SENSITIVE = []
|
811
847
|
include Aws::Structure
|
812
848
|
end
|
813
849
|
|
@@ -826,6 +862,7 @@ module Aws::SQS
|
|
826
862
|
#
|
827
863
|
class GetQueueUrlResult < Struct.new(
|
828
864
|
:queue_url)
|
865
|
+
SENSITIVE = []
|
829
866
|
include Aws::Structure
|
830
867
|
end
|
831
868
|
|
@@ -859,6 +896,8 @@ module Aws::SQS
|
|
859
896
|
#
|
860
897
|
# {
|
861
898
|
# queue_url: "String", # required
|
899
|
+
# next_token: "Token",
|
900
|
+
# max_results: 1,
|
862
901
|
# }
|
863
902
|
#
|
864
903
|
# @!attribute [rw] queue_url
|
@@ -867,10 +906,23 @@ module Aws::SQS
|
|
867
906
|
# Queue URLs and names are case-sensitive.
|
868
907
|
# @return [String]
|
869
908
|
#
|
909
|
+
# @!attribute [rw] next_token
|
910
|
+
# Pagination token to request the next set of results.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] max_results
|
914
|
+
# Maximum number of results to include in the response. Value range is
|
915
|
+
# 1 to 1000. You must set `MaxResults` to receive a value for
|
916
|
+
# `NextToken` in the response.
|
917
|
+
# @return [Integer]
|
918
|
+
#
|
870
919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
|
871
920
|
#
|
872
921
|
class ListDeadLetterSourceQueuesRequest < Struct.new(
|
873
|
-
:queue_url
|
922
|
+
:queue_url,
|
923
|
+
:next_token,
|
924
|
+
:max_results)
|
925
|
+
SENSITIVE = []
|
874
926
|
include Aws::Structure
|
875
927
|
end
|
876
928
|
|
@@ -881,10 +933,18 @@ module Aws::SQS
|
|
881
933
|
# attribute configured with a dead-letter queue.
|
882
934
|
# @return [Array<String>]
|
883
935
|
#
|
936
|
+
# @!attribute [rw] next_token
|
937
|
+
# Pagination token to include in the next request. Token value is
|
938
|
+
# `null` if there are no additional results to request, or if you did
|
939
|
+
# not set `MaxResults` in the request.
|
940
|
+
# @return [String]
|
941
|
+
#
|
884
942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
|
885
943
|
#
|
886
944
|
class ListDeadLetterSourceQueuesResult < Struct.new(
|
887
|
-
:queue_urls
|
945
|
+
:queue_urls,
|
946
|
+
:next_token)
|
947
|
+
SENSITIVE = []
|
888
948
|
include Aws::Structure
|
889
949
|
end
|
890
950
|
|
@@ -903,6 +963,7 @@ module Aws::SQS
|
|
903
963
|
#
|
904
964
|
class ListQueueTagsRequest < Struct.new(
|
905
965
|
:queue_url)
|
966
|
+
SENSITIVE = []
|
906
967
|
include Aws::Structure
|
907
968
|
end
|
908
969
|
|
@@ -914,6 +975,7 @@ module Aws::SQS
|
|
914
975
|
#
|
915
976
|
class ListQueueTagsResult < Struct.new(
|
916
977
|
:tags)
|
978
|
+
SENSITIVE = []
|
917
979
|
include Aws::Structure
|
918
980
|
end
|
919
981
|
|
@@ -922,6 +984,8 @@ module Aws::SQS
|
|
922
984
|
#
|
923
985
|
# {
|
924
986
|
# queue_name_prefix: "String",
|
987
|
+
# next_token: "Token",
|
988
|
+
# max_results: 1,
|
925
989
|
# }
|
926
990
|
#
|
927
991
|
# @!attribute [rw] queue_name_prefix
|
@@ -931,23 +995,45 @@ module Aws::SQS
|
|
931
995
|
# Queue URLs and names are case-sensitive.
|
932
996
|
# @return [String]
|
933
997
|
#
|
998
|
+
# @!attribute [rw] next_token
|
999
|
+
# Pagination token to request the next set of results.
|
1000
|
+
# @return [String]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] max_results
|
1003
|
+
# Maximum number of results to include in the response. Value range is
|
1004
|
+
# 1 to 1000. You must set `MaxResults` to receive a value for
|
1005
|
+
# `NextToken` in the response.
|
1006
|
+
# @return [Integer]
|
1007
|
+
#
|
934
1008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
|
935
1009
|
#
|
936
1010
|
class ListQueuesRequest < Struct.new(
|
937
|
-
:queue_name_prefix
|
1011
|
+
:queue_name_prefix,
|
1012
|
+
:next_token,
|
1013
|
+
:max_results)
|
1014
|
+
SENSITIVE = []
|
938
1015
|
include Aws::Structure
|
939
1016
|
end
|
940
1017
|
|
941
1018
|
# A list of your queues.
|
942
1019
|
#
|
943
1020
|
# @!attribute [rw] queue_urls
|
944
|
-
# A list of queue URLs, up to 1,000 entries
|
1021
|
+
# A list of queue URLs, up to 1,000 entries, or the value of
|
1022
|
+
# MaxResults that you sent in the request.
|
945
1023
|
# @return [Array<String>]
|
946
1024
|
#
|
1025
|
+
# @!attribute [rw] next_token
|
1026
|
+
# Pagination token to include in the next request. Token value is
|
1027
|
+
# `null` if there are no additional results to request, or if you did
|
1028
|
+
# not set `MaxResults` in the request.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
947
1031
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult AWS API Documentation
|
948
1032
|
#
|
949
1033
|
class ListQueuesResult < Struct.new(
|
950
|
-
:queue_urls
|
1034
|
+
:queue_urls,
|
1035
|
+
:next_token)
|
1036
|
+
SENSITIVE = []
|
951
1037
|
include Aws::Structure
|
952
1038
|
end
|
953
1039
|
|
@@ -1019,7 +1105,7 @@ module Aws::SQS
|
|
1019
1105
|
#
|
1020
1106
|
#
|
1021
1107
|
#
|
1022
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1108
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1023
1109
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1024
1110
|
#
|
1025
1111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/Message AWS API Documentation
|
@@ -1032,6 +1118,7 @@ module Aws::SQS
|
|
1032
1118
|
:attributes,
|
1033
1119
|
:md5_of_message_attributes,
|
1034
1120
|
:message_attributes)
|
1121
|
+
SENSITIVE = []
|
1035
1122
|
include Aws::Structure
|
1036
1123
|
end
|
1037
1124
|
|
@@ -1088,7 +1175,7 @@ module Aws::SQS
|
|
1088
1175
|
#
|
1089
1176
|
#
|
1090
1177
|
#
|
1091
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1178
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1092
1179
|
# @return [String]
|
1093
1180
|
#
|
1094
1181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageAttributeValue AWS API Documentation
|
@@ -1099,6 +1186,7 @@ module Aws::SQS
|
|
1099
1186
|
:string_list_values,
|
1100
1187
|
:binary_list_values,
|
1101
1188
|
:data_type)
|
1189
|
+
SENSITIVE = []
|
1102
1190
|
include Aws::Structure
|
1103
1191
|
end
|
1104
1192
|
|
@@ -1159,7 +1247,7 @@ module Aws::SQS
|
|
1159
1247
|
#
|
1160
1248
|
#
|
1161
1249
|
#
|
1162
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1250
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1163
1251
|
# @return [String]
|
1164
1252
|
#
|
1165
1253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageSystemAttributeValue AWS API Documentation
|
@@ -1170,6 +1258,7 @@ module Aws::SQS
|
|
1170
1258
|
:string_list_values,
|
1171
1259
|
:binary_list_values,
|
1172
1260
|
:data_type)
|
1261
|
+
SENSITIVE = []
|
1173
1262
|
include Aws::Structure
|
1174
1263
|
end
|
1175
1264
|
|
@@ -1208,6 +1297,7 @@ module Aws::SQS
|
|
1208
1297
|
#
|
1209
1298
|
class PurgeQueueRequest < Struct.new(
|
1210
1299
|
:queue_url)
|
1300
|
+
SENSITIVE = []
|
1211
1301
|
include Aws::Structure
|
1212
1302
|
end
|
1213
1303
|
|
@@ -1261,16 +1351,16 @@ module Aws::SQS
|
|
1261
1351
|
# A list of attributes that need to be returned along with each
|
1262
1352
|
# message. These attributes include:
|
1263
1353
|
#
|
1264
|
-
# * `All`
|
1354
|
+
# * `All` – Returns all values.
|
1265
1355
|
#
|
1266
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1356
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1267
1357
|
# was first received from the queue ([epoch time][1] in
|
1268
1358
|
# milliseconds).
|
1269
1359
|
#
|
1270
|
-
# * `ApproximateReceiveCount`
|
1271
|
-
# has been received
|
1360
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1361
|
+
# has been received across all queues but not deleted.
|
1272
1362
|
#
|
1273
|
-
# * `AWSTraceHeader`
|
1363
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1274
1364
|
#
|
1275
1365
|
# * `SenderId`
|
1276
1366
|
#
|
@@ -1280,17 +1370,17 @@ module Aws::SQS
|
|
1280
1370
|
# * For an IAM role, returns the IAM role ID, for example
|
1281
1371
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1282
1372
|
#
|
1283
|
-
# * `SentTimestamp`
|
1373
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1284
1374
|
# queue ([epoch time][1] in milliseconds).
|
1285
1375
|
#
|
1286
|
-
# * `MessageDeduplicationId`
|
1376
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1287
1377
|
# producer that calls the ` SendMessage ` action.
|
1288
1378
|
#
|
1289
|
-
# * `MessageGroupId`
|
1379
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1290
1380
|
# calls the ` SendMessage ` action. Messages with the same
|
1291
1381
|
# `MessageGroupId` are returned in sequence.
|
1292
1382
|
#
|
1293
|
-
# * `SequenceNumber`
|
1383
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1294
1384
|
#
|
1295
1385
|
#
|
1296
1386
|
#
|
@@ -1338,6 +1428,18 @@ module Aws::SQS
|
|
1338
1428
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1339
1429
|
# available and the wait time expires, the call returns successfully
|
1340
1430
|
# with an empty list of messages.
|
1431
|
+
#
|
1432
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1433
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1434
|
+
# parameter. For example, with the Java SDK, you can set HTTP
|
1435
|
+
# transport settings using the [ NettyNioAsyncHttpClient][1] for
|
1436
|
+
# asynchronous clients, or the [ ApacheHttpClient][2] for synchronous
|
1437
|
+
# clients.
|
1438
|
+
#
|
1439
|
+
#
|
1440
|
+
#
|
1441
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1442
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1341
1443
|
# @return [Integer]
|
1342
1444
|
#
|
1343
1445
|
# @!attribute [rw] receive_request_attempt_id
|
@@ -1345,10 +1447,10 @@ module Aws::SQS
|
|
1345
1447
|
#
|
1346
1448
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1347
1449
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1348
|
-
# of a response you receive a generic error,
|
1349
|
-
# action with an identical `ReceiveRequestAttemptId` to
|
1350
|
-
# same set of messages, even if their visibility timeout
|
1351
|
-
# expired.
|
1450
|
+
# of a response you receive a generic error, it is possible to retry
|
1451
|
+
# the same action with an identical `ReceiveRequestAttemptId` to
|
1452
|
+
# retrieve the same set of messages, even if their visibility timeout
|
1453
|
+
# has not yet expired.
|
1352
1454
|
#
|
1353
1455
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
1354
1456
|
# `ReceiveMessage` action.
|
@@ -1360,7 +1462,7 @@ module Aws::SQS
|
|
1360
1462
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1361
1463
|
# `ReceiveRequestAttemptId`.
|
1362
1464
|
#
|
1363
|
-
# *
|
1465
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1364
1466
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1365
1467
|
# modified (deleted or had their visibility changes).
|
1366
1468
|
#
|
@@ -1394,7 +1496,7 @@ module Aws::SQS
|
|
1394
1496
|
# visibility timeout expires. As a result, delays might occur but
|
1395
1497
|
# the messages in the queue remain in a strict order.
|
1396
1498
|
#
|
1397
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1499
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1398
1500
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters
|
1399
1501
|
# (`a-z`, `A-Z`, `0-9`) and punctuation (``
|
1400
1502
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
@@ -1419,6 +1521,7 @@ module Aws::SQS
|
|
1419
1521
|
:visibility_timeout,
|
1420
1522
|
:wait_time_seconds,
|
1421
1523
|
:receive_request_attempt_id)
|
1524
|
+
SENSITIVE = []
|
1422
1525
|
include Aws::Structure
|
1423
1526
|
end
|
1424
1527
|
|
@@ -1432,6 +1535,7 @@ module Aws::SQS
|
|
1432
1535
|
#
|
1433
1536
|
class ReceiveMessageResult < Struct.new(
|
1434
1537
|
:messages)
|
1538
|
+
SENSITIVE = []
|
1435
1539
|
include Aws::Structure
|
1436
1540
|
end
|
1437
1541
|
|
@@ -1459,6 +1563,7 @@ module Aws::SQS
|
|
1459
1563
|
class RemovePermissionRequest < Struct.new(
|
1460
1564
|
:queue_url,
|
1461
1565
|
:label)
|
1566
|
+
SENSITIVE = []
|
1462
1567
|
include Aws::Structure
|
1463
1568
|
end
|
1464
1569
|
|
@@ -1511,6 +1616,7 @@ module Aws::SQS
|
|
1511
1616
|
class SendMessageBatchRequest < Struct.new(
|
1512
1617
|
:queue_url,
|
1513
1618
|
:entries)
|
1619
|
+
SENSITIVE = []
|
1514
1620
|
include Aws::Structure
|
1515
1621
|
end
|
1516
1622
|
|
@@ -1550,7 +1656,7 @@ module Aws::SQS
|
|
1550
1656
|
# An identifier for a message in this batch used to communicate the
|
1551
1657
|
# result.
|
1552
1658
|
#
|
1553
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
1659
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
1554
1660
|
#
|
1555
1661
|
# This identifier can have up to 80 characters. The following
|
1556
1662
|
# characters are accepted: alphanumeric characters, hyphens(-), and
|
@@ -1583,7 +1689,7 @@ module Aws::SQS
|
|
1583
1689
|
#
|
1584
1690
|
#
|
1585
1691
|
#
|
1586
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1692
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1587
1693
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1588
1694
|
#
|
1589
1695
|
# @!attribute [rw] message_system_attributes
|
@@ -1592,7 +1698,7 @@ module Aws::SQS
|
|
1592
1698
|
#
|
1593
1699
|
# * Currently, the only supported message system attribute is
|
1594
1700
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1595
|
-
# a correctly formatted AWS X-Ray trace string.
|
1701
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1596
1702
|
#
|
1597
1703
|
# * The size of a message system attribute doesn't count towards the
|
1598
1704
|
# total size of a message.
|
@@ -1710,6 +1816,7 @@ module Aws::SQS
|
|
1710
1816
|
:message_system_attributes,
|
1711
1817
|
:message_deduplication_id,
|
1712
1818
|
:message_group_id)
|
1819
|
+
SENSITIVE = []
|
1713
1820
|
include Aws::Structure
|
1714
1821
|
end
|
1715
1822
|
|
@@ -1731,6 +1838,7 @@ module Aws::SQS
|
|
1731
1838
|
class SendMessageBatchResult < Struct.new(
|
1732
1839
|
:successful,
|
1733
1840
|
:failed)
|
1841
|
+
SENSITIVE = []
|
1734
1842
|
include Aws::Structure
|
1735
1843
|
end
|
1736
1844
|
|
@@ -1800,6 +1908,7 @@ module Aws::SQS
|
|
1800
1908
|
:md5_of_message_attributes,
|
1801
1909
|
:md5_of_message_system_attributes,
|
1802
1910
|
:sequence_number)
|
1911
|
+
SENSITIVE = []
|
1803
1912
|
include Aws::Structure
|
1804
1913
|
end
|
1805
1914
|
|
@@ -1839,7 +1948,8 @@ module Aws::SQS
|
|
1839
1948
|
# @return [String]
|
1840
1949
|
#
|
1841
1950
|
# @!attribute [rw] message_body
|
1842
|
-
# The message to send. The
|
1951
|
+
# The message to send. The minimum size is one character. The maximum
|
1952
|
+
# size is 256 KB.
|
1843
1953
|
#
|
1844
1954
|
# A message can include only XML, JSON, and unformatted text. The
|
1845
1955
|
# following Unicode characters are allowed:
|
@@ -1875,7 +1985,7 @@ module Aws::SQS
|
|
1875
1985
|
#
|
1876
1986
|
#
|
1877
1987
|
#
|
1878
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1988
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1879
1989
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1880
1990
|
#
|
1881
1991
|
# @!attribute [rw] message_system_attributes
|
@@ -1884,7 +1994,7 @@ module Aws::SQS
|
|
1884
1994
|
#
|
1885
1995
|
# * Currently, the only supported message system attribute is
|
1886
1996
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1887
|
-
# a correctly formatted AWS X-Ray trace string.
|
1997
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1888
1998
|
#
|
1889
1999
|
# * The size of a message system attribute doesn't count towards the
|
1890
2000
|
# total size of a message.
|
@@ -1941,7 +2051,7 @@ module Aws::SQS
|
|
1941
2051
|
#
|
1942
2052
|
# </note>
|
1943
2053
|
#
|
1944
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
2054
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1945
2055
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1946
2056
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1947
2057
|
# ``).
|
@@ -2002,6 +2112,7 @@ module Aws::SQS
|
|
2002
2112
|
:message_system_attributes,
|
2003
2113
|
:message_deduplication_id,
|
2004
2114
|
:message_group_id)
|
2115
|
+
SENSITIVE = []
|
2005
2116
|
include Aws::Structure
|
2006
2117
|
end
|
2007
2118
|
|
@@ -2066,6 +2177,7 @@ module Aws::SQS
|
|
2066
2177
|
:md5_of_message_system_attributes,
|
2067
2178
|
:message_id,
|
2068
2179
|
:sequence_number)
|
2180
|
+
SENSITIVE = []
|
2069
2181
|
include Aws::Structure
|
2070
2182
|
end
|
2071
2183
|
|
@@ -2092,40 +2204,40 @@ module Aws::SQS
|
|
2092
2204
|
# special request parameters that the `SetQueueAttributes` action
|
2093
2205
|
# uses:
|
2094
2206
|
#
|
2095
|
-
# * `DelaySeconds`
|
2207
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2096
2208
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2097
2209
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2098
2210
|
#
|
2099
|
-
# * `MaximumMessageSize`
|
2211
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2100
2212
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
2101
2213
|
# from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
|
2102
2214
|
# 262,144 (256 KiB).
|
2103
2215
|
#
|
2104
|
-
# * `MessageRetentionPeriod`
|
2216
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2105
2217
|
# which Amazon SQS retains a message. Valid values: An integer
|
2106
2218
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2107
2219
|
# Default: 345,600 (4 days).
|
2108
2220
|
#
|
2109
|
-
# * `Policy`
|
2221
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2110
2222
|
# information about policy structure, see [Overview of AWS IAM
|
2111
2223
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2112
2224
|
#
|
2113
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2225
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2114
2226
|
# for which a ` ReceiveMessage ` action waits for a message to
|
2115
|
-
# arrive. Valid values:
|
2227
|
+
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2116
2228
|
# 0.
|
2117
2229
|
#
|
2118
|
-
# * `RedrivePolicy`
|
2119
|
-
# dead-letter queue functionality of the source queue
|
2120
|
-
# information about the redrive policy and
|
2121
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
2122
|
-
# Queue Service Developer Guide*.
|
2230
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2231
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2232
|
+
# object. For more information about the redrive policy and
|
2233
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2234
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
2123
2235
|
#
|
2124
|
-
# * `deadLetterTargetArn`
|
2236
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2125
2237
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2126
2238
|
# value of `maxReceiveCount` is exceeded.
|
2127
2239
|
#
|
2128
|
-
# * `maxReceiveCount`
|
2240
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
2129
2241
|
# to the source queue before being moved to the dead-letter queue.
|
2130
2242
|
# When the `ReceiveCount` for a message exceeds the
|
2131
2243
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -2137,22 +2249,22 @@ module Aws::SQS
|
|
2137
2249
|
#
|
2138
2250
|
# </note>
|
2139
2251
|
#
|
2140
|
-
# * `VisibilityTimeout`
|
2141
|
-
# seconds. Valid values:
|
2252
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2253
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2142
2254
|
# Default: 30. For more information about the visibility timeout,
|
2143
2255
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2144
2256
|
# Developer Guide*.
|
2145
2257
|
#
|
2146
2258
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2147
2259
|
#
|
2148
|
-
# * `KmsMasterKeyId`
|
2260
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2149
2261
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
2150
2262
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
2151
2263
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
2152
2264
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
2153
2265
|
# the *AWS Key Management Service API Reference*.
|
2154
2266
|
#
|
2155
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2267
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
2156
2268
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
2157
2269
|
# decrypt messages before calling AWS KMS again. An integer
|
2158
2270
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -2164,7 +2276,7 @@ module Aws::SQS
|
|
2164
2276
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2165
2277
|
# queues][9]\:
|
2166
2278
|
#
|
2167
|
-
# * `ContentBasedDeduplication`
|
2279
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2168
2280
|
# For more information, see [Exactly-Once Processing][10] in the
|
2169
2281
|
# *Amazon Simple Queue Service Developer Guide*.
|
2170
2282
|
#
|
@@ -2215,6 +2327,7 @@ module Aws::SQS
|
|
2215
2327
|
class SetQueueAttributesRequest < Struct.new(
|
2216
2328
|
:queue_url,
|
2217
2329
|
:attributes)
|
2330
|
+
SENSITIVE = []
|
2218
2331
|
include Aws::Structure
|
2219
2332
|
end
|
2220
2333
|
|
@@ -2241,6 +2354,7 @@ module Aws::SQS
|
|
2241
2354
|
class TagQueueRequest < Struct.new(
|
2242
2355
|
:queue_url,
|
2243
2356
|
:tags)
|
2357
|
+
SENSITIVE = []
|
2244
2358
|
include Aws::Structure
|
2245
2359
|
end
|
2246
2360
|
|
@@ -2277,6 +2391,7 @@ module Aws::SQS
|
|
2277
2391
|
class UntagQueueRequest < Struct.new(
|
2278
2392
|
:queue_url,
|
2279
2393
|
:tag_keys)
|
2394
|
+
SENSITIVE = []
|
2280
2395
|
include Aws::Structure
|
2281
2396
|
end
|
2282
2397
|
|