aws-sdk-sqs 1.55.0 → 1.57.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +367 -141
- data/lib/aws-sdk-sqs/client_api.rb +76 -0
- data/lib/aws-sdk-sqs/endpoints.rb +42 -0
- data/lib/aws-sdk-sqs/errors.rb +11 -0
- data/lib/aws-sdk-sqs/message.rb +9 -3
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-sqs/queue.rb +95 -37
- data/lib/aws-sdk-sqs/resource.rb +67 -27
- data/lib/aws-sdk-sqs/types.rb +347 -75
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -108,6 +108,31 @@ module Aws::SQS
|
|
108
108
|
include Aws::Structure
|
109
109
|
end
|
110
110
|
|
111
|
+
# @!attribute [rw] task_handle
|
112
|
+
# An identifier associated with a message movement task.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTaskRequest AWS API Documentation
|
116
|
+
#
|
117
|
+
class CancelMessageMoveTaskRequest < Struct.new(
|
118
|
+
:task_handle)
|
119
|
+
SENSITIVE = []
|
120
|
+
include Aws::Structure
|
121
|
+
end
|
122
|
+
|
123
|
+
# @!attribute [rw] approximate_number_of_messages_moved
|
124
|
+
# The approximate number of messages already moved to the destination
|
125
|
+
# queue.
|
126
|
+
# @return [Integer]
|
127
|
+
#
|
128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTaskResult AWS API Documentation
|
129
|
+
#
|
130
|
+
class CancelMessageMoveTaskResult < Struct.new(
|
131
|
+
:approximate_number_of_messages_moved)
|
132
|
+
SENSITIVE = []
|
133
|
+
include Aws::Structure
|
134
|
+
end
|
135
|
+
|
111
136
|
# @!attribute [rw] queue_url
|
112
137
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
113
138
|
# changed.
|
@@ -116,7 +141,7 @@ module Aws::SQS
|
|
116
141
|
# @return [String]
|
117
142
|
#
|
118
143
|
# @!attribute [rw] entries
|
119
|
-
#
|
144
|
+
# Lists the receipt handles of the messages for which the visibility
|
120
145
|
# timeout must be changed.
|
121
146
|
# @return [Array<Types::ChangeMessageVisibilityBatchRequestEntry>]
|
122
147
|
#
|
@@ -129,20 +154,9 @@ module Aws::SQS
|
|
129
154
|
include Aws::Structure
|
130
155
|
end
|
131
156
|
|
132
|
-
# Encloses a receipt handle and an entry
|
157
|
+
# Encloses a receipt handle and an entry ID for each message in `
|
133
158
|
# ChangeMessageVisibilityBatch.`
|
134
159
|
#
|
135
|
-
# All of the following list parameters must be prefixed with
|
136
|
-
# `ChangeMessageVisibilityBatchRequestEntry.n`, where `n` is an integer
|
137
|
-
# value starting with `1`. For example, a parameter list for this action
|
138
|
-
# might look like this:
|
139
|
-
#
|
140
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
|
141
|
-
#
|
142
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle`
|
143
|
-
#
|
144
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
|
145
|
-
#
|
146
160
|
# @!attribute [rw] id
|
147
161
|
# An identifier for this particular receipt handle used to communicate
|
148
162
|
# the result.
|
@@ -218,7 +232,7 @@ module Aws::SQS
|
|
218
232
|
# @return [String]
|
219
233
|
#
|
220
234
|
# @!attribute [rw] receipt_handle
|
221
|
-
# The receipt handle associated with the message whose visibility
|
235
|
+
# The receipt handle associated with the message, whose visibility
|
222
236
|
# timeout is changed. This parameter is returned by the `
|
223
237
|
# ReceiveMessage ` action.
|
224
238
|
# @return [String]
|
@@ -269,23 +283,33 @@ module Aws::SQS
|
|
269
283
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
270
284
|
# which Amazon SQS retains a message. Valid values: An integer from
|
271
285
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
272
|
-
# 345,600 (4 days).
|
286
|
+
# 345,600 (4 days). When you change a queue's attributes, the
|
287
|
+
# change can take up to 60 seconds for most of the attributes to
|
288
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
289
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
290
|
+
# will impact existing messages in the queue potentially causing
|
291
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
292
|
+
# reduced below the age of existing messages.
|
273
293
|
#
|
274
294
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
275
295
|
# policy. For more information about policy structure, see [Overview
|
276
|
-
# of Amazon Web Services IAM Policies][1] in the *
|
277
|
-
# Guide*.
|
296
|
+
# of Amazon Web Services IAM Policies][1] in the *IAM User Guide*.
|
278
297
|
#
|
279
298
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
280
299
|
# for which a ` ReceiveMessage ` action waits for a message to
|
281
300
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
282
301
|
# 0.
|
283
302
|
#
|
303
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
304
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
305
|
+
# Default: 30. For more information about the visibility timeout,
|
306
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
307
|
+
#
|
308
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
309
|
+
#
|
284
310
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
285
311
|
# dead-letter queue functionality of the source queue as a JSON
|
286
|
-
# object.
|
287
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
288
|
-
# in the *Amazon SQS Developer Guide*.
|
312
|
+
# object. The parameters are as follows:
|
289
313
|
#
|
290
314
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
291
315
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -293,20 +317,42 @@ module Aws::SQS
|
|
293
317
|
#
|
294
318
|
# * `maxReceiveCount` – The number of times a message is delivered
|
295
319
|
# to the source queue before being moved to the dead-letter queue.
|
296
|
-
# When the `ReceiveCount` for a message exceeds the
|
320
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
297
321
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
298
322
|
# the dead-letter-queue.
|
299
323
|
#
|
300
|
-
#
|
301
|
-
#
|
302
|
-
# a
|
324
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
325
|
+
# the permissions for the dead-letter queue redrive permission and
|
326
|
+
# which source queues can specify dead-letter queues as a JSON
|
327
|
+
# object. The parameters are as follows:
|
303
328
|
#
|
304
|
-
#
|
329
|
+
# * `redrivePermission` – The permission type that defines which
|
330
|
+
# source queues can specify the current queue as the dead-letter
|
331
|
+
# queue. Valid values are:
|
305
332
|
#
|
306
|
-
#
|
307
|
-
#
|
308
|
-
#
|
309
|
-
#
|
333
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
334
|
+
# Services account in the same Region can specify this queue as
|
335
|
+
# the dead-letter queue.
|
336
|
+
#
|
337
|
+
# * `denyAll` – No source queues can specify this queue as the
|
338
|
+
# dead-letter queue.
|
339
|
+
#
|
340
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
341
|
+
# parameter can specify this queue as the dead-letter queue.
|
342
|
+
#
|
343
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
344
|
+
# source queues that can specify this queue as the dead-letter
|
345
|
+
# queue and redrive messages. You can specify this parameter only
|
346
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
347
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
348
|
+
# source queues to specify dead-letter queues, set the
|
349
|
+
# `redrivePermission` parameter to `allowAll`.
|
350
|
+
#
|
351
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
352
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
353
|
+
# standard queue.
|
354
|
+
#
|
355
|
+
# </note>
|
310
356
|
#
|
311
357
|
# The following attributes apply only to [server-side-encryption][4]:
|
312
358
|
#
|
@@ -325,11 +371,11 @@ module Aws::SQS
|
|
325
371
|
# hours). Default: 300 (5 minutes). A shorter time period provides
|
326
372
|
# better security but results in more calls to KMS which might incur
|
327
373
|
# charges after Free Tier. For more information, see [How Does the
|
328
|
-
# Data Key Reuse Period Work?][8]
|
374
|
+
# Data Key Reuse Period Work?][8]
|
329
375
|
#
|
330
376
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
331
377
|
# using SQS owned encryption keys. Only one server-side encryption
|
332
|
-
# option is supported per queue (
|
378
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
333
379
|
# [SSE-SQS][10]).
|
334
380
|
#
|
335
381
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
@@ -407,8 +453,8 @@ module Aws::SQS
|
|
407
453
|
#
|
408
454
|
#
|
409
455
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
410
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
411
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
456
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
457
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
412
458
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
413
459
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
414
460
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -448,7 +494,7 @@ module Aws::SQS
|
|
448
494
|
#
|
449
495
|
# Cross-account permissions don't apply to this action. For more
|
450
496
|
# information, see [Grant cross-account permissions to a role and a
|
451
|
-
#
|
497
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
452
498
|
#
|
453
499
|
# </note>
|
454
500
|
#
|
@@ -490,7 +536,7 @@ module Aws::SQS
|
|
490
536
|
# @return [String]
|
491
537
|
#
|
492
538
|
# @!attribute [rw] entries
|
493
|
-
#
|
539
|
+
# Lists the receipt handles for the messages to be deleted.
|
494
540
|
# @return [Array<Types::DeleteMessageBatchRequestEntry>]
|
495
541
|
#
|
496
542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchRequest AWS API Documentation
|
@@ -505,7 +551,7 @@ module Aws::SQS
|
|
505
551
|
# Encloses a receipt handle and an identifier for it.
|
506
552
|
#
|
507
553
|
# @!attribute [rw] id
|
508
|
-
#
|
554
|
+
# The identifier for this particular receipt handle. This is used to
|
509
555
|
# communicate the result.
|
510
556
|
#
|
511
557
|
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
@@ -614,7 +660,7 @@ module Aws::SQS
|
|
614
660
|
# @!attribute [rw] attribute_names
|
615
661
|
# A list of attributes for which to retrieve information.
|
616
662
|
#
|
617
|
-
# The `
|
663
|
+
# The `AttributeNames` parameter is optional, but if you don't
|
618
664
|
# specify values for this parameter, the request returns empty
|
619
665
|
# results.
|
620
666
|
#
|
@@ -628,10 +674,10 @@ module Aws::SQS
|
|
628
674
|
#
|
629
675
|
# The `ApproximateNumberOfMessagesDelayed`,
|
630
676
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
631
|
-
# `
|
632
|
-
#
|
633
|
-
#
|
634
|
-
#
|
677
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
678
|
+
# until at least 1 minute after the producers stop sending messages.
|
679
|
+
# This period is required for the queue metadata to reach eventual
|
680
|
+
# consistency.
|
635
681
|
#
|
636
682
|
# * `All` – Returns all values.
|
637
683
|
#
|
@@ -663,7 +709,14 @@ module Aws::SQS
|
|
663
709
|
# message can contain before Amazon SQS rejects it.
|
664
710
|
#
|
665
711
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
666
|
-
# for which Amazon SQS retains a message.
|
712
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
713
|
+
# attributes, the change can take up to 60 seconds for most of the
|
714
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
715
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
716
|
+
# minutes and will impact existing messages in the queue potentially
|
717
|
+
# causing them to be expired and deleted if the
|
718
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
719
|
+
# messages.
|
667
720
|
#
|
668
721
|
# * `Policy` – Returns the policy of the queue.
|
669
722
|
#
|
@@ -673,11 +726,15 @@ module Aws::SQS
|
|
673
726
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
674
727
|
# to arrive.
|
675
728
|
#
|
729
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
730
|
+
# queue. For more information about the visibility timeout, see
|
731
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
732
|
+
#
|
733
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
734
|
+
#
|
676
735
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
677
736
|
# dead-letter queue functionality of the source queue as a JSON
|
678
|
-
# object.
|
679
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
680
|
-
# in the *Amazon SQS Developer Guide*.
|
737
|
+
# object. The parameters are as follows:
|
681
738
|
#
|
682
739
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
683
740
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -685,13 +742,42 @@ module Aws::SQS
|
|
685
742
|
#
|
686
743
|
# * `maxReceiveCount` – The number of times a message is delivered
|
687
744
|
# to the source queue before being moved to the dead-letter queue.
|
688
|
-
# When the `ReceiveCount` for a message exceeds the
|
745
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
689
746
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
690
747
|
# the dead-letter-queue.
|
691
748
|
#
|
692
|
-
# * `
|
693
|
-
#
|
694
|
-
#
|
749
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
750
|
+
# the permissions for the dead-letter queue redrive permission and
|
751
|
+
# which source queues can specify dead-letter queues as a JSON
|
752
|
+
# object. The parameters are as follows:
|
753
|
+
#
|
754
|
+
# * `redrivePermission` – The permission type that defines which
|
755
|
+
# source queues can specify the current queue as the dead-letter
|
756
|
+
# queue. Valid values are:
|
757
|
+
#
|
758
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
759
|
+
# Services account in the same Region can specify this queue as
|
760
|
+
# the dead-letter queue.
|
761
|
+
#
|
762
|
+
# * `denyAll` – No source queues can specify this queue as the
|
763
|
+
# dead-letter queue.
|
764
|
+
#
|
765
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
766
|
+
# parameter can specify this queue as the dead-letter queue.
|
767
|
+
#
|
768
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
769
|
+
# source queues that can specify this queue as the dead-letter
|
770
|
+
# queue and redrive messages. You can specify this parameter only
|
771
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
772
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
773
|
+
# source queues to specify dead-letter queues, set the
|
774
|
+
# `redrivePermission` parameter to `allowAll`.
|
775
|
+
#
|
776
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
777
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
778
|
+
# standard queue.
|
779
|
+
#
|
780
|
+
# </note>
|
695
781
|
#
|
696
782
|
# The following attributes apply only to [server-side-encryption][4]:
|
697
783
|
#
|
@@ -706,8 +792,8 @@ module Aws::SQS
|
|
706
792
|
#
|
707
793
|
# * `SqsManagedSseEnabled` – Returns information about whether the
|
708
794
|
# queue is using SSE-SQS encryption using SQS owned encryption keys.
|
709
|
-
# Only one server-side encryption option is supported per queue
|
710
|
-
#
|
795
|
+
# Only one server-side encryption option is supported per queue (for
|
796
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
711
797
|
#
|
712
798
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
713
799
|
# queues][9]:
|
@@ -754,8 +840,8 @@ module Aws::SQS
|
|
754
840
|
#
|
755
841
|
#
|
756
842
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
757
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
758
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
843
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
844
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
759
845
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
760
846
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
761
847
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -905,6 +991,106 @@ module Aws::SQS
|
|
905
991
|
include Aws::Structure
|
906
992
|
end
|
907
993
|
|
994
|
+
# @!attribute [rw] source_arn
|
995
|
+
# The ARN of the queue whose message movement tasks are to be listed.
|
996
|
+
# @return [String]
|
997
|
+
#
|
998
|
+
# @!attribute [rw] max_results
|
999
|
+
# The maximum number of results to include in the response. The
|
1000
|
+
# default is 1, which provides the most recent message movement task.
|
1001
|
+
# The upper limit is 10.
|
1002
|
+
# @return [Integer]
|
1003
|
+
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksRequest AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class ListMessageMoveTasksRequest < Struct.new(
|
1007
|
+
:source_arn,
|
1008
|
+
:max_results)
|
1009
|
+
SENSITIVE = []
|
1010
|
+
include Aws::Structure
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
# @!attribute [rw] results
|
1014
|
+
# A list of message movement tasks and their attributes.
|
1015
|
+
# @return [Array<Types::ListMessageMoveTasksResultEntry>]
|
1016
|
+
#
|
1017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksResult AWS API Documentation
|
1018
|
+
#
|
1019
|
+
class ListMessageMoveTasksResult < Struct.new(
|
1020
|
+
:results)
|
1021
|
+
SENSITIVE = []
|
1022
|
+
include Aws::Structure
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# Contains the details of a message movement task.
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] task_handle
|
1028
|
+
# An identifier associated with a message movement task. When this
|
1029
|
+
# field is returned in the response of the `ListMessageMoveTasks`
|
1030
|
+
# action, it is only populated for tasks that are in RUNNING status.
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @!attribute [rw] status
|
1034
|
+
# The status of the message movement task. Possible values are:
|
1035
|
+
# RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.
|
1036
|
+
# @return [String]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] source_arn
|
1039
|
+
# The ARN of the queue that contains the messages to be moved to
|
1040
|
+
# another queue.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] destination_arn
|
1044
|
+
# The ARN of the destination queue if it has been specified in the
|
1045
|
+
# `StartMessageMoveTask` request. If a `DestinationArn` has not been
|
1046
|
+
# specified in the `StartMessageMoveTask` request, this field value
|
1047
|
+
# will be NULL.
|
1048
|
+
# @return [String]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] max_number_of_messages_per_second
|
1051
|
+
# The number of messages to be moved per second (the message movement
|
1052
|
+
# rate), if it has been specified in the `StartMessageMoveTask`
|
1053
|
+
# request. If a `MaxNumberOfMessagesPerSecond` has not been specified
|
1054
|
+
# in the `StartMessageMoveTask` request, this field value will be
|
1055
|
+
# NULL.
|
1056
|
+
# @return [Integer]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] approximate_number_of_messages_moved
|
1059
|
+
# The approximate number of messages already moved to the destination
|
1060
|
+
# queue.
|
1061
|
+
# @return [Integer]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] approximate_number_of_messages_to_move
|
1064
|
+
# The number of messages to be moved from the source queue. This
|
1065
|
+
# number is obtained at the time of starting the message movement
|
1066
|
+
# task.
|
1067
|
+
# @return [Integer]
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] failure_reason
|
1070
|
+
# The task failure reason (only included if the task status is
|
1071
|
+
# FAILED).
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] started_timestamp
|
1075
|
+
# The timestamp of starting the message movement task.
|
1076
|
+
# @return [Integer]
|
1077
|
+
#
|
1078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksResultEntry AWS API Documentation
|
1079
|
+
#
|
1080
|
+
class ListMessageMoveTasksResultEntry < Struct.new(
|
1081
|
+
:task_handle,
|
1082
|
+
:status,
|
1083
|
+
:source_arn,
|
1084
|
+
:destination_arn,
|
1085
|
+
:max_number_of_messages_per_second,
|
1086
|
+
:approximate_number_of_messages_moved,
|
1087
|
+
:approximate_number_of_messages_to_move,
|
1088
|
+
:failure_reason,
|
1089
|
+
:started_timestamp)
|
1090
|
+
SENSITIVE = []
|
1091
|
+
include Aws::Structure
|
1092
|
+
end
|
1093
|
+
|
908
1094
|
# @!attribute [rw] queue_url
|
909
1095
|
# The URL of the queue.
|
910
1096
|
# @return [String]
|
@@ -960,7 +1146,7 @@ module Aws::SQS
|
|
960
1146
|
#
|
961
1147
|
# @!attribute [rw] queue_urls
|
962
1148
|
# A list of queue URLs, up to 1,000 entries, or the value of
|
963
|
-
# MaxResults that you sent in the request.
|
1149
|
+
# `MaxResults` that you sent in the request.
|
964
1150
|
# @return [Array<String>]
|
965
1151
|
#
|
966
1152
|
# @!attribute [rw] next_token
|
@@ -1070,7 +1256,7 @@ module Aws::SQS
|
|
1070
1256
|
#
|
1071
1257
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1072
1258
|
# null. All parts of the message attribute, including `Name`, `Type`,
|
1073
|
-
# and `Value`, are part of the message size restriction (256
|
1259
|
+
# and `Value`, are part of the message size restriction (256 KiB or
|
1074
1260
|
# 262,144 bytes).
|
1075
1261
|
#
|
1076
1262
|
# @!attribute [rw] string_value
|
@@ -1181,7 +1367,7 @@ module Aws::SQS
|
|
1181
1367
|
end
|
1182
1368
|
|
1183
1369
|
# The specified action violates a limit. For example, `ReceiveMessage`
|
1184
|
-
# returns this error if the maximum number of
|
1370
|
+
# returns this error if the maximum number of in flight messages is
|
1185
1371
|
# reached and `AddPermission` returns this error if the maximum number
|
1186
1372
|
# of permissions for the queue is reached.
|
1187
1373
|
#
|
@@ -1262,7 +1448,7 @@ module Aws::SQS
|
|
1262
1448
|
#
|
1263
1449
|
# * `SenderId`
|
1264
1450
|
#
|
1265
|
-
# * For
|
1451
|
+
# * For a user, returns the user ID, for example
|
1266
1452
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1267
1453
|
#
|
1268
1454
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1273,7 +1459,8 @@ module Aws::SQS
|
|
1273
1459
|
#
|
1274
1460
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1275
1461
|
# using SQS owned encryption keys. Only one server-side encryption
|
1276
|
-
# option is supported per queue (
|
1462
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1463
|
+
# [SSE-SQS][3]).
|
1277
1464
|
#
|
1278
1465
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1279
1466
|
# producer that calls the ` SendMessage ` action.
|
@@ -1462,6 +1649,12 @@ module Aws::SQS
|
|
1462
1649
|
include Aws::Structure
|
1463
1650
|
end
|
1464
1651
|
|
1652
|
+
# One or more specified resources don't exist.
|
1653
|
+
#
|
1654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ResourceNotFoundException AWS API Documentation
|
1655
|
+
#
|
1656
|
+
class ResourceNotFoundException < Aws::EmptyStructure; end
|
1657
|
+
|
1465
1658
|
# @!attribute [rw] queue_url
|
1466
1659
|
# The URL of the Amazon SQS queue to which batched messages are sent.
|
1467
1660
|
#
|
@@ -1750,7 +1943,7 @@ module Aws::SQS
|
|
1750
1943
|
#
|
1751
1944
|
# @!attribute [rw] message_body
|
1752
1945
|
# The message to send. The minimum size is one character. The maximum
|
1753
|
-
# size is 256
|
1946
|
+
# size is 256 KiB.
|
1754
1947
|
#
|
1755
1948
|
# A message can include only XML, JSON, and unformatted text. The
|
1756
1949
|
# following Unicode characters are allowed:
|
@@ -2005,7 +2198,13 @@ module Aws::SQS
|
|
2005
2198
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2006
2199
|
# which Amazon SQS retains a message. Valid values: An integer
|
2007
2200
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2008
|
-
# Default: 345,600 (4 days).
|
2201
|
+
# Default: 345,600 (4 days). When you change a queue's attributes,
|
2202
|
+
# the change can take up to 60 seconds for most of the attributes to
|
2203
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
2204
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
2205
|
+
# will impact existing messages in the queue potentially causing
|
2206
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
2207
|
+
# reduced below the age of existing messages.
|
2009
2208
|
#
|
2010
2209
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2011
2210
|
# policy. For more information about policy structure, see [Overview
|
@@ -2017,11 +2216,16 @@ module Aws::SQS
|
|
2017
2216
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2018
2217
|
# 0.
|
2019
2218
|
#
|
2219
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2220
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2221
|
+
# Default: 30. For more information about the visibility timeout,
|
2222
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2223
|
+
#
|
2224
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2225
|
+
#
|
2020
2226
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2021
2227
|
# dead-letter queue functionality of the source queue as a JSON
|
2022
|
-
# object.
|
2023
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2024
|
-
# in the *Amazon SQS Developer Guide*.
|
2228
|
+
# object. The parameters are as follows:
|
2025
2229
|
#
|
2026
2230
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2027
2231
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2029,20 +2233,42 @@ module Aws::SQS
|
|
2029
2233
|
#
|
2030
2234
|
# * `maxReceiveCount` – The number of times a message is delivered
|
2031
2235
|
# to the source queue before being moved to the dead-letter queue.
|
2032
|
-
# When the `ReceiveCount` for a message exceeds the
|
2236
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2033
2237
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2034
2238
|
# the dead-letter-queue.
|
2035
2239
|
#
|
2036
|
-
#
|
2037
|
-
#
|
2038
|
-
# a
|
2240
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2241
|
+
# the permissions for the dead-letter queue redrive permission and
|
2242
|
+
# which source queues can specify dead-letter queues as a JSON
|
2243
|
+
# object. The parameters are as follows:
|
2039
2244
|
#
|
2040
|
-
#
|
2245
|
+
# * `redrivePermission` – The permission type that defines which
|
2246
|
+
# source queues can specify the current queue as the dead-letter
|
2247
|
+
# queue. Valid values are:
|
2041
2248
|
#
|
2042
|
-
#
|
2043
|
-
#
|
2044
|
-
#
|
2045
|
-
#
|
2249
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2250
|
+
# Services account in the same Region can specify this queue as
|
2251
|
+
# the dead-letter queue.
|
2252
|
+
#
|
2253
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2254
|
+
# dead-letter queue.
|
2255
|
+
#
|
2256
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2257
|
+
# parameter can specify this queue as the dead-letter queue.
|
2258
|
+
#
|
2259
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2260
|
+
# source queues that can specify this queue as the dead-letter
|
2261
|
+
# queue and redrive messages. You can specify this parameter only
|
2262
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2263
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
2264
|
+
# source queues to specify dead-letter queues, set the
|
2265
|
+
# `redrivePermission` parameter to `allowAll`.
|
2266
|
+
#
|
2267
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2268
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2269
|
+
# standard queue.
|
2270
|
+
#
|
2271
|
+
# </note>
|
2046
2272
|
#
|
2047
2273
|
# The following attributes apply only to [server-side-encryption][4]:
|
2048
2274
|
#
|
@@ -2065,7 +2291,7 @@ module Aws::SQS
|
|
2065
2291
|
#
|
2066
2292
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
2067
2293
|
# using SQS owned encryption keys. Only one server-side encryption
|
2068
|
-
# option is supported per queue (
|
2294
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
2069
2295
|
# [SSE-SQS][10]).
|
2070
2296
|
#
|
2071
2297
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
@@ -2132,8 +2358,8 @@ module Aws::SQS
|
|
2132
2358
|
#
|
2133
2359
|
#
|
2134
2360
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2135
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2136
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2361
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2362
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2137
2363
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2138
2364
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2139
2365
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2156,6 +2382,52 @@ module Aws::SQS
|
|
2156
2382
|
include Aws::Structure
|
2157
2383
|
end
|
2158
2384
|
|
2385
|
+
# @!attribute [rw] source_arn
|
2386
|
+
# The ARN of the queue that contains the messages to be moved to
|
2387
|
+
# another queue. Currently, only dead-letter queue (DLQ) ARNs are
|
2388
|
+
# accepted.
|
2389
|
+
# @return [String]
|
2390
|
+
#
|
2391
|
+
# @!attribute [rw] destination_arn
|
2392
|
+
# The ARN of the queue that receives the moved messages. You can use
|
2393
|
+
# this field to specify the destination queue where you would like to
|
2394
|
+
# redrive messages. If this field is left blank, the messages will be
|
2395
|
+
# redriven back to their respective original source queues.
|
2396
|
+
# @return [String]
|
2397
|
+
#
|
2398
|
+
# @!attribute [rw] max_number_of_messages_per_second
|
2399
|
+
# The number of messages to be moved per second (the message movement
|
2400
|
+
# rate). You can use this field to define a fixed message movement
|
2401
|
+
# rate. The maximum value for messages per second is 500. If this
|
2402
|
+
# field is left blank, the system will optimize the rate based on the
|
2403
|
+
# queue message backlog size, which may vary throughout the duration
|
2404
|
+
# of the message movement task.
|
2405
|
+
# @return [Integer]
|
2406
|
+
#
|
2407
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTaskRequest AWS API Documentation
|
2408
|
+
#
|
2409
|
+
class StartMessageMoveTaskRequest < Struct.new(
|
2410
|
+
:source_arn,
|
2411
|
+
:destination_arn,
|
2412
|
+
:max_number_of_messages_per_second)
|
2413
|
+
SENSITIVE = []
|
2414
|
+
include Aws::Structure
|
2415
|
+
end
|
2416
|
+
|
2417
|
+
# @!attribute [rw] task_handle
|
2418
|
+
# An identifier associated with a message movement task. You can use
|
2419
|
+
# this identifier to cancel a specified message movement task using
|
2420
|
+
# the `CancelMessageMoveTask` action.
|
2421
|
+
# @return [String]
|
2422
|
+
#
|
2423
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTaskResult AWS API Documentation
|
2424
|
+
#
|
2425
|
+
class StartMessageMoveTaskResult < Struct.new(
|
2426
|
+
:task_handle)
|
2427
|
+
SENSITIVE = []
|
2428
|
+
include Aws::Structure
|
2429
|
+
end
|
2430
|
+
|
2159
2431
|
# @!attribute [rw] queue_url
|
2160
2432
|
# The URL of the queue.
|
2161
2433
|
# @return [String]
|