aws-sdk-sqs 1.51.1 → 1.58.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +42 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +395 -152
- data/lib/aws-sdk-sqs/client_api.rb +76 -0
- data/lib/aws-sdk-sqs/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-sqs/endpoint_provider.rb +57 -0
- data/lib/aws-sdk-sqs/endpoints.rb +338 -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 +114 -0
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +4 -10
- 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 +349 -379
- data/lib/aws-sdk-sqs.rb +5 -1
- metadata +8 -4
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
|
|
30
30
|
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
33
|
-
require 'aws-sdk-core/plugins/
|
33
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
34
34
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
35
35
|
require 'aws-sdk-sqs/plugins/queue_urls.rb'
|
36
36
|
require 'aws-sdk-sqs/plugins/md5s.rb'
|
@@ -81,10 +81,11 @@ module Aws::SQS
|
|
81
81
|
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
82
82
|
add_plugin(Aws::Plugins::DefaultsMode)
|
83
83
|
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
-
add_plugin(Aws::Plugins::
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
85
85
|
add_plugin(Aws::Plugins::Protocols::Query)
|
86
86
|
add_plugin(Aws::SQS::Plugins::QueueUrls)
|
87
87
|
add_plugin(Aws::SQS::Plugins::Md5s)
|
88
|
+
add_plugin(Aws::SQS::Plugins::Endpoints)
|
88
89
|
|
89
90
|
# @overload initialize(options)
|
90
91
|
# @param [Hash] options
|
@@ -278,6 +279,11 @@ module Aws::SQS
|
|
278
279
|
# in the future.
|
279
280
|
#
|
280
281
|
#
|
282
|
+
# @option options [String] :sdk_ua_app_id
|
283
|
+
# A unique and opaque application ID that is appended to the
|
284
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
285
|
+
# maximum length of 50.
|
286
|
+
#
|
281
287
|
# @option options [String] :secret_access_key
|
282
288
|
#
|
283
289
|
# @option options [String] :session_token
|
@@ -291,6 +297,19 @@ module Aws::SQS
|
|
291
297
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
292
298
|
# requests are made, and retries are disabled.
|
293
299
|
#
|
300
|
+
# @option options [Aws::TokenProvider] :token_provider
|
301
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
302
|
+
# following classes:
|
303
|
+
#
|
304
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
305
|
+
# tokens.
|
306
|
+
#
|
307
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
308
|
+
# access token generated from `aws login`.
|
309
|
+
#
|
310
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
311
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
312
|
+
#
|
294
313
|
# @option options [Boolean] :use_dualstack_endpoint
|
295
314
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
296
315
|
# will be used if available.
|
@@ -310,6 +329,9 @@ module Aws::SQS
|
|
310
329
|
# `Aws::Errors::Checksum` errors are raised for cases where checksums do
|
311
330
|
# not match.
|
312
331
|
#
|
332
|
+
# @option options [Aws::SQS::EndpointProvider] :endpoint_provider
|
333
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SQS::EndpointParameters`
|
334
|
+
#
|
313
335
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
314
336
|
# requests through. Formatted like 'http://proxy.com:123'.
|
315
337
|
#
|
@@ -375,25 +397,21 @@ module Aws::SQS
|
|
375
397
|
# see [Using Custom Policies with the Amazon SQS Access Policy
|
376
398
|
# Language][3] in the *Amazon SQS Developer Guide*.
|
377
399
|
#
|
378
|
-
# * An Amazon SQS policy can have a maximum of
|
400
|
+
# * An Amazon SQS policy can have a maximum of seven actions per
|
401
|
+
# statement.
|
379
402
|
#
|
380
403
|
# * To remove the ability to change queue permissions, you must deny
|
381
404
|
# permission to the `AddPermission`, `RemovePermission`, and
|
382
405
|
# `SetQueueAttributes` actions in your IAM policy.
|
383
406
|
#
|
384
|
-
#
|
385
|
-
#
|
386
|
-
# Some actions take lists of parameters. These lists are specified using
|
387
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
388
|
-
# For example, a parameter list with two elements looks like this:
|
407
|
+
# * Amazon SQS `AddPermission` does not support adding a non-account
|
408
|
+
# principal.
|
389
409
|
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
# `&AttributeName.2=second`
|
410
|
+
# </note>
|
393
411
|
#
|
394
412
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
395
|
-
# information, see [Grant cross-account permissions to a role and a
|
396
|
-
#
|
413
|
+
# information, see [Grant cross-account permissions to a role and a
|
414
|
+
# username][4] in the *Amazon SQS Developer Guide*.
|
397
415
|
#
|
398
416
|
# </note>
|
399
417
|
#
|
@@ -464,18 +482,57 @@ module Aws::SQS
|
|
464
482
|
req.send_request(options)
|
465
483
|
end
|
466
484
|
|
485
|
+
# Cancels a specified message movement task.
|
486
|
+
#
|
487
|
+
# <note markdown="1"> * A message movement can only be cancelled when the current status is
|
488
|
+
# RUNNING.
|
489
|
+
#
|
490
|
+
# * Cancelling a message movement task does not revert the messages that
|
491
|
+
# have already been moved. It can only stop the messages that have not
|
492
|
+
# been moved yet.
|
493
|
+
#
|
494
|
+
# </note>
|
495
|
+
#
|
496
|
+
# @option params [required, String] :task_handle
|
497
|
+
# An identifier associated with a message movement task.
|
498
|
+
#
|
499
|
+
# @return [Types::CancelMessageMoveTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
500
|
+
#
|
501
|
+
# * {Types::CancelMessageMoveTaskResult#approximate_number_of_messages_moved #approximate_number_of_messages_moved} => Integer
|
502
|
+
#
|
503
|
+
# @example Request syntax with placeholder values
|
504
|
+
#
|
505
|
+
# resp = client.cancel_message_move_task({
|
506
|
+
# task_handle: "String", # required
|
507
|
+
# })
|
508
|
+
#
|
509
|
+
# @example Response structure
|
510
|
+
#
|
511
|
+
# resp.approximate_number_of_messages_moved #=> Integer
|
512
|
+
#
|
513
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTask AWS API Documentation
|
514
|
+
#
|
515
|
+
# @overload cancel_message_move_task(params = {})
|
516
|
+
# @param [Hash] params ({})
|
517
|
+
def cancel_message_move_task(params = {}, options = {})
|
518
|
+
req = build_request(:cancel_message_move_task, params)
|
519
|
+
req.send_request(options)
|
520
|
+
end
|
521
|
+
|
467
522
|
# Changes the visibility timeout of a specified message in a queue to a
|
468
523
|
# new value. The default visibility timeout for a message is 30 seconds.
|
469
524
|
# The minimum is 0 seconds. The maximum is 12 hours. For more
|
470
525
|
# information, see [Visibility Timeout][1] in the *Amazon SQS Developer
|
471
526
|
# Guide*.
|
472
527
|
#
|
473
|
-
# For example,
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
478
|
-
#
|
528
|
+
# For example, if the default timeout for a queue is 60 seconds, 15
|
529
|
+
# seconds have elapsed since you received the message, and you send a
|
530
|
+
# ChangeMessageVisibility call with `VisibilityTimeout` set to 10
|
531
|
+
# seconds, the 10 seconds begin to count from the time that you make the
|
532
|
+
# `ChangeMessageVisibility` call. Thus, any attempt to change the
|
533
|
+
# visibility timeout or to delete that message 10 seconds after you
|
534
|
+
# initially change the visibility timeout (a total of 25 seconds) might
|
535
|
+
# result in an error.
|
479
536
|
#
|
480
537
|
# An Amazon SQS message has three basic states:
|
481
538
|
#
|
@@ -491,13 +548,13 @@ module Aws::SQS
|
|
491
548
|
# messages. A message is considered to be *in flight* after it is
|
492
549
|
# received from a queue by a consumer, but not yet deleted from the
|
493
550
|
# queue (that is, between states 2 and 3). There is a limit to the
|
494
|
-
# number of
|
551
|
+
# number of in flight messages.
|
495
552
|
#
|
496
|
-
# Limits that apply to
|
553
|
+
# Limits that apply to in flight messages are unrelated to the
|
497
554
|
# *unlimited* number of stored messages.
|
498
555
|
#
|
499
556
|
# For most standard queues (depending on queue traffic and message
|
500
|
-
# backlog), there can be a maximum of approximately 120,000
|
557
|
+
# backlog), there can be a maximum of approximately 120,000 in flight
|
501
558
|
# messages (received from a queue by a consumer, but not yet deleted
|
502
559
|
# from the queue). If you reach this limit, Amazon SQS returns the
|
503
560
|
# `OverLimit` error message. To avoid reaching the limit, you should
|
@@ -505,7 +562,7 @@ module Aws::SQS
|
|
505
562
|
# increase the number of queues you use to process your messages. To
|
506
563
|
# request a limit increase, [file a support request][2].
|
507
564
|
#
|
508
|
-
# For FIFO queues, there can be a maximum of 20,000
|
565
|
+
# For FIFO queues, there can be a maximum of 20,000 in flight messages
|
509
566
|
# (received from a queue by a consumer, but not yet deleted from the
|
510
567
|
# queue). If you reach this limit, Amazon SQS returns no error messages.
|
511
568
|
#
|
@@ -534,7 +591,7 @@ module Aws::SQS
|
|
534
591
|
# Queue URLs and names are case-sensitive.
|
535
592
|
#
|
536
593
|
# @option params [required, String] :receipt_handle
|
537
|
-
# The receipt handle associated with the message whose visibility
|
594
|
+
# The receipt handle associated with the message, whose visibility
|
538
595
|
# timeout is changed. This parameter is returned by the ` ReceiveMessage
|
539
596
|
# ` action.
|
540
597
|
#
|
@@ -571,14 +628,6 @@ module Aws::SQS
|
|
571
628
|
# and unsuccessful actions, you should check for batch errors even when
|
572
629
|
# the call returns an HTTP status code of `200`.
|
573
630
|
#
|
574
|
-
# Some actions take lists of parameters. These lists are specified using
|
575
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
576
|
-
# For example, a parameter list with two elements looks like this:
|
577
|
-
#
|
578
|
-
# `&AttributeName.1=first`
|
579
|
-
#
|
580
|
-
# `&AttributeName.2=second`
|
581
|
-
#
|
582
631
|
# @option params [required, String] :queue_url
|
583
632
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
584
633
|
# changed.
|
@@ -586,7 +635,7 @@ module Aws::SQS
|
|
586
635
|
# Queue URLs and names are case-sensitive.
|
587
636
|
#
|
588
637
|
# @option params [required, Array<Types::ChangeMessageVisibilityBatchRequestEntry>] :entries
|
589
|
-
#
|
638
|
+
# Lists the receipt handles of the messages for which the visibility
|
590
639
|
# timeout must be changed.
|
591
640
|
#
|
592
641
|
# @return [Types::ChangeMessageVisibilityBatchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
@@ -667,17 +716,9 @@ module Aws::SQS
|
|
667
716
|
# * If the queue name, attribute names, or attribute values don't match
|
668
717
|
# an existing queue, `CreateQueue` returns an error.
|
669
718
|
#
|
670
|
-
# Some actions take lists of parameters. These lists are specified using
|
671
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
672
|
-
# For example, a parameter list with two elements looks like this:
|
673
|
-
#
|
674
|
-
# `&AttributeName.1=first`
|
675
|
-
#
|
676
|
-
# `&AttributeName.2=second`
|
677
|
-
#
|
678
719
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
679
|
-
# information, see [Grant cross-account permissions to a role and a
|
680
|
-
#
|
720
|
+
# information, see [Grant cross-account permissions to a role and a
|
721
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
681
722
|
#
|
682
723
|
# </note>
|
683
724
|
#
|
@@ -717,43 +758,77 @@ module Aws::SQS
|
|
717
758
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
718
759
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
719
760
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
720
|
-
# (4 days).
|
761
|
+
# (4 days). When you change a queue's attributes, the change can take
|
762
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
763
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
764
|
+
# attribute can take up to 15 minutes and will impact existing
|
765
|
+
# messages in the queue potentially causing them to be expired and
|
766
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
767
|
+
# existing messages.
|
721
768
|
#
|
722
769
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
723
770
|
# For more information about policy structure, see [Overview of Amazon
|
724
|
-
# Web Services IAM Policies][1] in the *
|
771
|
+
# Web Services IAM Policies][1] in the *IAM User Guide*.
|
725
772
|
#
|
726
773
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
727
774
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
728
775
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
729
776
|
#
|
777
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
778
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
779
|
+
# Default: 30. For more information about the visibility timeout, see
|
780
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
781
|
+
#
|
782
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
783
|
+
#
|
730
784
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
731
785
|
# dead-letter queue functionality of the source queue as a JSON
|
732
|
-
# object.
|
733
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
734
|
-
# the *Amazon SQS Developer Guide*.
|
786
|
+
# object. The parameters are as follows:
|
735
787
|
#
|
736
788
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
737
789
|
# dead-letter queue to which Amazon SQS moves messages after the
|
738
790
|
# value of `maxReceiveCount` is exceeded.
|
739
791
|
#
|
740
792
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
741
|
-
# the source queue before being moved to the dead-letter queue.
|
742
|
-
# the `ReceiveCount` for a message exceeds the
|
743
|
-
# a queue, Amazon SQS moves the message to the
|
744
|
-
#
|
745
|
-
#
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
793
|
+
# the source queue before being moved to the dead-letter queue.
|
794
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
795
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
796
|
+
# dead-letter-queue.
|
797
|
+
#
|
798
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
799
|
+
# the permissions for the dead-letter queue redrive permission and
|
800
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
801
|
+
# The parameters are as follows:
|
802
|
+
#
|
803
|
+
# * `redrivePermission` – The permission type that defines which
|
804
|
+
# source queues can specify the current queue as the dead-letter
|
805
|
+
# queue. Valid values are:
|
806
|
+
#
|
807
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
808
|
+
# Services account in the same Region can specify this queue as
|
809
|
+
# the dead-letter queue.
|
810
|
+
#
|
811
|
+
# * `denyAll` – No source queues can specify this queue as the
|
812
|
+
# dead-letter queue.
|
813
|
+
#
|
814
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
815
|
+
# parameter can specify this queue as the dead-letter queue.
|
816
|
+
#
|
817
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
818
|
+
# queues that can specify this queue as the dead-letter queue and
|
819
|
+
# redrive messages. You can specify this parameter only when the
|
820
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
821
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
822
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
823
|
+
# to `allowAll`.
|
824
|
+
#
|
825
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
826
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
827
|
+
# standard queue.
|
750
828
|
#
|
751
|
-
#
|
752
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
753
|
-
# Default: 30. For more information about the visibility timeout, see
|
754
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
829
|
+
# </note>
|
755
830
|
#
|
756
|
-
# The following attributes apply only to [server-side-encryption][4]
|
831
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
757
832
|
#
|
758
833
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
759
834
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -770,14 +845,14 @@ module Aws::SQS
|
|
770
845
|
# Default: 300 (5 minutes). A shorter time period provides better
|
771
846
|
# security but results in more calls to KMS which might incur charges
|
772
847
|
# after Free Tier. For more information, see [How Does the Data Key
|
773
|
-
# Reuse Period Work?][8]
|
848
|
+
# Reuse Period Work?][8]
|
774
849
|
#
|
775
850
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
776
851
|
# SQS owned encryption keys. Only one server-side encryption option is
|
777
|
-
# supported per queue (
|
852
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
778
853
|
#
|
779
854
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
780
|
-
# queues][11]
|
855
|
+
# queues][11]:
|
781
856
|
#
|
782
857
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
783
858
|
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
@@ -823,7 +898,7 @@ module Aws::SQS
|
|
823
898
|
# duplicates and only one copy of the message is delivered.
|
824
899
|
#
|
825
900
|
# The following attributes apply only to [high throughput for FIFO
|
826
|
-
# queues][14]
|
901
|
+
# queues][14]:
|
827
902
|
#
|
828
903
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
829
904
|
# occurs at the message group or queue level. Valid values are
|
@@ -851,8 +926,8 @@ module Aws::SQS
|
|
851
926
|
#
|
852
927
|
#
|
853
928
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
854
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
855
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
929
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
930
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
856
931
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
857
932
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
858
933
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -890,8 +965,8 @@ module Aws::SQS
|
|
890
965
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
891
966
|
#
|
892
967
|
# Cross-account permissions don't apply to this action. For more
|
893
|
-
# information, see [Grant cross-account permissions to a role and a
|
894
|
-
#
|
968
|
+
# information, see [Grant cross-account permissions to a role and a
|
969
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
895
970
|
#
|
896
971
|
# </note>
|
897
972
|
#
|
@@ -943,7 +1018,7 @@ module Aws::SQS
|
|
943
1018
|
# `ReceiptHandle` is different each time you receive a message. When you
|
944
1019
|
# use the `DeleteMessage` action, you must provide the most recently
|
945
1020
|
# received `ReceiptHandle` for the message (otherwise, the request
|
946
|
-
# succeeds, but the message
|
1021
|
+
# succeeds, but the message will not be deleted).
|
947
1022
|
#
|
948
1023
|
# For standard queues, it is possible to receive a message even after
|
949
1024
|
# you delete it. This might happen on rare occasions if one of the
|
@@ -989,21 +1064,13 @@ module Aws::SQS
|
|
989
1064
|
# and unsuccessful actions, you should check for batch errors even when
|
990
1065
|
# the call returns an HTTP status code of `200`.
|
991
1066
|
#
|
992
|
-
# Some actions take lists of parameters. These lists are specified using
|
993
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
994
|
-
# For example, a parameter list with two elements looks like this:
|
995
|
-
#
|
996
|
-
# `&AttributeName.1=first`
|
997
|
-
#
|
998
|
-
# `&AttributeName.2=second`
|
999
|
-
#
|
1000
1067
|
# @option params [required, String] :queue_url
|
1001
1068
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
1002
1069
|
#
|
1003
1070
|
# Queue URLs and names are case-sensitive.
|
1004
1071
|
#
|
1005
1072
|
# @option params [required, Array<Types::DeleteMessageBatchRequestEntry>] :entries
|
1006
|
-
#
|
1073
|
+
# Lists the receipt handles for the messages to be deleted.
|
1007
1074
|
#
|
1008
1075
|
# @return [Types::DeleteMessageBatchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1009
1076
|
#
|
@@ -1056,8 +1123,10 @@ module Aws::SQS
|
|
1056
1123
|
# creating a queue with the same name.
|
1057
1124
|
#
|
1058
1125
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1059
|
-
# information, see [Grant cross-account permissions to a role and a
|
1060
|
-
#
|
1126
|
+
# information, see [Grant cross-account permissions to a role and a
|
1127
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1128
|
+
#
|
1129
|
+
# The delete operation uses the HTTP `GET` verb.
|
1061
1130
|
#
|
1062
1131
|
# </note>
|
1063
1132
|
#
|
@@ -1107,7 +1176,7 @@ module Aws::SQS
|
|
1107
1176
|
# @option params [Array<String>] :attribute_names
|
1108
1177
|
# A list of attributes for which to retrieve information.
|
1109
1178
|
#
|
1110
|
-
# The `
|
1179
|
+
# The `AttributeNames` parameter is optional, but if you don't specify
|
1111
1180
|
# values for this parameter, the request returns empty results.
|
1112
1181
|
#
|
1113
1182
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
@@ -1120,10 +1189,10 @@ module Aws::SQS
|
|
1120
1189
|
#
|
1121
1190
|
# The `ApproximateNumberOfMessagesDelayed`,
|
1122
1191
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
1123
|
-
# `
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
#
|
1192
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
1193
|
+
# until at least 1 minute after the producers stop sending messages.
|
1194
|
+
# This period is required for the queue metadata to reach eventual
|
1195
|
+
# consistency.
|
1127
1196
|
#
|
1128
1197
|
# * `All` – Returns all values.
|
1129
1198
|
#
|
@@ -1153,7 +1222,14 @@ module Aws::SQS
|
|
1153
1222
|
# can contain before Amazon SQS rejects it.
|
1154
1223
|
#
|
1155
1224
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1156
|
-
# for which Amazon SQS retains a message.
|
1225
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
1226
|
+
# attributes, the change can take up to 60 seconds for most of the
|
1227
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
1228
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
1229
|
+
# minutes and will impact existing messages in the queue potentially
|
1230
|
+
# causing them to be expired and deleted if the
|
1231
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
1232
|
+
# messages.
|
1157
1233
|
#
|
1158
1234
|
# * `Policy` – Returns the policy of the queue.
|
1159
1235
|
#
|
@@ -1163,26 +1239,60 @@ module Aws::SQS
|
|
1163
1239
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1164
1240
|
# to arrive.
|
1165
1241
|
#
|
1242
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1243
|
+
# For more information about the visibility timeout, see [Visibility
|
1244
|
+
# Timeout][2] in the *Amazon SQS Developer Guide*.
|
1245
|
+
#
|
1246
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
1247
|
+
#
|
1166
1248
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
1167
1249
|
# dead-letter queue functionality of the source queue as a JSON
|
1168
|
-
# object.
|
1169
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1170
|
-
# the *Amazon SQS Developer Guide*.
|
1250
|
+
# object. The parameters are as follows:
|
1171
1251
|
#
|
1172
1252
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1173
1253
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1174
1254
|
# value of `maxReceiveCount` is exceeded.
|
1175
1255
|
#
|
1176
1256
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
1177
|
-
# the source queue before being moved to the dead-letter queue.
|
1178
|
-
# the `ReceiveCount` for a message exceeds the
|
1179
|
-
# a queue, Amazon SQS moves the message to the
|
1257
|
+
# the source queue before being moved to the dead-letter queue.
|
1258
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
1259
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
1260
|
+
# dead-letter-queue.
|
1261
|
+
#
|
1262
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
1263
|
+
# the permissions for the dead-letter queue redrive permission and
|
1264
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
1265
|
+
# The parameters are as follows:
|
1266
|
+
#
|
1267
|
+
# * `redrivePermission` – The permission type that defines which
|
1268
|
+
# source queues can specify the current queue as the dead-letter
|
1269
|
+
# queue. Valid values are:
|
1270
|
+
#
|
1271
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
1272
|
+
# Services account in the same Region can specify this queue as
|
1273
|
+
# the dead-letter queue.
|
1274
|
+
#
|
1275
|
+
# * `denyAll` – No source queues can specify this queue as the
|
1276
|
+
# dead-letter queue.
|
1277
|
+
#
|
1278
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
1279
|
+
# parameter can specify this queue as the dead-letter queue.
|
1280
|
+
#
|
1281
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
1282
|
+
# queues that can specify this queue as the dead-letter queue and
|
1283
|
+
# redrive messages. You can specify this parameter only when the
|
1284
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
1285
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
1286
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
1287
|
+
# to `allowAll`.
|
1288
|
+
#
|
1289
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
1290
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
1291
|
+
# standard queue.
|
1180
1292
|
#
|
1181
|
-
#
|
1182
|
-
# For more information about the visibility timeout, see [Visibility
|
1183
|
-
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1293
|
+
# </note>
|
1184
1294
|
#
|
1185
|
-
# The following attributes apply only to [server-side-encryption][4]
|
1295
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
1186
1296
|
#
|
1187
1297
|
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services managed
|
1188
1298
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -1195,11 +1305,11 @@ module Aws::SQS
|
|
1195
1305
|
#
|
1196
1306
|
# * `SqsManagedSseEnabled` – Returns information about whether the queue
|
1197
1307
|
# is using SSE-SQS encryption using SQS owned encryption keys. Only
|
1198
|
-
# one server-side encryption option is supported per queue (
|
1199
|
-
# [SSE-KMS][7] or [SSE-SQS][8]).
|
1308
|
+
# one server-side encryption option is supported per queue (for
|
1309
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
1200
1310
|
#
|
1201
1311
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1202
|
-
# queues][9]
|
1312
|
+
# queues][9]:
|
1203
1313
|
#
|
1204
1314
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1205
1315
|
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
@@ -1215,7 +1325,7 @@ module Aws::SQS
|
|
1215
1325
|
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
1216
1326
|
#
|
1217
1327
|
# The following attributes apply only to [high throughput for FIFO
|
1218
|
-
# queues][12]
|
1328
|
+
# queues][12]:
|
1219
1329
|
#
|
1220
1330
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
1221
1331
|
# occurs at the message group or queue level. Valid values are
|
@@ -1243,8 +1353,8 @@ module Aws::SQS
|
|
1243
1353
|
#
|
1244
1354
|
#
|
1245
1355
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1246
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
1247
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
1356
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1357
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
1248
1358
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
1249
1359
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
1250
1360
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -1391,13 +1501,57 @@ module Aws::SQS
|
|
1391
1501
|
req.send_request(options)
|
1392
1502
|
end
|
1393
1503
|
|
1504
|
+
# Gets the most recent message movement tasks (up to 10) under a
|
1505
|
+
# specific source queue.
|
1506
|
+
#
|
1507
|
+
# @option params [required, String] :source_arn
|
1508
|
+
# The ARN of the queue whose message movement tasks are to be listed.
|
1509
|
+
#
|
1510
|
+
# @option params [Integer] :max_results
|
1511
|
+
# The maximum number of results to include in the response. The default
|
1512
|
+
# is 1, which provides the most recent message movement task. The upper
|
1513
|
+
# limit is 10.
|
1514
|
+
#
|
1515
|
+
# @return [Types::ListMessageMoveTasksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1516
|
+
#
|
1517
|
+
# * {Types::ListMessageMoveTasksResult#results #results} => Array<Types::ListMessageMoveTasksResultEntry>
|
1518
|
+
#
|
1519
|
+
# @example Request syntax with placeholder values
|
1520
|
+
#
|
1521
|
+
# resp = client.list_message_move_tasks({
|
1522
|
+
# source_arn: "String", # required
|
1523
|
+
# max_results: 1,
|
1524
|
+
# })
|
1525
|
+
#
|
1526
|
+
# @example Response structure
|
1527
|
+
#
|
1528
|
+
# resp.results #=> Array
|
1529
|
+
# resp.results[0].task_handle #=> String
|
1530
|
+
# resp.results[0].status #=> String
|
1531
|
+
# resp.results[0].source_arn #=> String
|
1532
|
+
# resp.results[0].destination_arn #=> String
|
1533
|
+
# resp.results[0].max_number_of_messages_per_second #=> Integer
|
1534
|
+
# resp.results[0].approximate_number_of_messages_moved #=> Integer
|
1535
|
+
# resp.results[0].approximate_number_of_messages_to_move #=> Integer
|
1536
|
+
# resp.results[0].failure_reason #=> String
|
1537
|
+
# resp.results[0].started_timestamp #=> Integer
|
1538
|
+
#
|
1539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasks AWS API Documentation
|
1540
|
+
#
|
1541
|
+
# @overload list_message_move_tasks(params = {})
|
1542
|
+
# @param [Hash] params ({})
|
1543
|
+
def list_message_move_tasks(params = {}, options = {})
|
1544
|
+
req = build_request(:list_message_move_tasks, params)
|
1545
|
+
req.send_request(options)
|
1546
|
+
end
|
1547
|
+
|
1394
1548
|
# List all cost allocation tags added to the specified Amazon SQS queue.
|
1395
1549
|
# For an overview, see [Tagging Your Amazon SQS Queues][1] in the
|
1396
1550
|
# *Amazon SQS Developer Guide*.
|
1397
1551
|
#
|
1398
1552
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1399
|
-
# information, see [Grant cross-account permissions to a role and a
|
1400
|
-
#
|
1553
|
+
# information, see [Grant cross-account permissions to a role and a
|
1554
|
+
# username][2] in the *Amazon SQS Developer Guide*.
|
1401
1555
|
#
|
1402
1556
|
# </note>
|
1403
1557
|
#
|
@@ -1447,8 +1601,8 @@ module Aws::SQS
|
|
1447
1601
|
# request to `listQueues` to receive the next page of results.
|
1448
1602
|
#
|
1449
1603
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1450
|
-
# information, see [Grant cross-account permissions to a role and a
|
1451
|
-
#
|
1604
|
+
# information, see [Grant cross-account permissions to a role and a
|
1605
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1452
1606
|
#
|
1453
1607
|
# </note>
|
1454
1608
|
#
|
@@ -1616,7 +1770,7 @@ module Aws::SQS
|
|
1616
1770
|
#
|
1617
1771
|
# * `SenderId`
|
1618
1772
|
#
|
1619
|
-
# * For
|
1773
|
+
# * For a user, returns the user ID, for example
|
1620
1774
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1621
1775
|
#
|
1622
1776
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1627,7 +1781,7 @@ module Aws::SQS
|
|
1627
1781
|
#
|
1628
1782
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
1629
1783
|
# SQS owned encryption keys. Only one server-side encryption option is
|
1630
|
-
# supported per queue (
|
1784
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
1631
1785
|
#
|
1632
1786
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1633
1787
|
# producer that calls the ` SendMessage ` action.
|
@@ -1810,7 +1964,7 @@ module Aws::SQS
|
|
1810
1964
|
#
|
1811
1965
|
# * Cross-account permissions don't apply to this action. For more
|
1812
1966
|
# information, see [Grant cross-account permissions to a role and a
|
1813
|
-
#
|
1967
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1814
1968
|
#
|
1815
1969
|
# * To remove the ability to change queue permissions, you must deny
|
1816
1970
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1871,7 +2025,7 @@ module Aws::SQS
|
|
1871
2025
|
#
|
1872
2026
|
# @option params [required, String] :message_body
|
1873
2027
|
# The message to send. The minimum size is one character. The maximum
|
1874
|
-
# size is 256
|
2028
|
+
# size is 256 KiB.
|
1875
2029
|
#
|
1876
2030
|
# A message can include only XML, JSON, and unformatted text. The
|
1877
2031
|
# following Unicode characters are allowed:
|
@@ -2066,7 +2220,9 @@ module Aws::SQS
|
|
2066
2220
|
req.send_request(options)
|
2067
2221
|
end
|
2068
2222
|
|
2069
|
-
#
|
2223
|
+
# You can use `SendMessageBatch` to send up to 10 messages to the
|
2224
|
+
# specified queue by assigning either identical or different values to
|
2225
|
+
# each message (or by not assigning values at all). This is a batch
|
2070
2226
|
# version of ` SendMessage.` For a FIFO queue, multiple messages within
|
2071
2227
|
# a single batch are enqueued in the order they are sent.
|
2072
2228
|
#
|
@@ -2077,7 +2233,7 @@ module Aws::SQS
|
|
2077
2233
|
#
|
2078
2234
|
# The maximum allowed individual message size and the maximum total
|
2079
2235
|
# payload size (the sum of the individual lengths of all of the batched
|
2080
|
-
# messages) are both 256
|
2236
|
+
# messages) are both 256 KiB (262,144 bytes).
|
2081
2237
|
#
|
2082
2238
|
# A message can include only XML, JSON, and unformatted text. The
|
2083
2239
|
# following Unicode characters are allowed:
|
@@ -2091,14 +2247,6 @@ module Aws::SQS
|
|
2091
2247
|
# If you don't specify the `DelaySeconds` parameter for an entry,
|
2092
2248
|
# Amazon SQS uses the default value for the queue.
|
2093
2249
|
#
|
2094
|
-
# Some actions take lists of parameters. These lists are specified using
|
2095
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
2096
|
-
# For example, a parameter list with two elements looks like this:
|
2097
|
-
#
|
2098
|
-
# `&AttributeName.1=first`
|
2099
|
-
#
|
2100
|
-
# `&AttributeName.2=second`
|
2101
|
-
#
|
2102
2250
|
#
|
2103
2251
|
#
|
2104
2252
|
# [1]: http://www.w3.org/TR/REC-xml/#charsets
|
@@ -2177,7 +2325,9 @@ module Aws::SQS
|
|
2177
2325
|
# queue's attributes, the change can take up to 60 seconds for most of
|
2178
2326
|
# the attributes to propagate throughout the Amazon SQS system. Changes
|
2179
2327
|
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
2180
|
-
# minutes
|
2328
|
+
# minutes and will impact existing messages in the queue potentially
|
2329
|
+
# causing them to be expired and deleted if the `MessageRetentionPeriod`
|
2330
|
+
# is reduced below the age of existing messages.
|
2181
2331
|
#
|
2182
2332
|
# <note markdown="1"> * In the future, new attributes might be added. If you write code that
|
2183
2333
|
# calls this action, we recommend that you structure your code so that
|
@@ -2185,7 +2335,7 @@ module Aws::SQS
|
|
2185
2335
|
#
|
2186
2336
|
# * Cross-account permissions don't apply to this action. For more
|
2187
2337
|
# information, see [Grant cross-account permissions to a role and a
|
2188
|
-
#
|
2338
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
2189
2339
|
#
|
2190
2340
|
# * To remove the ability to change queue permissions, you must deny
|
2191
2341
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2220,7 +2370,13 @@ module Aws::SQS
|
|
2220
2370
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2221
2371
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2222
2372
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2223
|
-
# (4 days).
|
2373
|
+
# (4 days). When you change a queue's attributes, the change can take
|
2374
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
2375
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
2376
|
+
# attribute can take up to 15 minutes and will impact existing
|
2377
|
+
# messages in the queue potentially causing them to be expired and
|
2378
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
2379
|
+
# existing messages.
|
2224
2380
|
#
|
2225
2381
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
2226
2382
|
# For more information about policy structure, see [Overview of Amazon
|
@@ -2231,33 +2387,61 @@ module Aws::SQS
|
|
2231
2387
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2232
2388
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2233
2389
|
#
|
2390
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2391
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2392
|
+
# Default: 30. For more information about the visibility timeout, see
|
2393
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2394
|
+
#
|
2395
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2396
|
+
#
|
2234
2397
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2235
2398
|
# dead-letter queue functionality of the source queue as a JSON
|
2236
|
-
# object.
|
2237
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2238
|
-
# the *Amazon SQS Developer Guide*.
|
2399
|
+
# object. The parameters are as follows:
|
2239
2400
|
#
|
2240
2401
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2241
2402
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2242
2403
|
# value of `maxReceiveCount` is exceeded.
|
2243
2404
|
#
|
2244
2405
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
2245
|
-
# the source queue before being moved to the dead-letter queue.
|
2246
|
-
# the `ReceiveCount` for a message exceeds the
|
2247
|
-
# a queue, Amazon SQS moves the message to the
|
2406
|
+
# the source queue before being moved to the dead-letter queue.
|
2407
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2408
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
2409
|
+
# dead-letter-queue.
|
2410
|
+
#
|
2411
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2412
|
+
# the permissions for the dead-letter queue redrive permission and
|
2413
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
2414
|
+
# The parameters are as follows:
|
2415
|
+
#
|
2416
|
+
# * `redrivePermission` – The permission type that defines which
|
2417
|
+
# source queues can specify the current queue as the dead-letter
|
2418
|
+
# queue. Valid values are:
|
2419
|
+
#
|
2420
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2421
|
+
# Services account in the same Region can specify this queue as
|
2422
|
+
# the dead-letter queue.
|
2423
|
+
#
|
2424
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2425
|
+
# dead-letter queue.
|
2426
|
+
#
|
2427
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2428
|
+
# parameter can specify this queue as the dead-letter queue.
|
2429
|
+
#
|
2430
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
2431
|
+
# queues that can specify this queue as the dead-letter queue and
|
2432
|
+
# redrive messages. You can specify this parameter only when the
|
2433
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
2434
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
2435
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
2436
|
+
# to `allowAll`.
|
2437
|
+
#
|
2438
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2439
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2440
|
+
# standard queue.
|
2248
2441
|
#
|
2249
|
-
#
|
2250
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
2251
|
-
# standard queue.
|
2252
|
-
#
|
2253
|
-
# </note>
|
2254
|
-
#
|
2255
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2256
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2257
|
-
# Default: 30. For more information about the visibility timeout, see
|
2258
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2442
|
+
# </note>
|
2259
2443
|
#
|
2260
|
-
# The following attributes apply only to [server-side-encryption][4]
|
2444
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
2261
2445
|
#
|
2262
2446
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
2263
2447
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -2277,10 +2461,10 @@ module Aws::SQS
|
|
2277
2461
|
#
|
2278
2462
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
2279
2463
|
# SQS owned encryption keys. Only one server-side encryption option is
|
2280
|
-
# supported per queue (
|
2464
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
2281
2465
|
#
|
2282
2466
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2283
|
-
# queues][11]
|
2467
|
+
# queues][11]:
|
2284
2468
|
#
|
2285
2469
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2286
2470
|
# For more information, see [Exactly-once processing][12] in the
|
@@ -2315,7 +2499,7 @@ module Aws::SQS
|
|
2315
2499
|
# duplicates and only one copy of the message is delivered.
|
2316
2500
|
#
|
2317
2501
|
# The following attributes apply only to [high throughput for FIFO
|
2318
|
-
# queues][13]
|
2502
|
+
# queues][13]:
|
2319
2503
|
#
|
2320
2504
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2321
2505
|
# occurs at the message group or queue level. Valid values are
|
@@ -2343,8 +2527,8 @@ module Aws::SQS
|
|
2343
2527
|
#
|
2344
2528
|
#
|
2345
2529
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2346
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2347
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2530
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2531
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2348
2532
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2349
2533
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2350
2534
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2377,6 +2561,65 @@ module Aws::SQS
|
|
2377
2561
|
req.send_request(options)
|
2378
2562
|
end
|
2379
2563
|
|
2564
|
+
# Starts an asynchronous task to move messages from a specified source
|
2565
|
+
# queue to a specified destination queue.
|
2566
|
+
#
|
2567
|
+
# <note markdown="1"> * This action is currently limited to supporting message redrive from
|
2568
|
+
# dead-letter queues (DLQs) only. In this context, the source queue is
|
2569
|
+
# the dead-letter queue (DLQ), while the destination queue can be the
|
2570
|
+
# original source queue (from which the messages were driven to the
|
2571
|
+
# dead-letter-queue), or a custom destination queue.
|
2572
|
+
#
|
2573
|
+
# * Currently, only standard queues are supported.
|
2574
|
+
#
|
2575
|
+
# * Only one active message movement task is supported per queue at any
|
2576
|
+
# given time.
|
2577
|
+
#
|
2578
|
+
# </note>
|
2579
|
+
#
|
2580
|
+
# @option params [required, String] :source_arn
|
2581
|
+
# The ARN of the queue that contains the messages to be moved to another
|
2582
|
+
# queue. Currently, only dead-letter queue (DLQ) ARNs are accepted.
|
2583
|
+
#
|
2584
|
+
# @option params [String] :destination_arn
|
2585
|
+
# The ARN of the queue that receives the moved messages. You can use
|
2586
|
+
# this field to specify the destination queue where you would like to
|
2587
|
+
# redrive messages. If this field is left blank, the messages will be
|
2588
|
+
# redriven back to their respective original source queues.
|
2589
|
+
#
|
2590
|
+
# @option params [Integer] :max_number_of_messages_per_second
|
2591
|
+
# The number of messages to be moved per second (the message movement
|
2592
|
+
# rate). You can use this field to define a fixed message movement rate.
|
2593
|
+
# The maximum value for messages per second is 500. If this field is
|
2594
|
+
# left blank, the system will optimize the rate based on the queue
|
2595
|
+
# message backlog size, which may vary throughout the duration of the
|
2596
|
+
# message movement task.
|
2597
|
+
#
|
2598
|
+
# @return [Types::StartMessageMoveTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2599
|
+
#
|
2600
|
+
# * {Types::StartMessageMoveTaskResult#task_handle #task_handle} => String
|
2601
|
+
#
|
2602
|
+
# @example Request syntax with placeholder values
|
2603
|
+
#
|
2604
|
+
# resp = client.start_message_move_task({
|
2605
|
+
# source_arn: "String", # required
|
2606
|
+
# destination_arn: "String",
|
2607
|
+
# max_number_of_messages_per_second: 1,
|
2608
|
+
# })
|
2609
|
+
#
|
2610
|
+
# @example Response structure
|
2611
|
+
#
|
2612
|
+
# resp.task_handle #=> String
|
2613
|
+
#
|
2614
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTask AWS API Documentation
|
2615
|
+
#
|
2616
|
+
# @overload start_message_move_task(params = {})
|
2617
|
+
# @param [Hash] params ({})
|
2618
|
+
def start_message_move_task(params = {}, options = {})
|
2619
|
+
req = build_request(:start_message_move_task, params)
|
2620
|
+
req.send_request(options)
|
2621
|
+
end
|
2622
|
+
|
2380
2623
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
2381
2624
|
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
2382
2625
|
# Developer Guide*.
|
@@ -2397,8 +2640,8 @@ module Aws::SQS
|
|
2397
2640
|
# in the *Amazon SQS Developer Guide*.
|
2398
2641
|
#
|
2399
2642
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2400
|
-
# information, see [Grant cross-account permissions to a role and a
|
2401
|
-
#
|
2643
|
+
# information, see [Grant cross-account permissions to a role and a
|
2644
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
2402
2645
|
#
|
2403
2646
|
# </note>
|
2404
2647
|
#
|
@@ -2439,8 +2682,8 @@ module Aws::SQS
|
|
2439
2682
|
# SQS Developer Guide*.
|
2440
2683
|
#
|
2441
2684
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2442
|
-
# information, see [Grant cross-account permissions to a role and a
|
2443
|
-
#
|
2685
|
+
# information, see [Grant cross-account permissions to a role and a
|
2686
|
+
# username][2] in the *Amazon SQS Developer Guide*.
|
2444
2687
|
#
|
2445
2688
|
# </note>
|
2446
2689
|
#
|
@@ -2486,7 +2729,7 @@ module Aws::SQS
|
|
2486
2729
|
params: params,
|
2487
2730
|
config: config)
|
2488
2731
|
context[:gem_name] = 'aws-sdk-sqs'
|
2489
|
-
context[:gem_version] = '1.
|
2732
|
+
context[:gem_version] = '1.58.0'
|
2490
2733
|
Seahorse::Client::Request.new(handlers, context)
|
2491
2734
|
end
|
2492
2735
|
|