aws-sdk-sqs 1.52.1 → 1.54.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 +12 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +240 -149
- data/lib/aws-sdk-sqs/client_api.rb +219 -51
- data/lib/aws-sdk-sqs/endpoint_provider.rb +41 -100
- data/lib/aws-sdk-sqs/errors.rb +246 -0
- data/lib/aws-sdk-sqs/queue.rb +60 -26
- data/lib/aws-sdk-sqs/resource.rb +61 -27
- data/lib/aws-sdk-sqs/types.rb +452 -92
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -31,7 +31,7 @@ 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
33
|
require 'aws-sdk-core/plugins/sign.rb'
|
34
|
-
require 'aws-sdk-core/plugins/protocols/
|
34
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
35
35
|
require 'aws-sdk-sqs/plugins/queue_urls.rb'
|
36
36
|
require 'aws-sdk-sqs/plugins/md5s.rb'
|
37
37
|
|
@@ -82,7 +82,7 @@ module Aws::SQS
|
|
82
82
|
add_plugin(Aws::Plugins::DefaultsMode)
|
83
83
|
add_plugin(Aws::Plugins::RecursionDetection)
|
84
84
|
add_plugin(Aws::Plugins::Sign)
|
85
|
-
add_plugin(Aws::Plugins::Protocols::
|
85
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
86
86
|
add_plugin(Aws::SQS::Plugins::QueueUrls)
|
87
87
|
add_plugin(Aws::SQS::Plugins::Md5s)
|
88
88
|
add_plugin(Aws::SQS::Plugins::Endpoints)
|
@@ -283,6 +283,16 @@ module Aws::SQS
|
|
283
283
|
#
|
284
284
|
# @option options [String] :session_token
|
285
285
|
#
|
286
|
+
# @option options [Boolean] :simple_json (false)
|
287
|
+
# Disables request parameter conversion, validation, and formatting.
|
288
|
+
# Also disable response data type conversions. This option is useful
|
289
|
+
# when you want to ensure the highest level of performance by
|
290
|
+
# avoiding overhead of walking request parameters and response data
|
291
|
+
# structures.
|
292
|
+
#
|
293
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
294
|
+
# be formatted exactly as the DynamoDB API expects.
|
295
|
+
#
|
286
296
|
# @option options [Boolean] :stub_responses (false)
|
287
297
|
# Causes the client to return stubbed responses. By default
|
288
298
|
# fake responses are generated and returned. You can specify
|
@@ -392,25 +402,21 @@ module Aws::SQS
|
|
392
402
|
# see [Using Custom Policies with the Amazon SQS Access Policy
|
393
403
|
# Language][3] in the *Amazon SQS Developer Guide*.
|
394
404
|
#
|
395
|
-
# * An Amazon SQS policy can have a maximum of
|
405
|
+
# * An Amazon SQS policy can have a maximum of seven actions per
|
406
|
+
# statement.
|
396
407
|
#
|
397
408
|
# * To remove the ability to change queue permissions, you must deny
|
398
409
|
# permission to the `AddPermission`, `RemovePermission`, and
|
399
410
|
# `SetQueueAttributes` actions in your IAM policy.
|
400
411
|
#
|
401
|
-
#
|
402
|
-
#
|
403
|
-
# Some actions take lists of parameters. These lists are specified using
|
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:
|
412
|
+
# * Amazon SQS `AddPermission` does not support adding a non-account
|
413
|
+
# principal.
|
406
414
|
#
|
407
|
-
#
|
408
|
-
#
|
409
|
-
# `&AttributeName.2=second`
|
415
|
+
# </note>
|
410
416
|
#
|
411
417
|
# <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
|
-
#
|
418
|
+
# information, see [Grant cross-account permissions to a role and a
|
419
|
+
# username][4] in the *Amazon SQS Developer Guide*.
|
414
420
|
#
|
415
421
|
# </note>
|
416
422
|
#
|
@@ -487,12 +493,14 @@ module Aws::SQS
|
|
487
493
|
# information, see [Visibility Timeout][1] in the *Amazon SQS Developer
|
488
494
|
# Guide*.
|
489
495
|
#
|
490
|
-
# For example,
|
491
|
-
#
|
492
|
-
#
|
493
|
-
#
|
494
|
-
#
|
495
|
-
#
|
496
|
+
# For example, if the default timeout for a queue is 60 seconds, 15
|
497
|
+
# seconds have elapsed since you received the message, and you send a
|
498
|
+
# ChangeMessageVisibility call with `VisibilityTimeout` set to 10
|
499
|
+
# seconds, the 10 seconds begin to count from the time that you make the
|
500
|
+
# `ChangeMessageVisibility` call. Thus, any attempt to change the
|
501
|
+
# visibility timeout or to delete that message 10 seconds after you
|
502
|
+
# initially change the visibility timeout (a total of 25 seconds) might
|
503
|
+
# result in an error.
|
496
504
|
#
|
497
505
|
# An Amazon SQS message has three basic states:
|
498
506
|
#
|
@@ -508,13 +516,13 @@ module Aws::SQS
|
|
508
516
|
# messages. A message is considered to be *in flight* after it is
|
509
517
|
# received from a queue by a consumer, but not yet deleted from the
|
510
518
|
# queue (that is, between states 2 and 3). There is a limit to the
|
511
|
-
# number of
|
519
|
+
# number of in flight messages.
|
512
520
|
#
|
513
|
-
# Limits that apply to
|
521
|
+
# Limits that apply to in flight messages are unrelated to the
|
514
522
|
# *unlimited* number of stored messages.
|
515
523
|
#
|
516
524
|
# For most standard queues (depending on queue traffic and message
|
517
|
-
# backlog), there can be a maximum of approximately 120,000
|
525
|
+
# backlog), there can be a maximum of approximately 120,000 in flight
|
518
526
|
# messages (received from a queue by a consumer, but not yet deleted
|
519
527
|
# from the queue). If you reach this limit, Amazon SQS returns the
|
520
528
|
# `OverLimit` error message. To avoid reaching the limit, you should
|
@@ -522,7 +530,7 @@ module Aws::SQS
|
|
522
530
|
# increase the number of queues you use to process your messages. To
|
523
531
|
# request a limit increase, [file a support request][2].
|
524
532
|
#
|
525
|
-
# For FIFO queues, there can be a maximum of 20,000
|
533
|
+
# For FIFO queues, there can be a maximum of 20,000 in flight messages
|
526
534
|
# (received from a queue by a consumer, but not yet deleted from the
|
527
535
|
# queue). If you reach this limit, Amazon SQS returns no error messages.
|
528
536
|
#
|
@@ -588,14 +596,6 @@ module Aws::SQS
|
|
588
596
|
# and unsuccessful actions, you should check for batch errors even when
|
589
597
|
# the call returns an HTTP status code of `200`.
|
590
598
|
#
|
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
599
|
# @option params [required, String] :queue_url
|
600
600
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
601
601
|
# changed.
|
@@ -684,17 +684,9 @@ module Aws::SQS
|
|
684
684
|
# * If the queue name, attribute names, or attribute values don't match
|
685
685
|
# an existing queue, `CreateQueue` returns an error.
|
686
686
|
#
|
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
687
|
# <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
|
-
#
|
688
|
+
# information, see [Grant cross-account permissions to a role and a
|
689
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
698
690
|
#
|
699
691
|
# </note>
|
700
692
|
#
|
@@ -734,43 +726,77 @@ module Aws::SQS
|
|
734
726
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
735
727
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
736
728
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
737
|
-
# (4 days).
|
729
|
+
# (4 days). When you change a queue's attributes, the change can take
|
730
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
731
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
732
|
+
# attribute can take up to 15 minutes and will impact existing
|
733
|
+
# messages in the queue potentially causing them to be expired and
|
734
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
735
|
+
# existing messages.
|
738
736
|
#
|
739
737
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
740
738
|
# For more information about policy structure, see [Overview of Amazon
|
741
|
-
# Web Services IAM Policies][1] in the *
|
739
|
+
# Web Services IAM Policies][1] in the *IAM User Guide*.
|
742
740
|
#
|
743
741
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
744
742
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
745
743
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
746
744
|
#
|
745
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
746
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
747
|
+
# Default: 30. For more information about the visibility timeout, see
|
748
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
749
|
+
#
|
750
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
751
|
+
#
|
747
752
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
748
753
|
# 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*.
|
754
|
+
# object. The parameters are as follows:
|
752
755
|
#
|
753
756
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
754
757
|
# dead-letter queue to which Amazon SQS moves messages after the
|
755
758
|
# value of `maxReceiveCount` is exceeded.
|
756
759
|
#
|
757
760
|
# * `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
|
-
#
|
761
|
+
# the source queue before being moved to the dead-letter queue.
|
762
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
763
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
764
|
+
# dead-letter-queue.
|
765
|
+
#
|
766
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
767
|
+
# the permissions for the dead-letter queue redrive permission and
|
768
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
769
|
+
# The parameters are as follows:
|
770
|
+
#
|
771
|
+
# * `redrivePermission` – The permission type that defines which
|
772
|
+
# source queues can specify the current queue as the dead-letter
|
773
|
+
# queue. Valid values are:
|
774
|
+
#
|
775
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
776
|
+
# Services account in the same Region can specify this queue as
|
777
|
+
# the dead-letter queue.
|
778
|
+
#
|
779
|
+
# * `denyAll` – No source queues can specify this queue as the
|
780
|
+
# dead-letter queue.
|
781
|
+
#
|
782
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
783
|
+
# parameter can specify this queue as the dead-letter queue.
|
784
|
+
#
|
785
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
786
|
+
# queues that can specify this queue as the dead-letter queue and
|
787
|
+
# redrive messages. You can specify this parameter only when the
|
788
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
789
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
790
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
791
|
+
# to `allowAll`.
|
792
|
+
#
|
793
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
794
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
795
|
+
# standard queue.
|
767
796
|
#
|
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*.
|
797
|
+
# </note>
|
772
798
|
#
|
773
|
-
# The following attributes apply only to [server-side-encryption][4]
|
799
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
774
800
|
#
|
775
801
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
776
802
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -787,14 +813,14 @@ module Aws::SQS
|
|
787
813
|
# Default: 300 (5 minutes). A shorter time period provides better
|
788
814
|
# security but results in more calls to KMS which might incur charges
|
789
815
|
# after Free Tier. For more information, see [How Does the Data Key
|
790
|
-
# Reuse Period Work?][8]
|
816
|
+
# Reuse Period Work?][8]
|
791
817
|
#
|
792
818
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
793
819
|
# SQS owned encryption keys. Only one server-side encryption option is
|
794
|
-
# supported per queue (
|
820
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
795
821
|
#
|
796
822
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
797
|
-
# queues][11]
|
823
|
+
# queues][11]:
|
798
824
|
#
|
799
825
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
800
826
|
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
@@ -840,7 +866,7 @@ module Aws::SQS
|
|
840
866
|
# duplicates and only one copy of the message is delivered.
|
841
867
|
#
|
842
868
|
# The following attributes apply only to [high throughput for FIFO
|
843
|
-
# queues][14]
|
869
|
+
# queues][14]:
|
844
870
|
#
|
845
871
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
846
872
|
# occurs at the message group or queue level. Valid values are
|
@@ -868,8 +894,8 @@ module Aws::SQS
|
|
868
894
|
#
|
869
895
|
#
|
870
896
|
# [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-
|
897
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
898
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
873
899
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
874
900
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
875
901
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -907,8 +933,8 @@ module Aws::SQS
|
|
907
933
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
908
934
|
#
|
909
935
|
# Cross-account permissions don't apply to this action. For more
|
910
|
-
# information, see [Grant cross-account permissions to a role and a
|
911
|
-
#
|
936
|
+
# information, see [Grant cross-account permissions to a role and a
|
937
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
912
938
|
#
|
913
939
|
# </note>
|
914
940
|
#
|
@@ -960,7 +986,7 @@ module Aws::SQS
|
|
960
986
|
# `ReceiptHandle` is different each time you receive a message. When you
|
961
987
|
# use the `DeleteMessage` action, you must provide the most recently
|
962
988
|
# received `ReceiptHandle` for the message (otherwise, the request
|
963
|
-
# succeeds, but the message
|
989
|
+
# succeeds, but the message will not be deleted).
|
964
990
|
#
|
965
991
|
# For standard queues, it is possible to receive a message even after
|
966
992
|
# you delete it. This might happen on rare occasions if one of the
|
@@ -1006,14 +1032,6 @@ module Aws::SQS
|
|
1006
1032
|
# and unsuccessful actions, you should check for batch errors even when
|
1007
1033
|
# the call returns an HTTP status code of `200`.
|
1008
1034
|
#
|
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
1035
|
# @option params [required, String] :queue_url
|
1018
1036
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
1019
1037
|
#
|
@@ -1073,8 +1091,10 @@ module Aws::SQS
|
|
1073
1091
|
# creating a queue with the same name.
|
1074
1092
|
#
|
1075
1093
|
# <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
|
-
#
|
1094
|
+
# information, see [Grant cross-account permissions to a role and a
|
1095
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1096
|
+
#
|
1097
|
+
# The delete operation uses the HTTP `GET` verb.
|
1078
1098
|
#
|
1079
1099
|
# </note>
|
1080
1100
|
#
|
@@ -1124,7 +1144,7 @@ module Aws::SQS
|
|
1124
1144
|
# @option params [Array<String>] :attribute_names
|
1125
1145
|
# A list of attributes for which to retrieve information.
|
1126
1146
|
#
|
1127
|
-
# The `
|
1147
|
+
# The `AttributeNames` parameter is optional, but if you don't specify
|
1128
1148
|
# values for this parameter, the request returns empty results.
|
1129
1149
|
#
|
1130
1150
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
@@ -1137,10 +1157,10 @@ module Aws::SQS
|
|
1137
1157
|
#
|
1138
1158
|
# The `ApproximateNumberOfMessagesDelayed`,
|
1139
1159
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
1140
|
-
# `
|
1141
|
-
#
|
1142
|
-
#
|
1143
|
-
#
|
1160
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
1161
|
+
# until at least 1 minute after the producers stop sending messages.
|
1162
|
+
# This period is required for the queue metadata to reach eventual
|
1163
|
+
# consistency.
|
1144
1164
|
#
|
1145
1165
|
# * `All` – Returns all values.
|
1146
1166
|
#
|
@@ -1170,7 +1190,14 @@ module Aws::SQS
|
|
1170
1190
|
# can contain before Amazon SQS rejects it.
|
1171
1191
|
#
|
1172
1192
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1173
|
-
# for which Amazon SQS retains a message.
|
1193
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
1194
|
+
# attributes, the change can take up to 60 seconds for most of the
|
1195
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
1196
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
1197
|
+
# minutes and will impact existing messages in the queue potentially
|
1198
|
+
# causing them to be expired and deleted if the
|
1199
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
1200
|
+
# messages.
|
1174
1201
|
#
|
1175
1202
|
# * `Policy` – Returns the policy of the queue.
|
1176
1203
|
#
|
@@ -1180,26 +1207,60 @@ module Aws::SQS
|
|
1180
1207
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1181
1208
|
# to arrive.
|
1182
1209
|
#
|
1210
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1211
|
+
# For more information about the visibility timeout, see [Visibility
|
1212
|
+
# Timeout][2] in the *Amazon SQS Developer Guide*.
|
1213
|
+
#
|
1214
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
1215
|
+
#
|
1183
1216
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
1184
1217
|
# 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*.
|
1218
|
+
# object. The parameters are as follows:
|
1188
1219
|
#
|
1189
1220
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1190
1221
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1191
1222
|
# value of `maxReceiveCount` is exceeded.
|
1192
1223
|
#
|
1193
1224
|
# * `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
|
1225
|
+
# the source queue before being moved to the dead-letter queue.
|
1226
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
1227
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
1228
|
+
# dead-letter-queue.
|
1229
|
+
#
|
1230
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
1231
|
+
# the permissions for the dead-letter queue redrive permission and
|
1232
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
1233
|
+
# The parameters are as follows:
|
1234
|
+
#
|
1235
|
+
# * `redrivePermission` – The permission type that defines which
|
1236
|
+
# source queues can specify the current queue as the dead-letter
|
1237
|
+
# queue. Valid values are:
|
1238
|
+
#
|
1239
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
1240
|
+
# Services account in the same Region can specify this queue as
|
1241
|
+
# the dead-letter queue.
|
1242
|
+
#
|
1243
|
+
# * `denyAll` – No source queues can specify this queue as the
|
1244
|
+
# dead-letter queue.
|
1245
|
+
#
|
1246
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
1247
|
+
# parameter can specify this queue as the dead-letter queue.
|
1248
|
+
#
|
1249
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
1250
|
+
# queues that can specify this queue as the dead-letter queue and
|
1251
|
+
# redrive messages. You can specify this parameter only when the
|
1252
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
1253
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
1254
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
1255
|
+
# to `allowAll`.
|
1256
|
+
#
|
1257
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
1258
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
1259
|
+
# standard queue.
|
1197
1260
|
#
|
1198
|
-
#
|
1199
|
-
# For more information about the visibility timeout, see [Visibility
|
1200
|
-
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1261
|
+
# </note>
|
1201
1262
|
#
|
1202
|
-
# The following attributes apply only to [server-side-encryption][4]
|
1263
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
1203
1264
|
#
|
1204
1265
|
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services managed
|
1205
1266
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -1212,11 +1273,11 @@ module Aws::SQS
|
|
1212
1273
|
#
|
1213
1274
|
# * `SqsManagedSseEnabled` – Returns information about whether the queue
|
1214
1275
|
# 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]).
|
1276
|
+
# one server-side encryption option is supported per queue (for
|
1277
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
1217
1278
|
#
|
1218
1279
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1219
|
-
# queues][9]
|
1280
|
+
# queues][9]:
|
1220
1281
|
#
|
1221
1282
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1222
1283
|
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
@@ -1232,7 +1293,7 @@ module Aws::SQS
|
|
1232
1293
|
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
1233
1294
|
#
|
1234
1295
|
# The following attributes apply only to [high throughput for FIFO
|
1235
|
-
# queues][12]
|
1296
|
+
# queues][12]:
|
1236
1297
|
#
|
1237
1298
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
1238
1299
|
# occurs at the message group or queue level. Valid values are
|
@@ -1260,8 +1321,8 @@ module Aws::SQS
|
|
1260
1321
|
#
|
1261
1322
|
#
|
1262
1323
|
# [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-
|
1324
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1325
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
1265
1326
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
1266
1327
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
1267
1328
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -1413,8 +1474,8 @@ module Aws::SQS
|
|
1413
1474
|
# *Amazon SQS Developer Guide*.
|
1414
1475
|
#
|
1415
1476
|
# <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
|
-
#
|
1477
|
+
# information, see [Grant cross-account permissions to a role and a
|
1478
|
+
# username][2] in the *Amazon SQS Developer Guide*.
|
1418
1479
|
#
|
1419
1480
|
# </note>
|
1420
1481
|
#
|
@@ -1464,8 +1525,8 @@ module Aws::SQS
|
|
1464
1525
|
# request to `listQueues` to receive the next page of results.
|
1465
1526
|
#
|
1466
1527
|
# <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
|
-
#
|
1528
|
+
# information, see [Grant cross-account permissions to a role and a
|
1529
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1469
1530
|
#
|
1470
1531
|
# </note>
|
1471
1532
|
#
|
@@ -1633,7 +1694,7 @@ module Aws::SQS
|
|
1633
1694
|
#
|
1634
1695
|
# * `SenderId`
|
1635
1696
|
#
|
1636
|
-
# * For
|
1697
|
+
# * For a user, returns the user ID, for example
|
1637
1698
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1638
1699
|
#
|
1639
1700
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1644,7 +1705,7 @@ module Aws::SQS
|
|
1644
1705
|
#
|
1645
1706
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
1646
1707
|
# SQS owned encryption keys. Only one server-side encryption option is
|
1647
|
-
# supported per queue (
|
1708
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
1648
1709
|
#
|
1649
1710
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1650
1711
|
# producer that calls the ` SendMessage ` action.
|
@@ -1827,7 +1888,7 @@ module Aws::SQS
|
|
1827
1888
|
#
|
1828
1889
|
# * Cross-account permissions don't apply to this action. For more
|
1829
1890
|
# information, see [Grant cross-account permissions to a role and a
|
1830
|
-
#
|
1891
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
1831
1892
|
#
|
1832
1893
|
# * To remove the ability to change queue permissions, you must deny
|
1833
1894
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1888,7 +1949,7 @@ module Aws::SQS
|
|
1888
1949
|
#
|
1889
1950
|
# @option params [required, String] :message_body
|
1890
1951
|
# The message to send. The minimum size is one character. The maximum
|
1891
|
-
# size is 256
|
1952
|
+
# size is 256 KiB.
|
1892
1953
|
#
|
1893
1954
|
# A message can include only XML, JSON, and unformatted text. The
|
1894
1955
|
# following Unicode characters are allowed:
|
@@ -2083,7 +2144,9 @@ module Aws::SQS
|
|
2083
2144
|
req.send_request(options)
|
2084
2145
|
end
|
2085
2146
|
|
2086
|
-
#
|
2147
|
+
# You can use `SendMessageBatch` to send up to 10 messages to the
|
2148
|
+
# specified queue by assigning either identical or different values to
|
2149
|
+
# each message (or by not assigning values at all). This is a batch
|
2087
2150
|
# version of ` SendMessage.` For a FIFO queue, multiple messages within
|
2088
2151
|
# a single batch are enqueued in the order they are sent.
|
2089
2152
|
#
|
@@ -2094,7 +2157,7 @@ module Aws::SQS
|
|
2094
2157
|
#
|
2095
2158
|
# The maximum allowed individual message size and the maximum total
|
2096
2159
|
# payload size (the sum of the individual lengths of all of the batched
|
2097
|
-
# messages) are both 256
|
2160
|
+
# messages) are both 256 KiB (262,144 bytes).
|
2098
2161
|
#
|
2099
2162
|
# A message can include only XML, JSON, and unformatted text. The
|
2100
2163
|
# following Unicode characters are allowed:
|
@@ -2108,14 +2171,6 @@ module Aws::SQS
|
|
2108
2171
|
# If you don't specify the `DelaySeconds` parameter for an entry,
|
2109
2172
|
# Amazon SQS uses the default value for the queue.
|
2110
2173
|
#
|
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
2174
|
#
|
2120
2175
|
#
|
2121
2176
|
# [1]: http://www.w3.org/TR/REC-xml/#charsets
|
@@ -2194,7 +2249,9 @@ module Aws::SQS
|
|
2194
2249
|
# queue's attributes, the change can take up to 60 seconds for most of
|
2195
2250
|
# the attributes to propagate throughout the Amazon SQS system. Changes
|
2196
2251
|
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
2197
|
-
# minutes
|
2252
|
+
# minutes and will impact existing messages in the queue potentially
|
2253
|
+
# causing them to be expired and deleted if the `MessageRetentionPeriod`
|
2254
|
+
# is reduced below the age of existing messages.
|
2198
2255
|
#
|
2199
2256
|
# <note markdown="1"> * In the future, new attributes might be added. If you write code that
|
2200
2257
|
# calls this action, we recommend that you structure your code so that
|
@@ -2202,7 +2259,7 @@ module Aws::SQS
|
|
2202
2259
|
#
|
2203
2260
|
# * Cross-account permissions don't apply to this action. For more
|
2204
2261
|
# information, see [Grant cross-account permissions to a role and a
|
2205
|
-
#
|
2262
|
+
# username][1] in the *Amazon SQS Developer Guide*.
|
2206
2263
|
#
|
2207
2264
|
# * To remove the ability to change queue permissions, you must deny
|
2208
2265
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2237,7 +2294,13 @@ module Aws::SQS
|
|
2237
2294
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2238
2295
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2239
2296
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2240
|
-
# (4 days).
|
2297
|
+
# (4 days). When you change a queue's attributes, the change can take
|
2298
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
2299
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
2300
|
+
# attribute can take up to 15 minutes and will impact existing
|
2301
|
+
# messages in the queue potentially causing them to be expired and
|
2302
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
2303
|
+
# existing messages.
|
2241
2304
|
#
|
2242
2305
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
2243
2306
|
# For more information about policy structure, see [Overview of Amazon
|
@@ -2248,33 +2311,61 @@ module Aws::SQS
|
|
2248
2311
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2249
2312
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2250
2313
|
#
|
2314
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2315
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2316
|
+
# Default: 30. For more information about the visibility timeout, see
|
2317
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2318
|
+
#
|
2319
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2320
|
+
#
|
2251
2321
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2252
2322
|
# 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*.
|
2323
|
+
# object. The parameters are as follows:
|
2256
2324
|
#
|
2257
2325
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2258
2326
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2259
2327
|
# value of `maxReceiveCount` is exceeded.
|
2260
2328
|
#
|
2261
2329
|
# * `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
|
2265
|
-
#
|
2266
|
-
#
|
2267
|
-
#
|
2268
|
-
#
|
2330
|
+
# the source queue before being moved to the dead-letter queue.
|
2331
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2332
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
2333
|
+
# dead-letter-queue.
|
2334
|
+
#
|
2335
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2336
|
+
# the permissions for the dead-letter queue redrive permission and
|
2337
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
2338
|
+
# The parameters are as follows:
|
2339
|
+
#
|
2340
|
+
# * `redrivePermission` – The permission type that defines which
|
2341
|
+
# source queues can specify the current queue as the dead-letter
|
2342
|
+
# queue. Valid values are:
|
2343
|
+
#
|
2344
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2345
|
+
# Services account in the same Region can specify this queue as
|
2346
|
+
# the dead-letter queue.
|
2347
|
+
#
|
2348
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2349
|
+
# dead-letter queue.
|
2350
|
+
#
|
2351
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2352
|
+
# parameter can specify this queue as the dead-letter queue.
|
2353
|
+
#
|
2354
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
2355
|
+
# queues that can specify this queue as the dead-letter queue and
|
2356
|
+
# redrive messages. You can specify this parameter only when the
|
2357
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
2358
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
2359
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
2360
|
+
# to `allowAll`.
|
2361
|
+
#
|
2362
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2363
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2364
|
+
# standard queue.
|
2269
2365
|
#
|
2270
|
-
#
|
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*.
|
2366
|
+
# </note>
|
2276
2367
|
#
|
2277
|
-
# The following attributes apply only to [server-side-encryption][4]
|
2368
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
2278
2369
|
#
|
2279
2370
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
2280
2371
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -2294,10 +2385,10 @@ module Aws::SQS
|
|
2294
2385
|
#
|
2295
2386
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
2296
2387
|
# SQS owned encryption keys. Only one server-side encryption option is
|
2297
|
-
# supported per queue (
|
2388
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
2298
2389
|
#
|
2299
2390
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2300
|
-
# queues][11]
|
2391
|
+
# queues][11]:
|
2301
2392
|
#
|
2302
2393
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2303
2394
|
# For more information, see [Exactly-once processing][12] in the
|
@@ -2332,7 +2423,7 @@ module Aws::SQS
|
|
2332
2423
|
# duplicates and only one copy of the message is delivered.
|
2333
2424
|
#
|
2334
2425
|
# The following attributes apply only to [high throughput for FIFO
|
2335
|
-
# queues][13]
|
2426
|
+
# queues][13]:
|
2336
2427
|
#
|
2337
2428
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2338
2429
|
# occurs at the message group or queue level. Valid values are
|
@@ -2360,8 +2451,8 @@ module Aws::SQS
|
|
2360
2451
|
#
|
2361
2452
|
#
|
2362
2453
|
# [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-
|
2454
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2455
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2365
2456
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2366
2457
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2367
2458
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2414,8 +2505,8 @@ module Aws::SQS
|
|
2414
2505
|
# in the *Amazon SQS Developer Guide*.
|
2415
2506
|
#
|
2416
2507
|
# <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
|
-
#
|
2508
|
+
# information, see [Grant cross-account permissions to a role and a
|
2509
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
2419
2510
|
#
|
2420
2511
|
# </note>
|
2421
2512
|
#
|
@@ -2456,8 +2547,8 @@ module Aws::SQS
|
|
2456
2547
|
# SQS Developer Guide*.
|
2457
2548
|
#
|
2458
2549
|
# <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
|
-
#
|
2550
|
+
# information, see [Grant cross-account permissions to a role and a
|
2551
|
+
# username][2] in the *Amazon SQS Developer Guide*.
|
2461
2552
|
#
|
2462
2553
|
# </note>
|
2463
2554
|
#
|
@@ -2503,7 +2594,7 @@ module Aws::SQS
|
|
2503
2594
|
params: params,
|
2504
2595
|
config: config)
|
2505
2596
|
context[:gem_name] = 'aws-sdk-sqs'
|
2506
|
-
context[:gem_version] = '1.
|
2597
|
+
context[:gem_version] = '1.54.0'
|
2507
2598
|
Seahorse::Client::Request.new(handlers, context)
|
2508
2599
|
end
|
2509
2600
|
|