aws-sdk-sqs 1.35.0 → 1.40.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 +293 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-sqs.rb +2 -2
- data/lib/aws-sdk-sqs/client.rb +135 -190
- data/lib/aws-sdk-sqs/client_api.rb +1 -1
- data/lib/aws-sdk-sqs/errors.rb +1 -1
- data/lib/aws-sdk-sqs/message.rb +4 -4
- data/lib/aws-sdk-sqs/queue.rb +47 -67
- data/lib/aws-sdk-sqs/resource.rb +38 -56
- data/lib/aws-sdk-sqs/types.rb +133 -191
- metadata +11 -9
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.40.0
|
data/lib/aws-sdk-sqs.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -50,6 +50,6 @@ require_relative 'aws-sdk-sqs/customizations'
|
|
50
50
|
# @!group service
|
51
51
|
module Aws::SQS
|
52
52
|
|
53
|
-
GEM_VERSION = '1.
|
53
|
+
GEM_VERSION = '1.40.0'
|
54
54
|
|
55
55
|
end
|
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
# WARNING ABOUT GENERATED CODE
|
4
4
|
#
|
5
5
|
# This file is generated. See the contributing guide for more information:
|
6
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
@@ -343,13 +343,13 @@ module Aws::SQS
|
|
343
343
|
# When you create a queue, you have full control access rights for the
|
344
344
|
# queue. Only you, the owner of the queue, can grant or deny permissions
|
345
345
|
# to the queue. For more information about these permissions, see [Allow
|
346
|
-
# Developers to Write Messages to a Shared Queue][2] in the *Amazon
|
347
|
-
#
|
346
|
+
# Developers to Write Messages to a Shared Queue][2] in the *Amazon SQS
|
347
|
+
# Developer Guide*.
|
348
348
|
#
|
349
349
|
# <note markdown="1"> * `AddPermission` generates a policy for you. You can use `
|
350
350
|
# SetQueueAttributes ` to upload your policy. For more information,
|
351
351
|
# see [Using Custom Policies with the Amazon SQS Access Policy
|
352
|
-
# Language][3] in the *Amazon
|
352
|
+
# Language][3] in the *Amazon SQS Developer Guide*.
|
353
353
|
#
|
354
354
|
# * An Amazon SQS policy can have a maximum of 7 actions.
|
355
355
|
#
|
@@ -369,7 +369,7 @@ module Aws::SQS
|
|
369
369
|
#
|
370
370
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
371
371
|
# information, see [Grant cross-account permissions to a role and a user
|
372
|
-
# name][4] in the *Amazon
|
372
|
+
# name][4] in the *Amazon SQS Developer Guide*.
|
373
373
|
#
|
374
374
|
# </note>
|
375
375
|
#
|
@@ -392,11 +392,10 @@ module Aws::SQS
|
|
392
392
|
# underscores (`_`).
|
393
393
|
#
|
394
394
|
# @option params [required, Array<String>] :aws_account_ids
|
395
|
-
# The
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
# Queue Service Developer Guide*.
|
395
|
+
# The account numbers of the [principals][1] who are to receive
|
396
|
+
# permission. For information about locating the account identification,
|
397
|
+
# see [Your Amazon Web Services Identifiers][2] in the *Amazon SQS
|
398
|
+
# Developer Guide*.
|
400
399
|
#
|
401
400
|
#
|
402
401
|
#
|
@@ -409,7 +408,7 @@ module Aws::SQS
|
|
409
408
|
#
|
410
409
|
# For more information about these actions, see [Overview of Managing
|
411
410
|
# Access Permissions to Your Amazon Simple Queue Service Resource][1] in
|
412
|
-
# the *Amazon
|
411
|
+
# the *Amazon SQS Developer Guide*.
|
413
412
|
#
|
414
413
|
# Specifying `SendMessage`, `DeleteMessage`, or
|
415
414
|
# `ChangeMessageVisibility` for `ActionName.n` also grants permissions
|
@@ -444,8 +443,8 @@ module Aws::SQS
|
|
444
443
|
# Changes the visibility timeout of a specified message in a queue to a
|
445
444
|
# new value. The default visibility timeout for a message is 30 seconds.
|
446
445
|
# The minimum is 0 seconds. The maximum is 12 hours. For more
|
447
|
-
# information, see [Visibility Timeout][1] in the *Amazon
|
448
|
-
#
|
446
|
+
# information, see [Visibility Timeout][1] in the *Amazon SQS Developer
|
447
|
+
# Guide*.
|
449
448
|
#
|
450
449
|
# For example, you have a message with a visibility timeout of 5
|
451
450
|
# minutes. After 3 minutes, you call `ChangeMessageVisibility` with a
|
@@ -614,7 +613,7 @@ module Aws::SQS
|
|
614
613
|
# either create a new FIFO queue for your application or delete your
|
615
614
|
# existing standard queue and recreate it as a FIFO queue. For more
|
616
615
|
# information, see [Moving From a Standard Queue to a FIFO Queue][1]
|
617
|
-
# in the *Amazon
|
616
|
+
# in the *Amazon SQS Developer Guide*.
|
618
617
|
#
|
619
618
|
# </note>
|
620
619
|
#
|
@@ -654,7 +653,7 @@ module Aws::SQS
|
|
654
653
|
#
|
655
654
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
656
655
|
# information, see [Grant cross-account permissions to a role and a user
|
657
|
-
# name][3] in the *Amazon
|
656
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
658
657
|
#
|
659
658
|
# </note>
|
660
659
|
#
|
@@ -696,9 +695,9 @@ module Aws::SQS
|
|
696
695
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
697
696
|
# (4 days).
|
698
697
|
#
|
699
|
-
# * `Policy` – The queue's policy. A valid
|
700
|
-
# information about policy structure, see [Overview of
|
701
|
-
# Policies][1] in the *Amazon IAM User Guide*.
|
698
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
699
|
+
# For more information about policy structure, see [Overview of Amazon
|
700
|
+
# Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
|
702
701
|
#
|
703
702
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
704
703
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -708,7 +707,7 @@ module Aws::SQS
|
|
708
707
|
# dead-letter queue functionality of the source queue as a JSON
|
709
708
|
# object. For more information about the redrive policy and
|
710
709
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
711
|
-
# the *Amazon
|
710
|
+
# the *Amazon SQS Developer Guide*.
|
712
711
|
#
|
713
712
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
714
713
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -728,26 +727,26 @@ module Aws::SQS
|
|
728
727
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
729
728
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
730
729
|
# Default: 30. For more information about the visibility timeout, see
|
731
|
-
# [Visibility Timeout][3] in the *Amazon
|
732
|
-
# Developer Guide*.
|
730
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
733
731
|
#
|
734
732
|
# The following attributes apply only to [server-side-encryption][4]\:
|
735
733
|
#
|
736
|
-
# * `KmsMasterKeyId` – The ID of an
|
737
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
738
|
-
# Terms][5]. While the alias of the
|
739
|
-
# always `alias/aws/sqs`, the
|
740
|
-
#
|
741
|
-
# Key Management Service API
|
734
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
735
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
736
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
737
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
738
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
739
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
740
|
+
# Reference*.
|
742
741
|
#
|
743
742
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
744
743
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
745
|
-
# messages before calling
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
750
|
-
#
|
744
|
+
# messages before calling KMS again. An integer representing seconds,
|
745
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
746
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
747
|
+
# security but results in more calls to KMS which might incur charges
|
748
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
749
|
+
# Reuse Period Work?][8].
|
751
750
|
#
|
752
751
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
753
752
|
# queues][9]\:
|
@@ -759,13 +758,13 @@ module Aws::SQS
|
|
759
758
|
# When you set this attribute, you must also provide the
|
760
759
|
# `MessageGroupId` for your messages explicitly.
|
761
760
|
#
|
762
|
-
# For more information, see [FIFO
|
763
|
-
#
|
761
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
762
|
+
# Developer Guide*.
|
764
763
|
#
|
765
764
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
766
765
|
# Valid values are `true` and `false`. For more information, see
|
767
|
-
# [Exactly-
|
768
|
-
#
|
766
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
767
|
+
# Note the following:
|
769
768
|
#
|
770
769
|
# * Every message must have a unique `MessageDeduplicationId`.
|
771
770
|
#
|
@@ -795,15 +794,8 @@ module Aws::SQS
|
|
795
794
|
# `MessageDeduplicationId`, the two messages are treated as
|
796
795
|
# duplicates and only one copy of the message is delivered.
|
797
796
|
#
|
798
|
-
#
|
799
|
-
#
|
800
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
801
|
-
# is subject to change.** This feature provides a high number of
|
802
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
803
|
-
# information on throughput quotas, see [Quotas related to messages][12]
|
804
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
805
|
-
#
|
806
|
-
# This preview includes two new attributes:
|
797
|
+
# The following attributes apply only to [high throughput for FIFO
|
798
|
+
# queues][12]\:
|
807
799
|
#
|
808
800
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
809
801
|
# occurs at the message group or queue level. Valid values are
|
@@ -822,22 +814,11 @@ module Aws::SQS
|
|
822
814
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
823
815
|
#
|
824
816
|
# If you set these attributes to anything other than the values shown
|
825
|
-
# for enabling high throughput,
|
817
|
+
# for enabling high throughput, normal throughput is in effect and
|
826
818
|
# deduplication occurs as specified.
|
827
819
|
#
|
828
|
-
#
|
829
|
-
#
|
830
|
-
# * US East (Ohio); us-east-2
|
831
|
-
#
|
832
|
-
# * US East (N. Virginia); us-east-1
|
833
|
-
#
|
834
|
-
# * US West (Oregon); us-west-2
|
835
|
-
#
|
836
|
-
# * Europe (Ireland); eu-west-1
|
837
|
-
#
|
838
|
-
# For more information about high throughput for FIFO queues, see
|
839
|
-
# [Preview: High throughput for FIFO queues][13] in the *Amazon Simple
|
840
|
-
# Queue Service Developer Guide*.
|
820
|
+
# For information on throughput quotas, see [Quotas related to
|
821
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
841
822
|
#
|
842
823
|
#
|
843
824
|
#
|
@@ -850,15 +831,15 @@ module Aws::SQS
|
|
850
831
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
851
832
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
852
833
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
853
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
854
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
855
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
856
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
834
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
835
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
836
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
837
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
857
838
|
#
|
858
839
|
# @option params [Hash<String,String>] :tags
|
859
840
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
860
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
861
|
-
#
|
841
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
842
|
+
# Developer Guide*.
|
862
843
|
#
|
863
844
|
# When you use queue tags, keep the following guidelines in mind:
|
864
845
|
#
|
@@ -872,15 +853,15 @@ module Aws::SQS
|
|
872
853
|
# * A new tag with a key identical to that of an existing tag overwrites
|
873
854
|
# the existing tag.
|
874
855
|
#
|
875
|
-
# For a full list of tag restrictions, see [
|
876
|
-
# in the *Amazon
|
856
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
857
|
+
# in the *Amazon SQS Developer Guide*.
|
877
858
|
#
|
878
859
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
879
860
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
880
861
|
#
|
881
862
|
# Cross-account permissions don't apply to this action. For more
|
882
863
|
# information, see [Grant cross-account permissions to a role and a user
|
883
|
-
# name][3] in the *Amazon
|
864
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
884
865
|
#
|
885
866
|
# </note>
|
886
867
|
#
|
@@ -1046,7 +1027,7 @@ module Aws::SQS
|
|
1046
1027
|
#
|
1047
1028
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1048
1029
|
# information, see [Grant cross-account permissions to a role and a user
|
1049
|
-
# name][1] in the *Amazon
|
1030
|
+
# name][1] in the *Amazon SQS Developer Guide*.
|
1050
1031
|
#
|
1051
1032
|
# </note>
|
1052
1033
|
#
|
@@ -1096,6 +1077,9 @@ module Aws::SQS
|
|
1096
1077
|
# @option params [Array<String>] :attribute_names
|
1097
1078
|
# A list of attributes for which to retrieve information.
|
1098
1079
|
#
|
1080
|
+
# The `AttributeName.N` parameter is optional, but if you don't specify
|
1081
|
+
# values for this parameter, the request returns empty results.
|
1082
|
+
#
|
1099
1083
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1100
1084
|
# calls this action, we recommend that you structure your code so that
|
1101
1085
|
# it can handle new attributes gracefully.
|
@@ -1153,7 +1137,7 @@ module Aws::SQS
|
|
1153
1137
|
# dead-letter queue functionality of the source queue as a JSON
|
1154
1138
|
# object. For more information about the redrive policy and
|
1155
1139
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1156
|
-
# the *Amazon
|
1140
|
+
# the *Amazon SQS Developer Guide*.
|
1157
1141
|
#
|
1158
1142
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1159
1143
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -1166,25 +1150,25 @@ module Aws::SQS
|
|
1166
1150
|
#
|
1167
1151
|
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1168
1152
|
# For more information about the visibility timeout, see [Visibility
|
1169
|
-
# Timeout][3] in the *Amazon
|
1153
|
+
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1170
1154
|
#
|
1171
1155
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1172
1156
|
#
|
1173
|
-
# * `KmsMasterKeyId` – Returns the ID of an
|
1174
|
-
# key (CMK) for Amazon SQS or a custom CMK. For more
|
1175
|
-
# [Key Terms][5].
|
1157
|
+
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services managed
|
1158
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
1159
|
+
# information, see [Key Terms][5].
|
1176
1160
|
#
|
1177
1161
|
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1178
1162
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1179
|
-
# decrypt messages before calling
|
1180
|
-
#
|
1163
|
+
# decrypt messages before calling KMS again. For more information, see
|
1164
|
+
# [How Does the Data Key Reuse Period Work?][6].
|
1181
1165
|
#
|
1182
1166
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1183
1167
|
# queues][7]\:
|
1184
1168
|
#
|
1185
1169
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1186
|
-
# For more information, see [FIFO
|
1187
|
-
#
|
1170
|
+
# For more information, see [FIFO queue logic][8] in the *Amazon SQS
|
1171
|
+
# Developer Guide*.
|
1188
1172
|
#
|
1189
1173
|
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
1190
1174
|
# `QueueName` ends with the `.fifo` suffix.
|
@@ -1193,18 +1177,10 @@ module Aws::SQS
|
|
1193
1177
|
#
|
1194
1178
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
1195
1179
|
# deduplication is enabled for the queue. For more information, see
|
1196
|
-
# [Exactly-
|
1197
|
-
# Developer Guide*.
|
1180
|
+
# [Exactly-once processing][9] in the *Amazon SQS Developer Guide*.
|
1198
1181
|
#
|
1199
|
-
#
|
1200
|
-
#
|
1201
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
1202
|
-
# is subject to change.** This feature provides a high number of
|
1203
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
1204
|
-
# information on throughput quotas, see [Quotas related to messages][10]
|
1205
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
1206
|
-
#
|
1207
|
-
# This preview includes two new attributes:
|
1182
|
+
# The following attributes apply only to [high throughput for FIFO
|
1183
|
+
# queues][10]\:
|
1208
1184
|
#
|
1209
1185
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
1210
1186
|
# occurs at the message group or queue level. Valid values are
|
@@ -1223,22 +1199,11 @@ module Aws::SQS
|
|
1223
1199
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
1224
1200
|
#
|
1225
1201
|
# If you set these attributes to anything other than the values shown
|
1226
|
-
# for enabling high throughput,
|
1202
|
+
# for enabling high throughput, normal throughput is in effect and
|
1227
1203
|
# deduplication occurs as specified.
|
1228
1204
|
#
|
1229
|
-
#
|
1230
|
-
#
|
1231
|
-
# * US East (Ohio); us-east-2
|
1232
|
-
#
|
1233
|
-
# * US East (N. Virginia); us-east-1
|
1234
|
-
#
|
1235
|
-
# * US West (Oregon); us-west-2
|
1236
|
-
#
|
1237
|
-
# * Europe (Ireland); eu-west-1
|
1238
|
-
#
|
1239
|
-
# For more information about high throughput for FIFO queues, see
|
1240
|
-
# [Preview: High throughput for FIFO queues][11] in the *Amazon Simple
|
1241
|
-
# Queue Service Developer Guide*.
|
1205
|
+
# For information on throughput quotas, see [Quotas related to
|
1206
|
+
# messages][11] in the *Amazon SQS Developer Guide*.
|
1242
1207
|
#
|
1243
1208
|
#
|
1244
1209
|
#
|
@@ -1249,10 +1214,10 @@ module Aws::SQS
|
|
1249
1214
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
1250
1215
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
1251
1216
|
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
1252
|
-
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
1253
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
1254
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1255
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1217
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
1218
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
1219
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
1220
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
1256
1221
|
#
|
1257
1222
|
# @return [Types::GetQueueAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1258
1223
|
#
|
@@ -1286,7 +1251,7 @@ module Aws::SQS
|
|
1286
1251
|
# queue's owner. The queue's owner must grant you permission to access
|
1287
1252
|
# the queue. For more information about shared queue access, see `
|
1288
1253
|
# AddPermission ` or see [Allow Developers to Write Messages to a Shared
|
1289
|
-
# Queue][1] in the *Amazon
|
1254
|
+
# Queue][1] in the *Amazon SQS Developer Guide*.
|
1290
1255
|
#
|
1291
1256
|
#
|
1292
1257
|
#
|
@@ -1300,7 +1265,7 @@ module Aws::SQS
|
|
1300
1265
|
# Queue URLs and names are case-sensitive.
|
1301
1266
|
#
|
1302
1267
|
# @option params [String] :queue_owner_aws_account_id
|
1303
|
-
# The
|
1268
|
+
# The account ID of the account that created the queue.
|
1304
1269
|
#
|
1305
1270
|
# @return [Types::GetQueueUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1306
1271
|
#
|
@@ -1339,8 +1304,7 @@ module Aws::SQS
|
|
1339
1304
|
# receive the next page of results.
|
1340
1305
|
#
|
1341
1306
|
# For more information about using dead-letter queues, see [Using Amazon
|
1342
|
-
# SQS Dead-Letter Queues][1] in the *Amazon
|
1343
|
-
# Developer Guide*.
|
1307
|
+
# SQS Dead-Letter Queues][1] in the *Amazon SQS Developer Guide*.
|
1344
1308
|
#
|
1345
1309
|
#
|
1346
1310
|
#
|
@@ -1391,11 +1355,11 @@ module Aws::SQS
|
|
1391
1355
|
|
1392
1356
|
# List all cost allocation tags added to the specified Amazon SQS queue.
|
1393
1357
|
# For an overview, see [Tagging Your Amazon SQS Queues][1] in the
|
1394
|
-
# *Amazon
|
1358
|
+
# *Amazon SQS Developer Guide*.
|
1395
1359
|
#
|
1396
1360
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1397
1361
|
# information, see [Grant cross-account permissions to a role and a user
|
1398
|
-
# name][2] in the *Amazon
|
1362
|
+
# name][2] in the *Amazon SQS Developer Guide*.
|
1399
1363
|
#
|
1400
1364
|
# </note>
|
1401
1365
|
#
|
@@ -1446,7 +1410,7 @@ module Aws::SQS
|
|
1446
1410
|
#
|
1447
1411
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1448
1412
|
# information, see [Grant cross-account permissions to a role and a user
|
1449
|
-
# name][1] in the *Amazon
|
1413
|
+
# name][1] in the *Amazon SQS Developer Guide*.
|
1450
1414
|
#
|
1451
1415
|
# </note>
|
1452
1416
|
#
|
@@ -1537,8 +1501,8 @@ module Aws::SQS
|
|
1537
1501
|
|
1538
1502
|
# Retrieves one or more messages (up to 10), from the specified queue.
|
1539
1503
|
# Using the `WaitTimeSeconds` parameter enables long-poll support. For
|
1540
|
-
# more information, see [Amazon SQS Long Polling][1] in the *Amazon
|
1541
|
-
#
|
1504
|
+
# more information, see [Amazon SQS Long Polling][1] in the *Amazon SQS
|
1505
|
+
# Developer Guide*.
|
1542
1506
|
#
|
1543
1507
|
# Short poll is the default behavior where a weighted random set of
|
1544
1508
|
# machines is sampled on a `ReceiveMessage` call. Thus, only the
|
@@ -1566,14 +1530,14 @@ module Aws::SQS
|
|
1566
1530
|
#
|
1567
1531
|
# The receipt handle is the identifier you must provide when deleting
|
1568
1532
|
# the message. For more information, see [Queue and Message
|
1569
|
-
# Identifiers][3] in the *Amazon
|
1533
|
+
# Identifiers][3] in the *Amazon SQS Developer Guide*.
|
1570
1534
|
#
|
1571
1535
|
# You can provide the `VisibilityTimeout` parameter in your request. The
|
1572
1536
|
# parameter is applied to the messages that Amazon SQS returns in the
|
1573
1537
|
# response. If you don't include the parameter, the overall visibility
|
1574
1538
|
# timeout for the queue is used for the returned messages. For more
|
1575
|
-
# information, see [Visibility Timeout][4] in the *Amazon
|
1576
|
-
#
|
1539
|
+
# information, see [Visibility Timeout][4] in the *Amazon SQS Developer
|
1540
|
+
# Guide*.
|
1577
1541
|
#
|
1578
1542
|
# A message that isn't deleted or a message whose visibility isn't
|
1579
1543
|
# extended before the visibility timeout expires counts as a failed
|
@@ -1610,7 +1574,7 @@ module Aws::SQS
|
|
1610
1574
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1611
1575
|
# has been received across all queues but not deleted.
|
1612
1576
|
#
|
1613
|
-
# * `AWSTraceHeader` – Returns the
|
1577
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1614
1578
|
#
|
1615
1579
|
# * `SenderId`
|
1616
1580
|
#
|
@@ -1714,7 +1678,7 @@ module Aws::SQS
|
|
1714
1678
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
1715
1679
|
# handles. If a retry occurs within the deduplication interval, it
|
1716
1680
|
# resets the visibility timeout. For more information, see [Visibility
|
1717
|
-
# Timeout][1] in the *Amazon
|
1681
|
+
# Timeout][1] in the *Amazon SQS Developer Guide*.
|
1718
1682
|
#
|
1719
1683
|
# If a caller of the `ReceiveMessage` action still processes messages
|
1720
1684
|
# when the visibility timeout expires and messages become visible,
|
@@ -1743,8 +1707,8 @@ module Aws::SQS
|
|
1743
1707
|
# ``).
|
1744
1708
|
#
|
1745
1709
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
1746
|
-
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
1747
|
-
#
|
1710
|
+
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
1711
|
+
# Developer Guide*.
|
1748
1712
|
#
|
1749
1713
|
#
|
1750
1714
|
#
|
@@ -1802,7 +1766,7 @@ module Aws::SQS
|
|
1802
1766
|
#
|
1803
1767
|
# * Cross-account permissions don't apply to this action. For more
|
1804
1768
|
# information, see [Grant cross-account permissions to a role and a
|
1805
|
-
# user name][1] in the *Amazon
|
1769
|
+
# user name][1] in the *Amazon SQS Developer Guide*.
|
1806
1770
|
#
|
1807
1771
|
# * To remove the ability to change queue permissions, you must deny
|
1808
1772
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1892,8 +1856,8 @@ module Aws::SQS
|
|
1892
1856
|
#
|
1893
1857
|
# @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
1894
1858
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
1895
|
-
# more information, see [Amazon SQS
|
1896
|
-
# *Amazon
|
1859
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
1860
|
+
# *Amazon SQS Developer Guide*.
|
1897
1861
|
#
|
1898
1862
|
#
|
1899
1863
|
#
|
@@ -1905,7 +1869,7 @@ module Aws::SQS
|
|
1905
1869
|
#
|
1906
1870
|
# * Currently, the only supported message system attribute is
|
1907
1871
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1908
|
-
# correctly formatted
|
1872
|
+
# correctly formatted X-Ray trace header string.
|
1909
1873
|
#
|
1910
1874
|
# * The size of a message system attribute doesn't count towards the
|
1911
1875
|
# total size of a message.
|
@@ -1917,8 +1881,8 @@ module Aws::SQS
|
|
1917
1881
|
# particular `MessageDeduplicationId` is sent successfully, any messages
|
1918
1882
|
# sent with the same `MessageDeduplicationId` are accepted successfully
|
1919
1883
|
# but aren't delivered during the 5-minute deduplication interval. For
|
1920
|
-
# more information, see [ Exactly-
|
1921
|
-
#
|
1884
|
+
# more information, see [ Exactly-once processing][1] in the *Amazon SQS
|
1885
|
+
# Developer Guide*.
|
1922
1886
|
#
|
1923
1887
|
# * Every message must have a unique `MessageDeduplicationId`,
|
1924
1888
|
#
|
@@ -1964,12 +1928,12 @@ module Aws::SQS
|
|
1964
1928
|
# ``).
|
1965
1929
|
#
|
1966
1930
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
1967
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
1968
|
-
#
|
1931
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
1932
|
+
# Guide*.
|
1969
1933
|
#
|
1970
1934
|
#
|
1971
1935
|
#
|
1972
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
1936
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
1973
1937
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
1974
1938
|
#
|
1975
1939
|
# @option params [String] :message_group_id
|
@@ -1996,8 +1960,7 @@ module Aws::SQS
|
|
1996
1960
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1997
1961
|
#
|
1998
1962
|
# For best practices of using `MessageGroupId`, see [Using the
|
1999
|
-
# MessageGroupId Property][1] in the *Amazon
|
2000
|
-
# Developer Guide*.
|
1963
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2001
1964
|
#
|
2002
1965
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2003
1966
|
# Standard queues.
|
@@ -2178,7 +2141,7 @@ module Aws::SQS
|
|
2178
2141
|
#
|
2179
2142
|
# * Cross-account permissions don't apply to this action. For more
|
2180
2143
|
# information, see [Grant cross-account permissions to a role and a
|
2181
|
-
# user name][1] in the *Amazon
|
2144
|
+
# user name][1] in the *Amazon SQS Developer Guide*.
|
2182
2145
|
#
|
2183
2146
|
# * To remove the ability to change queue permissions, you must deny
|
2184
2147
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2215,9 +2178,10 @@ module Aws::SQS
|
|
2215
2178
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2216
2179
|
# (4 days).
|
2217
2180
|
#
|
2218
|
-
# * `Policy` – The queue's policy. A valid
|
2219
|
-
# information about policy structure, see [Overview of
|
2220
|
-
# Policies][1] in the *
|
2181
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
2182
|
+
# For more information about policy structure, see [Overview of Amazon
|
2183
|
+
# Web Services IAM Policies][1] in the *Identity and Access Management
|
2184
|
+
# User Guide*.
|
2221
2185
|
#
|
2222
2186
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2223
2187
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -2227,7 +2191,7 @@ module Aws::SQS
|
|
2227
2191
|
# dead-letter queue functionality of the source queue as a JSON
|
2228
2192
|
# object. For more information about the redrive policy and
|
2229
2193
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2230
|
-
# the *Amazon
|
2194
|
+
# the *Amazon SQS Developer Guide*.
|
2231
2195
|
#
|
2232
2196
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2233
2197
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2247,33 +2211,32 @@ module Aws::SQS
|
|
2247
2211
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2248
2212
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2249
2213
|
# Default: 30. For more information about the visibility timeout, see
|
2250
|
-
# [Visibility Timeout][3] in the *Amazon
|
2251
|
-
# Developer Guide*.
|
2214
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2252
2215
|
#
|
2253
2216
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2254
2217
|
#
|
2255
|
-
# * `KmsMasterKeyId` – The ID of an
|
2256
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
2257
|
-
# Terms][5]. While the alias of the AWS-managed
|
2258
|
-
# always `alias/aws/sqs`, the alias of a custom
|
2259
|
-
# be `alias/MyAlias `. For more examples, see
|
2260
|
-
# Key Management Service API Reference*.
|
2218
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
2219
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
2220
|
+
# information, see [Key Terms][5]. While the alias of the AWS-managed
|
2221
|
+
# CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom
|
2222
|
+
# CMK can, for example, be `alias/MyAlias `. For more examples, see
|
2223
|
+
# [KeyId][6] in the *Key Management Service API Reference*.
|
2261
2224
|
#
|
2262
2225
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2263
2226
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2264
|
-
# messages before calling
|
2265
|
-
#
|
2266
|
-
#
|
2267
|
-
#
|
2268
|
-
#
|
2269
|
-
#
|
2227
|
+
# messages before calling KMS again. An integer representing seconds,
|
2228
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
2229
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
2230
|
+
# security but results in more calls to KMS which might incur charges
|
2231
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
2232
|
+
# Reuse Period Work?][8].
|
2270
2233
|
#
|
2271
2234
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2272
2235
|
# queues][9]\:
|
2273
2236
|
#
|
2274
2237
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2275
|
-
# For more information, see [Exactly-
|
2276
|
-
# *Amazon
|
2238
|
+
# For more information, see [Exactly-once processing][10] in the
|
2239
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
2277
2240
|
#
|
2278
2241
|
# * Every message must have a unique `MessageDeduplicationId`.
|
2279
2242
|
#
|
@@ -2303,15 +2266,8 @@ module Aws::SQS
|
|
2303
2266
|
# `MessageDeduplicationId`, the two messages are treated as
|
2304
2267
|
# duplicates and only one copy of the message is delivered.
|
2305
2268
|
#
|
2306
|
-
#
|
2307
|
-
#
|
2308
|
-
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
2309
|
-
# is subject to change.** This feature provides a high number of
|
2310
|
-
# transactions per second (TPS) for messages in FIFO queues. For
|
2311
|
-
# information on throughput quotas, see [Quotas related to messages][11]
|
2312
|
-
# in the *Amazon Simple Queue Service Developer Guide*.
|
2313
|
-
#
|
2314
|
-
# This preview includes two new attributes:
|
2269
|
+
# The following attributes apply only to [high throughput for FIFO
|
2270
|
+
# queues][11]\:
|
2315
2271
|
#
|
2316
2272
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2317
2273
|
# occurs at the message group or queue level. Valid values are
|
@@ -2330,22 +2286,11 @@ module Aws::SQS
|
|
2330
2286
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
2331
2287
|
#
|
2332
2288
|
# If you set these attributes to anything other than the values shown
|
2333
|
-
# for enabling high throughput,
|
2289
|
+
# for enabling high throughput, normal throughput is in effect and
|
2334
2290
|
# deduplication occurs as specified.
|
2335
2291
|
#
|
2336
|
-
#
|
2337
|
-
#
|
2338
|
-
# * US East (Ohio); us-east-2
|
2339
|
-
#
|
2340
|
-
# * US East (N. Virginia); us-east-1
|
2341
|
-
#
|
2342
|
-
# * US West (Oregon); us-west-2
|
2343
|
-
#
|
2344
|
-
# * Europe (Ireland); eu-west-1
|
2345
|
-
#
|
2346
|
-
# For more information about high throughput for FIFO queues, see
|
2347
|
-
# [Preview: High throughput for FIFO queues][12] in the *Amazon Simple
|
2348
|
-
# Queue Service Developer Guide*.
|
2292
|
+
# For information on throughput quotas, see [Quotas related to
|
2293
|
+
# messages][12] in the *Amazon SQS Developer Guide*.
|
2349
2294
|
#
|
2350
2295
|
#
|
2351
2296
|
#
|
@@ -2358,9 +2303,9 @@ module Aws::SQS
|
|
2358
2303
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
2359
2304
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2360
2305
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2361
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
2362
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2363
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2306
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
2307
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2308
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2364
2309
|
#
|
2365
2310
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2366
2311
|
#
|
@@ -2383,8 +2328,8 @@ module Aws::SQS
|
|
2383
2328
|
end
|
2384
2329
|
|
2385
2330
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
2386
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2387
|
-
#
|
2331
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
2332
|
+
# Developer Guide*.
|
2388
2333
|
#
|
2389
2334
|
# When you use queue tags, keep the following guidelines in mind:
|
2390
2335
|
#
|
@@ -2398,12 +2343,12 @@ module Aws::SQS
|
|
2398
2343
|
# * A new tag with a key identical to that of an existing tag overwrites
|
2399
2344
|
# the existing tag.
|
2400
2345
|
#
|
2401
|
-
# For a full list of tag restrictions, see [
|
2402
|
-
# in the *Amazon
|
2346
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
2347
|
+
# in the *Amazon SQS Developer Guide*.
|
2403
2348
|
#
|
2404
2349
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2405
2350
|
# information, see [Grant cross-account permissions to a role and a user
|
2406
|
-
# name][3] in the *Amazon
|
2351
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
2407
2352
|
#
|
2408
2353
|
# </note>
|
2409
2354
|
#
|
@@ -2441,11 +2386,11 @@ module Aws::SQS
|
|
2441
2386
|
|
2442
2387
|
# Remove cost allocation tags from the specified Amazon SQS queue. For
|
2443
2388
|
# an overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2444
|
-
#
|
2389
|
+
# SQS Developer Guide*.
|
2445
2390
|
#
|
2446
2391
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2447
2392
|
# information, see [Grant cross-account permissions to a role and a user
|
2448
|
-
# name][2] in the *Amazon
|
2393
|
+
# name][2] in the *Amazon SQS Developer Guide*.
|
2449
2394
|
#
|
2450
2395
|
# </note>
|
2451
2396
|
#
|
@@ -2491,7 +2436,7 @@ module Aws::SQS
|
|
2491
2436
|
params: params,
|
2492
2437
|
config: config)
|
2493
2438
|
context[:gem_name] = 'aws-sdk-sqs'
|
2494
|
-
context[:gem_version] = '1.
|
2439
|
+
context[:gem_version] = '1.40.0'
|
2495
2440
|
Seahorse::Client::Request.new(handlers, context)
|
2496
2441
|
end
|
2497
2442
|
|