aws-sdk-sqs 1.52.0 → 1.62.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 +57 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +434 -151
- data/lib/aws-sdk-sqs/client_api.rb +76 -0
- data/lib/aws-sdk-sqs/endpoint_provider.rb +41 -100
- data/lib/aws-sdk-sqs/endpoints.rb +43 -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 +98 -40
- data/lib/aws-sdk-sqs/queue_poller.rb +6 -0
- data/lib/aws-sdk-sqs/resource.rb +70 -30
- data/lib/aws-sdk-sqs/types.rb +351 -379
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -28,6 +28,7 @@ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
31
32
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
33
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
34
|
require 'aws-sdk-core/plugins/sign.rb'
|
@@ -79,6 +80,7 @@ module Aws::SQS
|
|
79
80
|
add_plugin(Aws::Plugins::TransferEncoding)
|
80
81
|
add_plugin(Aws::Plugins::HttpChecksum)
|
81
82
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
83
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
84
|
add_plugin(Aws::Plugins::DefaultsMode)
|
83
85
|
add_plugin(Aws::Plugins::RecursionDetection)
|
84
86
|
add_plugin(Aws::Plugins::Sign)
|
@@ -194,6 +196,10 @@ module Aws::SQS
|
|
194
196
|
# Set to true to disable SDK automatically adding host prefix
|
195
197
|
# to default service endpoint when available.
|
196
198
|
#
|
199
|
+
# @option options [Boolean] :disable_request_compression (false)
|
200
|
+
# When set to 'true' the request body will not be compressed
|
201
|
+
# for supported operations.
|
202
|
+
#
|
197
203
|
# @option options [String] :endpoint
|
198
204
|
# The client endpoint is normally constructed from the `:region`
|
199
205
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -214,6 +220,10 @@ module Aws::SQS
|
|
214
220
|
# @option options [Boolean] :endpoint_discovery (false)
|
215
221
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
216
222
|
#
|
223
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
224
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
225
|
+
# variables and the shared configuration file.
|
226
|
+
#
|
217
227
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
218
228
|
# The log formatter.
|
219
229
|
#
|
@@ -234,6 +244,11 @@ module Aws::SQS
|
|
234
244
|
# Used when loading credentials from the shared credentials file
|
235
245
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
236
246
|
#
|
247
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
248
|
+
# The minimum size in bytes that triggers compression for request
|
249
|
+
# bodies. The value must be non-negative integer value between 0
|
250
|
+
# and 10485780 bytes inclusive.
|
251
|
+
#
|
237
252
|
# @option options [Proc] :retry_backoff
|
238
253
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
239
254
|
# This option is only used in the `legacy` retry mode.
|
@@ -279,6 +294,11 @@ module Aws::SQS
|
|
279
294
|
# in the future.
|
280
295
|
#
|
281
296
|
#
|
297
|
+
# @option options [String] :sdk_ua_app_id
|
298
|
+
# A unique and opaque application ID that is appended to the
|
299
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
300
|
+
# maximum length of 50.
|
301
|
+
#
|
282
302
|
# @option options [String] :secret_access_key
|
283
303
|
#
|
284
304
|
# @option options [String] :session_token
|
@@ -392,25 +412,21 @@ module Aws::SQS
|
|
392
412
|
# see [Using Custom Policies with the Amazon SQS Access Policy
|
393
413
|
# Language][3] in the *Amazon SQS Developer Guide*.
|
394
414
|
#
|
395
|
-
# * An Amazon SQS policy can have a maximum of
|
415
|
+
# * An Amazon SQS policy can have a maximum of seven actions per
|
416
|
+
# statement.
|
396
417
|
#
|
397
418
|
# * To remove the ability to change queue permissions, you must deny
|
398
419
|
# permission to the `AddPermission`, `RemovePermission`, and
|
399
420
|
# `SetQueueAttributes` actions in your IAM policy.
|
400
421
|
#
|
401
|
-
#
|
422
|
+
# * Amazon SQS `AddPermission` does not support adding a non-account
|
423
|
+
# principal.
|
402
424
|
#
|
403
|
-
#
|
404
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
405
|
-
# For example, a parameter list with two elements looks like this:
|
406
|
-
#
|
407
|
-
# `&AttributeName.1=first`
|
408
|
-
#
|
409
|
-
# `&AttributeName.2=second`
|
425
|
+
# </note>
|
410
426
|
#
|
411
427
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
412
|
-
# information, see [Grant cross-account permissions to a role and a
|
413
|
-
#
|
428
|
+
# information, see [Grant cross-account permissions to a role and a
|
429
|
+
# username][4] in the *Amazon SQS Developer Guide*.
|
414
430
|
#
|
415
431
|
# </note>
|
416
432
|
#
|
@@ -481,18 +497,68 @@ module Aws::SQS
|
|
481
497
|
req.send_request(options)
|
482
498
|
end
|
483
499
|
|
500
|
+
# Cancels a specified message movement task. A message movement can only
|
501
|
+
# be cancelled when the current status is RUNNING. Cancelling a message
|
502
|
+
# movement task does not revert the messages that have already been
|
503
|
+
# moved. It can only stop the messages that have not been moved yet.
|
504
|
+
#
|
505
|
+
# <note markdown="1"> * This action is currently limited to supporting message redrive from
|
506
|
+
# [dead-letter queues (DLQs)][1] only. In this context, the source
|
507
|
+
# queue is the dead-letter queue (DLQ), while the destination queue
|
508
|
+
# can be the original source queue (from which the messages were
|
509
|
+
# driven to the dead-letter-queue), or a custom destination queue.
|
510
|
+
#
|
511
|
+
# * Currently, only standard queues are supported.
|
512
|
+
#
|
513
|
+
# * Only one active message movement task is supported per queue at any
|
514
|
+
# given time.
|
515
|
+
#
|
516
|
+
# </note>
|
517
|
+
#
|
518
|
+
#
|
519
|
+
#
|
520
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
521
|
+
#
|
522
|
+
# @option params [required, String] :task_handle
|
523
|
+
# An identifier associated with a message movement task.
|
524
|
+
#
|
525
|
+
# @return [Types::CancelMessageMoveTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
526
|
+
#
|
527
|
+
# * {Types::CancelMessageMoveTaskResult#approximate_number_of_messages_moved #approximate_number_of_messages_moved} => Integer
|
528
|
+
#
|
529
|
+
# @example Request syntax with placeholder values
|
530
|
+
#
|
531
|
+
# resp = client.cancel_message_move_task({
|
532
|
+
# task_handle: "String", # required
|
533
|
+
# })
|
534
|
+
#
|
535
|
+
# @example Response structure
|
536
|
+
#
|
537
|
+
# resp.approximate_number_of_messages_moved #=> Integer
|
538
|
+
#
|
539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTask AWS API Documentation
|
540
|
+
#
|
541
|
+
# @overload cancel_message_move_task(params = {})
|
542
|
+
# @param [Hash] params ({})
|
543
|
+
def cancel_message_move_task(params = {}, options = {})
|
544
|
+
req = build_request(:cancel_message_move_task, params)
|
545
|
+
req.send_request(options)
|
546
|
+
end
|
547
|
+
|
484
548
|
# Changes the visibility timeout of a specified message in a queue to a
|
485
549
|
# new value. The default visibility timeout for a message is 30 seconds.
|
486
550
|
# The minimum is 0 seconds. The maximum is 12 hours. For more
|
487
551
|
# information, see [Visibility Timeout][1] in the *Amazon SQS Developer
|
488
552
|
# Guide*.
|
489
553
|
#
|
490
|
-
# For example,
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
554
|
+
# For example, if the default timeout for a queue is 60 seconds, 15
|
555
|
+
# seconds have elapsed since you received the message, and you send a
|
556
|
+
# ChangeMessageVisibility call with `VisibilityTimeout` set to 10
|
557
|
+
# seconds, the 10 seconds begin to count from the time that you make the
|
558
|
+
# `ChangeMessageVisibility` call. Thus, any attempt to change the
|
559
|
+
# visibility timeout or to delete that message 10 seconds after you
|
560
|
+
# initially change the visibility timeout (a total of 25 seconds) might
|
561
|
+
# result in an error.
|
496
562
|
#
|
497
563
|
# An Amazon SQS message has three basic states:
|
498
564
|
#
|
@@ -508,13 +574,13 @@ module Aws::SQS
|
|
508
574
|
# messages. A message is considered to be *in flight* after it is
|
509
575
|
# received from a queue by a consumer, but not yet deleted from the
|
510
576
|
# queue (that is, between states 2 and 3). There is a limit to the
|
511
|
-
# number of
|
577
|
+
# number of in flight messages.
|
512
578
|
#
|
513
|
-
# Limits that apply to
|
579
|
+
# Limits that apply to in flight messages are unrelated to the
|
514
580
|
# *unlimited* number of stored messages.
|
515
581
|
#
|
516
582
|
# For most standard queues (depending on queue traffic and message
|
517
|
-
# backlog), there can be a maximum of approximately 120,000
|
583
|
+
# backlog), there can be a maximum of approximately 120,000 in flight
|
518
584
|
# messages (received from a queue by a consumer, but not yet deleted
|
519
585
|
# from the queue). If you reach this limit, Amazon SQS returns the
|
520
586
|
# `OverLimit` error message. To avoid reaching the limit, you should
|
@@ -522,7 +588,7 @@ module Aws::SQS
|
|
522
588
|
# increase the number of queues you use to process your messages. To
|
523
589
|
# request a limit increase, [file a support request][2].
|
524
590
|
#
|
525
|
-
# For FIFO queues, there can be a maximum of 20,000
|
591
|
+
# For FIFO queues, there can be a maximum of 20,000 in flight messages
|
526
592
|
# (received from a queue by a consumer, but not yet deleted from the
|
527
593
|
# queue). If you reach this limit, Amazon SQS returns no error messages.
|
528
594
|
#
|
@@ -551,7 +617,7 @@ module Aws::SQS
|
|
551
617
|
# Queue URLs and names are case-sensitive.
|
552
618
|
#
|
553
619
|
# @option params [required, String] :receipt_handle
|
554
|
-
# The receipt handle associated with the message whose visibility
|
620
|
+
# The receipt handle associated with the message, whose visibility
|
555
621
|
# timeout is changed. This parameter is returned by the ` ReceiveMessage
|
556
622
|
# ` action.
|
557
623
|
#
|
@@ -588,14 +654,6 @@ module Aws::SQS
|
|
588
654
|
# and unsuccessful actions, you should check for batch errors even when
|
589
655
|
# the call returns an HTTP status code of `200`.
|
590
656
|
#
|
591
|
-
# Some actions take lists of parameters. These lists are specified using
|
592
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
593
|
-
# For example, a parameter list with two elements looks like this:
|
594
|
-
#
|
595
|
-
# `&AttributeName.1=first`
|
596
|
-
#
|
597
|
-
# `&AttributeName.2=second`
|
598
|
-
#
|
599
657
|
# @option params [required, String] :queue_url
|
600
658
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
601
659
|
# changed.
|
@@ -603,7 +661,7 @@ module Aws::SQS
|
|
603
661
|
# Queue URLs and names are case-sensitive.
|
604
662
|
#
|
605
663
|
# @option params [required, Array<Types::ChangeMessageVisibilityBatchRequestEntry>] :entries
|
606
|
-
#
|
664
|
+
# Lists the receipt handles of the messages for which the visibility
|
607
665
|
# timeout must be changed.
|
608
666
|
#
|
609
667
|
# @return [Types::ChangeMessageVisibilityBatchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -684,17 +742,9 @@ module Aws::SQS
|
|
684
742
|
# * If the queue name, attribute names, or attribute values don't match
|
685
743
|
# an existing queue, `CreateQueue` returns an error.
|
686
744
|
#
|
687
|
-
# Some actions take lists of parameters. These lists are specified using
|
688
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
689
|
-
# For example, a parameter list with two elements looks like this:
|
690
|
-
#
|
691
|
-
# `&AttributeName.1=first`
|
692
|
-
#
|
693
|
-
# `&AttributeName.2=second`
|
694
|
-
#
|
695
745
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
696
|
-
# information, see [Grant cross-account permissions to a role and a
|
697
|
-
#
|
746
|
+
# information, see [Grant cross-account permissions to a role and a
|
747
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
698
748
|
#
|
699
749
|
# </note>
|
700
750
|
#
|
@@ -734,43 +784,77 @@ module Aws::SQS
|
|
734
784
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
735
785
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
736
786
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
737
|
-
# (4 days).
|
787
|
+
# (4 days). When you change a queue's attributes, the change can take
|
788
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
789
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
790
|
+
# attribute can take up to 15 minutes and will impact existing
|
791
|
+
# messages in the queue potentially causing them to be expired and
|
792
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
793
|
+
# existing messages.
|
738
794
|
#
|
739
795
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
740
796
|
# For more information about policy structure, see [Overview of Amazon
|
741
|
-
# Web Services IAM Policies][1] in the *
|
797
|
+
# Web Services IAM Policies][1] in the *IAM User Guide*.
|
742
798
|
#
|
743
799
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
744
800
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
745
801
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
746
802
|
#
|
803
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
804
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
805
|
+
# Default: 30. For more information about the visibility timeout, see
|
806
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
807
|
+
#
|
808
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
809
|
+
#
|
747
810
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
748
811
|
# dead-letter queue functionality of the source queue as a JSON
|
749
|
-
# object.
|
750
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
751
|
-
# the *Amazon SQS Developer Guide*.
|
812
|
+
# object. The parameters are as follows:
|
752
813
|
#
|
753
814
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
754
815
|
# dead-letter queue to which Amazon SQS moves messages after the
|
755
816
|
# value of `maxReceiveCount` is exceeded.
|
756
817
|
#
|
757
818
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
758
|
-
# the source queue before being moved to the dead-letter queue.
|
759
|
-
# the `ReceiveCount` for a message exceeds the
|
760
|
-
# a queue, Amazon SQS moves the message to the
|
761
|
-
#
|
762
|
-
#
|
763
|
-
#
|
764
|
-
#
|
765
|
-
#
|
766
|
-
#
|
819
|
+
# the source queue before being moved to the dead-letter queue.
|
820
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
821
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
822
|
+
# dead-letter-queue.
|
823
|
+
#
|
824
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
825
|
+
# the permissions for the dead-letter queue redrive permission and
|
826
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
827
|
+
# The parameters are as follows:
|
828
|
+
#
|
829
|
+
# * `redrivePermission` – The permission type that defines which
|
830
|
+
# source queues can specify the current queue as the dead-letter
|
831
|
+
# queue. Valid values are:
|
832
|
+
#
|
833
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
834
|
+
# Services account in the same Region can specify this queue as
|
835
|
+
# the dead-letter queue.
|
836
|
+
#
|
837
|
+
# * `denyAll` – No source queues can specify this queue as the
|
838
|
+
# dead-letter queue.
|
839
|
+
#
|
840
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
841
|
+
# parameter can specify this queue as the dead-letter queue.
|
842
|
+
#
|
843
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
844
|
+
# queues that can specify this queue as the dead-letter queue and
|
845
|
+
# redrive messages. You can specify this parameter only when the
|
846
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
847
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
848
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
849
|
+
# to `allowAll`.
|
850
|
+
#
|
851
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
852
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
853
|
+
# standard queue.
|
767
854
|
#
|
768
|
-
#
|
769
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
770
|
-
# Default: 30. For more information about the visibility timeout, see
|
771
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
855
|
+
# </note>
|
772
856
|
#
|
773
|
-
# The following attributes apply only to [server-side-encryption][4]
|
857
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
774
858
|
#
|
775
859
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
776
860
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -787,14 +871,14 @@ module Aws::SQS
|
|
787
871
|
# Default: 300 (5 minutes). A shorter time period provides better
|
788
872
|
# security but results in more calls to KMS which might incur charges
|
789
873
|
# after Free Tier. For more information, see [How Does the Data Key
|
790
|
-
# Reuse Period Work?][8]
|
874
|
+
# Reuse Period Work?][8]
|
791
875
|
#
|
792
876
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
793
877
|
# SQS owned encryption keys. Only one server-side encryption option is
|
794
|
-
# supported per queue (
|
878
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
795
879
|
#
|
796
880
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
797
|
-
# queues][11]
|
881
|
+
# queues][11]:
|
798
882
|
#
|
799
883
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
800
884
|
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
@@ -840,7 +924,7 @@ module Aws::SQS
|
|
840
924
|
# duplicates and only one copy of the message is delivered.
|
841
925
|
#
|
842
926
|
# The following attributes apply only to [high throughput for FIFO
|
843
|
-
# queues][14]
|
927
|
+
# queues][14]:
|
844
928
|
#
|
845
929
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
846
930
|
# occurs at the message group or queue level. Valid values are
|
@@ -868,8 +952,8 @@ module Aws::SQS
|
|
868
952
|
#
|
869
953
|
#
|
870
954
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
871
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
872
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
955
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
956
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
873
957
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
874
958
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
875
959
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -907,8 +991,8 @@ module Aws::SQS
|
|
907
991
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
908
992
|
#
|
909
993
|
# Cross-account permissions don't apply to this action. For more
|
910
|
-
# information, see [Grant cross-account permissions to a role and a
|
911
|
-
#
|
994
|
+
# information, see [Grant cross-account permissions to a role and a
|
995
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
912
996
|
#
|
913
997
|
# </note>
|
914
998
|
#
|
@@ -960,7 +1044,7 @@ module Aws::SQS
|
|
960
1044
|
# `ReceiptHandle` is different each time you receive a message. When you
|
961
1045
|
# use the `DeleteMessage` action, you must provide the most recently
|
962
1046
|
# received `ReceiptHandle` for the message (otherwise, the request
|
963
|
-
# succeeds, but the message
|
1047
|
+
# succeeds, but the message will not be deleted).
|
964
1048
|
#
|
965
1049
|
# For standard queues, it is possible to receive a message even after
|
966
1050
|
# you delete it. This might happen on rare occasions if one of the
|
@@ -1006,21 +1090,13 @@ module Aws::SQS
|
|
1006
1090
|
# and unsuccessful actions, you should check for batch errors even when
|
1007
1091
|
# the call returns an HTTP status code of `200`.
|
1008
1092
|
#
|
1009
|
-
# Some actions take lists of parameters. These lists are specified using
|
1010
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1011
|
-
# For example, a parameter list with two elements looks like this:
|
1012
|
-
#
|
1013
|
-
# `&AttributeName.1=first`
|
1014
|
-
#
|
1015
|
-
# `&AttributeName.2=second`
|
1016
|
-
#
|
1017
1093
|
# @option params [required, String] :queue_url
|
1018
1094
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
1019
1095
|
#
|
1020
1096
|
# Queue URLs and names are case-sensitive.
|
1021
1097
|
#
|
1022
1098
|
# @option params [required, Array<Types::DeleteMessageBatchRequestEntry>] :entries
|
1023
|
-
#
|
1099
|
+
# Lists the receipt handles for the messages to be deleted.
|
1024
1100
|
#
|
1025
1101
|
# @return [Types::DeleteMessageBatchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1026
1102
|
#
|
@@ -1073,8 +1149,10 @@ module Aws::SQS
|
|
1073
1149
|
# creating a queue with the same name.
|
1074
1150
|
#
|
1075
1151
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1076
|
-
# information, see [Grant cross-account permissions to a role and a
|
1077
|
-
#
|
1152
|
+
# information, see [Grant cross-account permissions to a role and a
|
1153
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1154
|
+
#
|
1155
|
+
# The delete operation uses the HTTP `GET` verb.
|
1078
1156
|
#
|
1079
1157
|
# </note>
|
1080
1158
|
#
|
@@ -1124,7 +1202,7 @@ module Aws::SQS
|
|
1124
1202
|
# @option params [Array<String>] :attribute_names
|
1125
1203
|
# A list of attributes for which to retrieve information.
|
1126
1204
|
#
|
1127
|
-
# The `
|
1205
|
+
# The `AttributeNames` parameter is optional, but if you don't specify
|
1128
1206
|
# values for this parameter, the request returns empty results.
|
1129
1207
|
#
|
1130
1208
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
@@ -1137,10 +1215,10 @@ module Aws::SQS
|
|
1137
1215
|
#
|
1138
1216
|
# The `ApproximateNumberOfMessagesDelayed`,
|
1139
1217
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
1140
|
-
# `
|
1141
|
-
#
|
1142
|
-
#
|
1143
|
-
#
|
1218
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
1219
|
+
# until at least 1 minute after the producers stop sending messages.
|
1220
|
+
# This period is required for the queue metadata to reach eventual
|
1221
|
+
# consistency.
|
1144
1222
|
#
|
1145
1223
|
# * `All` – Returns all values.
|
1146
1224
|
#
|
@@ -1170,7 +1248,14 @@ module Aws::SQS
|
|
1170
1248
|
# can contain before Amazon SQS rejects it.
|
1171
1249
|
#
|
1172
1250
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1173
|
-
# for which Amazon SQS retains a message.
|
1251
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
1252
|
+
# attributes, the change can take up to 60 seconds for most of the
|
1253
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
1254
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
1255
|
+
# minutes and will impact existing messages in the queue potentially
|
1256
|
+
# causing them to be expired and deleted if the
|
1257
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
1258
|
+
# messages.
|
1174
1259
|
#
|
1175
1260
|
# * `Policy` – Returns the policy of the queue.
|
1176
1261
|
#
|
@@ -1180,26 +1265,60 @@ module Aws::SQS
|
|
1180
1265
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1181
1266
|
# to arrive.
|
1182
1267
|
#
|
1268
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1269
|
+
# For more information about the visibility timeout, see [Visibility
|
1270
|
+
# Timeout][2] in the *Amazon SQS Developer Guide*.
|
1271
|
+
#
|
1272
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
1273
|
+
#
|
1183
1274
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
1184
1275
|
# dead-letter queue functionality of the source queue as a JSON
|
1185
|
-
# object.
|
1186
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1187
|
-
# the *Amazon SQS Developer Guide*.
|
1276
|
+
# object. The parameters are as follows:
|
1188
1277
|
#
|
1189
1278
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1190
1279
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1191
1280
|
# value of `maxReceiveCount` is exceeded.
|
1192
1281
|
#
|
1193
1282
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
1194
|
-
# the source queue before being moved to the dead-letter queue.
|
1195
|
-
# the `ReceiveCount` for a message exceeds the
|
1196
|
-
# a queue, Amazon SQS moves the message to the
|
1283
|
+
# the source queue before being moved to the dead-letter queue.
|
1284
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
1285
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
1286
|
+
# dead-letter-queue.
|
1287
|
+
#
|
1288
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
1289
|
+
# the permissions for the dead-letter queue redrive permission and
|
1290
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
1291
|
+
# The parameters are as follows:
|
1292
|
+
#
|
1293
|
+
# * `redrivePermission` – The permission type that defines which
|
1294
|
+
# source queues can specify the current queue as the dead-letter
|
1295
|
+
# queue. Valid values are:
|
1296
|
+
#
|
1297
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
1298
|
+
# Services account in the same Region can specify this queue as
|
1299
|
+
# the dead-letter queue.
|
1300
|
+
#
|
1301
|
+
# * `denyAll` – No source queues can specify this queue as the
|
1302
|
+
# dead-letter queue.
|
1303
|
+
#
|
1304
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
1305
|
+
# parameter can specify this queue as the dead-letter queue.
|
1306
|
+
#
|
1307
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
1308
|
+
# queues that can specify this queue as the dead-letter queue and
|
1309
|
+
# redrive messages. You can specify this parameter only when the
|
1310
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
1311
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
1312
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
1313
|
+
# to `allowAll`.
|
1314
|
+
#
|
1315
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
1316
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
1317
|
+
# standard queue.
|
1197
1318
|
#
|
1198
|
-
#
|
1199
|
-
# For more information about the visibility timeout, see [Visibility
|
1200
|
-
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1319
|
+
# </note>
|
1201
1320
|
#
|
1202
|
-
# The following attributes apply only to [server-side-encryption][4]
|
1321
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
1203
1322
|
#
|
1204
1323
|
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services managed
|
1205
1324
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -1212,11 +1331,11 @@ module Aws::SQS
|
|
1212
1331
|
#
|
1213
1332
|
# * `SqsManagedSseEnabled` – Returns information about whether the queue
|
1214
1333
|
# is using SSE-SQS encryption using SQS owned encryption keys. Only
|
1215
|
-
# one server-side encryption option is supported per queue (
|
1216
|
-
# [SSE-KMS][7] or [SSE-SQS][8]).
|
1334
|
+
# one server-side encryption option is supported per queue (for
|
1335
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
1217
1336
|
#
|
1218
1337
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1219
|
-
# queues][9]
|
1338
|
+
# queues][9]:
|
1220
1339
|
#
|
1221
1340
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1222
1341
|
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
@@ -1232,7 +1351,7 @@ module Aws::SQS
|
|
1232
1351
|
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
1233
1352
|
#
|
1234
1353
|
# The following attributes apply only to [high throughput for FIFO
|
1235
|
-
# queues][12]
|
1354
|
+
# queues][12]:
|
1236
1355
|
#
|
1237
1356
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
1238
1357
|
# occurs at the message group or queue level. Valid values are
|
@@ -1260,8 +1379,8 @@ module Aws::SQS
|
|
1260
1379
|
#
|
1261
1380
|
#
|
1262
1381
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1263
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
1264
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
1382
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1383
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
1265
1384
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
1266
1385
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
1267
1386
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -1408,13 +1527,74 @@ module Aws::SQS
|
|
1408
1527
|
req.send_request(options)
|
1409
1528
|
end
|
1410
1529
|
|
1530
|
+
# Gets the most recent message movement tasks (up to 10) under a
|
1531
|
+
# specific source queue.
|
1532
|
+
#
|
1533
|
+
# <note markdown="1"> * This action is currently limited to supporting message redrive from
|
1534
|
+
# [dead-letter queues (DLQs)][1] only. In this context, the source
|
1535
|
+
# queue is the dead-letter queue (DLQ), while the destination queue
|
1536
|
+
# can be the original source queue (from which the messages were
|
1537
|
+
# driven to the dead-letter-queue), or a custom destination queue.
|
1538
|
+
#
|
1539
|
+
# * Currently, only standard queues are supported.
|
1540
|
+
#
|
1541
|
+
# * Only one active message movement task is supported per queue at any
|
1542
|
+
# given time.
|
1543
|
+
#
|
1544
|
+
# </note>
|
1545
|
+
#
|
1546
|
+
#
|
1547
|
+
#
|
1548
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
1549
|
+
#
|
1550
|
+
# @option params [required, String] :source_arn
|
1551
|
+
# The ARN of the queue whose message movement tasks are to be listed.
|
1552
|
+
#
|
1553
|
+
# @option params [Integer] :max_results
|
1554
|
+
# The maximum number of results to include in the response. The default
|
1555
|
+
# is 1, which provides the most recent message movement task. The upper
|
1556
|
+
# limit is 10.
|
1557
|
+
#
|
1558
|
+
# @return [Types::ListMessageMoveTasksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1559
|
+
#
|
1560
|
+
# * {Types::ListMessageMoveTasksResult#results #results} => Array<Types::ListMessageMoveTasksResultEntry>
|
1561
|
+
#
|
1562
|
+
# @example Request syntax with placeholder values
|
1563
|
+
#
|
1564
|
+
# resp = client.list_message_move_tasks({
|
1565
|
+
# source_arn: "String", # required
|
1566
|
+
# max_results: 1,
|
1567
|
+
# })
|
1568
|
+
#
|
1569
|
+
# @example Response structure
|
1570
|
+
#
|
1571
|
+
# resp.results #=> Array
|
1572
|
+
# resp.results[0].task_handle #=> String
|
1573
|
+
# resp.results[0].status #=> String
|
1574
|
+
# resp.results[0].source_arn #=> String
|
1575
|
+
# resp.results[0].destination_arn #=> String
|
1576
|
+
# resp.results[0].max_number_of_messages_per_second #=> Integer
|
1577
|
+
# resp.results[0].approximate_number_of_messages_moved #=> Integer
|
1578
|
+
# resp.results[0].approximate_number_of_messages_to_move #=> Integer
|
1579
|
+
# resp.results[0].failure_reason #=> String
|
1580
|
+
# resp.results[0].started_timestamp #=> Integer
|
1581
|
+
#
|
1582
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasks AWS API Documentation
|
1583
|
+
#
|
1584
|
+
# @overload list_message_move_tasks(params = {})
|
1585
|
+
# @param [Hash] params ({})
|
1586
|
+
def list_message_move_tasks(params = {}, options = {})
|
1587
|
+
req = build_request(:list_message_move_tasks, params)
|
1588
|
+
req.send_request(options)
|
1589
|
+
end
|
1590
|
+
|
1411
1591
|
# List all cost allocation tags added to the specified Amazon SQS queue.
|
1412
1592
|
# For an overview, see [Tagging Your Amazon SQS Queues][1] in the
|
1413
1593
|
# *Amazon SQS Developer Guide*.
|
1414
1594
|
#
|
1415
1595
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1416
|
-
# information, see [Grant cross-account permissions to a role and a
|
1417
|
-
#
|
1596
|
+
# information, see [Grant cross-account permissions to a role and a
|
1597
|
+
# username][2] in the *Amazon SQS Developer Guide*.
|
1418
1598
|
#
|
1419
1599
|
# </note>
|
1420
1600
|
#
|
@@ -1464,8 +1644,8 @@ module Aws::SQS
|
|
1464
1644
|
# request to `listQueues` to receive the next page of results.
|
1465
1645
|
#
|
1466
1646
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1467
|
-
# information, see [Grant cross-account permissions to a role and a
|
1468
|
-
#
|
1647
|
+
# information, see [Grant cross-account permissions to a role and a
|
1648
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1469
1649
|
#
|
1470
1650
|
# </note>
|
1471
1651
|
#
|
@@ -1517,7 +1697,8 @@ module Aws::SQS
|
|
1517
1697
|
req.send_request(options)
|
1518
1698
|
end
|
1519
1699
|
|
1520
|
-
# Deletes
|
1700
|
+
# Deletes available messages in a queue (including in-flight messages)
|
1701
|
+
# specified by the `QueueURL` parameter.
|
1521
1702
|
#
|
1522
1703
|
# When you use the `PurgeQueue` action, you can't retrieve any messages
|
1523
1704
|
# deleted from a queue.
|
@@ -1633,7 +1814,7 @@ module Aws::SQS
|
|
1633
1814
|
#
|
1634
1815
|
# * `SenderId`
|
1635
1816
|
#
|
1636
|
-
# * For
|
1817
|
+
# * For a user, returns the user ID, for example
|
1637
1818
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1638
1819
|
#
|
1639
1820
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1644,7 +1825,7 @@ module Aws::SQS
|
|
1644
1825
|
#
|
1645
1826
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
1646
1827
|
# SQS owned encryption keys. Only one server-side encryption option is
|
1647
|
-
# supported per queue (
|
1828
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
1648
1829
|
#
|
1649
1830
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1650
1831
|
# producer that calls the ` SendMessage ` action.
|
@@ -1827,7 +2008,7 @@ module Aws::SQS
|
|
1827
2008
|
#
|
1828
2009
|
# * Cross-account permissions don't apply to this action. For more
|
1829
2010
|
# information, see [Grant cross-account permissions to a role and a
|
1830
|
-
#
|
2011
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1831
2012
|
#
|
1832
2013
|
# * To remove the ability to change queue permissions, you must deny
|
1833
2014
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1888,7 +2069,7 @@ module Aws::SQS
|
|
1888
2069
|
#
|
1889
2070
|
# @option params [required, String] :message_body
|
1890
2071
|
# The message to send. The minimum size is one character. The maximum
|
1891
|
-
# size is 256
|
2072
|
+
# size is 256 KiB.
|
1892
2073
|
#
|
1893
2074
|
# A message can include only XML, JSON, and unformatted text. The
|
1894
2075
|
# following Unicode characters are allowed:
|
@@ -2083,7 +2264,9 @@ module Aws::SQS
|
|
2083
2264
|
req.send_request(options)
|
2084
2265
|
end
|
2085
2266
|
|
2086
|
-
#
|
2267
|
+
# You can use `SendMessageBatch` to send up to 10 messages to the
|
2268
|
+
# specified queue by assigning either identical or different values to
|
2269
|
+
# each message (or by not assigning values at all). This is a batch
|
2087
2270
|
# version of ` SendMessage.` For a FIFO queue, multiple messages within
|
2088
2271
|
# a single batch are enqueued in the order they are sent.
|
2089
2272
|
#
|
@@ -2094,7 +2277,7 @@ module Aws::SQS
|
|
2094
2277
|
#
|
2095
2278
|
# The maximum allowed individual message size and the maximum total
|
2096
2279
|
# payload size (the sum of the individual lengths of all of the batched
|
2097
|
-
# messages) are both 256
|
2280
|
+
# messages) are both 256 KiB (262,144 bytes).
|
2098
2281
|
#
|
2099
2282
|
# A message can include only XML, JSON, and unformatted text. The
|
2100
2283
|
# following Unicode characters are allowed:
|
@@ -2108,14 +2291,6 @@ module Aws::SQS
|
|
2108
2291
|
# If you don't specify the `DelaySeconds` parameter for an entry,
|
2109
2292
|
# Amazon SQS uses the default value for the queue.
|
2110
2293
|
#
|
2111
|
-
# Some actions take lists of parameters. These lists are specified using
|
2112
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
2113
|
-
# For example, a parameter list with two elements looks like this:
|
2114
|
-
#
|
2115
|
-
# `&AttributeName.1=first`
|
2116
|
-
#
|
2117
|
-
# `&AttributeName.2=second`
|
2118
|
-
#
|
2119
2294
|
#
|
2120
2295
|
#
|
2121
2296
|
# [1]: http://www.w3.org/TR/REC-xml/#charsets
|
@@ -2194,7 +2369,9 @@ module Aws::SQS
|
|
2194
2369
|
# queue's attributes, the change can take up to 60 seconds for most of
|
2195
2370
|
# the attributes to propagate throughout the Amazon SQS system. Changes
|
2196
2371
|
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
2197
|
-
# minutes
|
2372
|
+
# minutes and will impact existing messages in the queue potentially
|
2373
|
+
# causing them to be expired and deleted if the `MessageRetentionPeriod`
|
2374
|
+
# is reduced below the age of existing messages.
|
2198
2375
|
#
|
2199
2376
|
# <note markdown="1"> * In the future, new attributes might be added. If you write code that
|
2200
2377
|
# calls this action, we recommend that you structure your code so that
|
@@ -2202,7 +2379,7 @@ module Aws::SQS
|
|
2202
2379
|
#
|
2203
2380
|
# * Cross-account permissions don't apply to this action. For more
|
2204
2381
|
# information, see [Grant cross-account permissions to a role and a
|
2205
|
-
#
|
2382
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
2206
2383
|
#
|
2207
2384
|
# * To remove the ability to change queue permissions, you must deny
|
2208
2385
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2237,7 +2414,13 @@ module Aws::SQS
|
|
2237
2414
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2238
2415
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2239
2416
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2240
|
-
# (4 days).
|
2417
|
+
# (4 days). When you change a queue's attributes, the change can take
|
2418
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
2419
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
2420
|
+
# attribute can take up to 15 minutes and will impact existing
|
2421
|
+
# messages in the queue potentially causing them to be expired and
|
2422
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
2423
|
+
# existing messages.
|
2241
2424
|
#
|
2242
2425
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
2243
2426
|
# For more information about policy structure, see [Overview of Amazon
|
@@ -2248,33 +2431,61 @@ module Aws::SQS
|
|
2248
2431
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2249
2432
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2250
2433
|
#
|
2434
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2435
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2436
|
+
# Default: 30. For more information about the visibility timeout, see
|
2437
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2438
|
+
#
|
2439
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2440
|
+
#
|
2251
2441
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2252
2442
|
# dead-letter queue functionality of the source queue as a JSON
|
2253
|
-
# object.
|
2254
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2255
|
-
# the *Amazon SQS Developer Guide*.
|
2443
|
+
# object. The parameters are as follows:
|
2256
2444
|
#
|
2257
2445
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2258
2446
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2259
2447
|
# value of `maxReceiveCount` is exceeded.
|
2260
2448
|
#
|
2261
2449
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
2262
|
-
# the source queue before being moved to the dead-letter queue.
|
2263
|
-
# the `ReceiveCount` for a message exceeds the
|
2264
|
-
# a queue, Amazon SQS moves the message to the
|
2450
|
+
# the source queue before being moved to the dead-letter queue.
|
2451
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2452
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
2453
|
+
# dead-letter-queue.
|
2454
|
+
#
|
2455
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2456
|
+
# the permissions for the dead-letter queue redrive permission and
|
2457
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
2458
|
+
# The parameters are as follows:
|
2459
|
+
#
|
2460
|
+
# * `redrivePermission` – The permission type that defines which
|
2461
|
+
# source queues can specify the current queue as the dead-letter
|
2462
|
+
# queue. Valid values are:
|
2463
|
+
#
|
2464
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2465
|
+
# Services account in the same Region can specify this queue as
|
2466
|
+
# the dead-letter queue.
|
2467
|
+
#
|
2468
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2469
|
+
# dead-letter queue.
|
2470
|
+
#
|
2471
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2472
|
+
# parameter can specify this queue as the dead-letter queue.
|
2473
|
+
#
|
2474
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
2475
|
+
# queues that can specify this queue as the dead-letter queue and
|
2476
|
+
# redrive messages. You can specify this parameter only when the
|
2477
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
2478
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
2479
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
2480
|
+
# to `allowAll`.
|
2481
|
+
#
|
2482
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2483
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2484
|
+
# standard queue.
|
2265
2485
|
#
|
2266
|
-
#
|
2267
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
2268
|
-
# standard queue.
|
2269
|
-
#
|
2270
|
-
# </note>
|
2271
|
-
#
|
2272
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2273
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2274
|
-
# Default: 30. For more information about the visibility timeout, see
|
2275
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2486
|
+
# </note>
|
2276
2487
|
#
|
2277
|
-
# The following attributes apply only to [server-side-encryption][4]
|
2488
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
2278
2489
|
#
|
2279
2490
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
2280
2491
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -2294,10 +2505,10 @@ module Aws::SQS
|
|
2294
2505
|
#
|
2295
2506
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
2296
2507
|
# SQS owned encryption keys. Only one server-side encryption option is
|
2297
|
-
# supported per queue (
|
2508
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
2298
2509
|
#
|
2299
2510
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2300
|
-
# queues][11]
|
2511
|
+
# queues][11]:
|
2301
2512
|
#
|
2302
2513
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2303
2514
|
# For more information, see [Exactly-once processing][12] in the
|
@@ -2332,7 +2543,7 @@ module Aws::SQS
|
|
2332
2543
|
# duplicates and only one copy of the message is delivered.
|
2333
2544
|
#
|
2334
2545
|
# The following attributes apply only to [high throughput for FIFO
|
2335
|
-
# queues][13]
|
2546
|
+
# queues][13]:
|
2336
2547
|
#
|
2337
2548
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2338
2549
|
# occurs at the message group or queue level. Valid values are
|
@@ -2360,8 +2571,8 @@ module Aws::SQS
|
|
2360
2571
|
#
|
2361
2572
|
#
|
2362
2573
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2363
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2364
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2574
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2575
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2365
2576
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2366
2577
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2367
2578
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2394,6 +2605,78 @@ module Aws::SQS
|
|
2394
2605
|
req.send_request(options)
|
2395
2606
|
end
|
2396
2607
|
|
2608
|
+
# Starts an asynchronous task to move messages from a specified source
|
2609
|
+
# queue to a specified destination queue.
|
2610
|
+
#
|
2611
|
+
# <note markdown="1"> * This action is currently limited to supporting message redrive from
|
2612
|
+
# queues that are configured as [dead-letter queues (DLQs)][1] of
|
2613
|
+
# other Amazon SQS queues only. Non-SQS queue sources of dead-letter
|
2614
|
+
# queues, such as Lambda or Amazon SNS topics, are currently not
|
2615
|
+
# supported.
|
2616
|
+
#
|
2617
|
+
# * In dead-letter queues redrive context, the `StartMessageMoveTask`
|
2618
|
+
# the source queue is the DLQ, while the destination queue can be the
|
2619
|
+
# original source queue (from which the messages were driven to the
|
2620
|
+
# dead-letter-queue), or a custom destination queue.
|
2621
|
+
#
|
2622
|
+
# * Currently, only standard queues support redrive. FIFO queues don't
|
2623
|
+
# support redrive.
|
2624
|
+
#
|
2625
|
+
# * Only one active message movement task is supported per queue at any
|
2626
|
+
# given time.
|
2627
|
+
#
|
2628
|
+
# </note>
|
2629
|
+
#
|
2630
|
+
#
|
2631
|
+
#
|
2632
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2633
|
+
#
|
2634
|
+
# @option params [required, String] :source_arn
|
2635
|
+
# The ARN of the queue that contains the messages to be moved to another
|
2636
|
+
# queue. Currently, only ARNs of dead-letter queues (DLQs) whose sources
|
2637
|
+
# are other Amazon SQS queues are accepted. DLQs whose sources are
|
2638
|
+
# non-SQS queues, such as Lambda or Amazon SNS topics, are not currently
|
2639
|
+
# supported.
|
2640
|
+
#
|
2641
|
+
# @option params [String] :destination_arn
|
2642
|
+
# The ARN of the queue that receives the moved messages. You can use
|
2643
|
+
# this field to specify the destination queue where you would like to
|
2644
|
+
# redrive messages. If this field is left blank, the messages will be
|
2645
|
+
# redriven back to their respective original source queues.
|
2646
|
+
#
|
2647
|
+
# @option params [Integer] :max_number_of_messages_per_second
|
2648
|
+
# The number of messages to be moved per second (the message movement
|
2649
|
+
# rate). You can use this field to define a fixed message movement rate.
|
2650
|
+
# The maximum value for messages per second is 500. If this field is
|
2651
|
+
# left blank, the system will optimize the rate based on the queue
|
2652
|
+
# message backlog size, which may vary throughout the duration of the
|
2653
|
+
# message movement task.
|
2654
|
+
#
|
2655
|
+
# @return [Types::StartMessageMoveTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2656
|
+
#
|
2657
|
+
# * {Types::StartMessageMoveTaskResult#task_handle #task_handle} => String
|
2658
|
+
#
|
2659
|
+
# @example Request syntax with placeholder values
|
2660
|
+
#
|
2661
|
+
# resp = client.start_message_move_task({
|
2662
|
+
# source_arn: "String", # required
|
2663
|
+
# destination_arn: "String",
|
2664
|
+
# max_number_of_messages_per_second: 1,
|
2665
|
+
# })
|
2666
|
+
#
|
2667
|
+
# @example Response structure
|
2668
|
+
#
|
2669
|
+
# resp.task_handle #=> String
|
2670
|
+
#
|
2671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTask AWS API Documentation
|
2672
|
+
#
|
2673
|
+
# @overload start_message_move_task(params = {})
|
2674
|
+
# @param [Hash] params ({})
|
2675
|
+
def start_message_move_task(params = {}, options = {})
|
2676
|
+
req = build_request(:start_message_move_task, params)
|
2677
|
+
req.send_request(options)
|
2678
|
+
end
|
2679
|
+
|
2397
2680
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
2398
2681
|
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
2399
2682
|
# Developer Guide*.
|
@@ -2414,8 +2697,8 @@ module Aws::SQS
|
|
2414
2697
|
# in the *Amazon SQS Developer Guide*.
|
2415
2698
|
#
|
2416
2699
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2417
|
-
# information, see [Grant cross-account permissions to a role and a
|
2418
|
-
#
|
2700
|
+
# information, see [Grant cross-account permissions to a role and a
|
2701
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
2419
2702
|
#
|
2420
2703
|
# </note>
|
2421
2704
|
#
|
@@ -2456,8 +2739,8 @@ module Aws::SQS
|
|
2456
2739
|
# SQS Developer Guide*.
|
2457
2740
|
#
|
2458
2741
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2459
|
-
# information, see [Grant cross-account permissions to a role and a
|
2460
|
-
#
|
2742
|
+
# information, see [Grant cross-account permissions to a role and a
|
2743
|
+
# username][2] in the *Amazon SQS Developer Guide*.
|
2461
2744
|
#
|
2462
2745
|
# </note>
|
2463
2746
|
#
|
@@ -2503,7 +2786,7 @@ module Aws::SQS
|
|
2503
2786
|
params: params,
|
2504
2787
|
config: config)
|
2505
2788
|
context[:gem_name] = 'aws-sdk-sqs'
|
2506
|
-
context[:gem_version] = '1.
|
2789
|
+
context[:gem_version] = '1.62.0'
|
2507
2790
|
Seahorse::Client::Request.new(handlers, context)
|
2508
2791
|
end
|
2509
2792
|
|