aws-sdk-sqs 1.39.0 → 1.40.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs.rb +1 -1
- data/lib/aws-sdk-sqs/client.rb +109 -110
- data/lib/aws-sdk-sqs/message.rb +3 -3
- data/lib/aws-sdk-sqs/queue.rb +37 -39
- data/lib/aws-sdk-sqs/resource.rb +29 -29
- data/lib/aws-sdk-sqs/types.rb +95 -97
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e5bba718dfb7c491f22c6d8c4bc68bfbdab1c57af3abb375775a86f7b52337ff
|
4
|
+
data.tar.gz: 064c80944c447c22fe42bc32f035e26fd78cf412c625a3eb0ad9e50d48d2842a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: b8c237a3535483e375c700488b5477d4368644bcf3edb830591157824b7894587c35a36317a1e8ac85e75b16010ccdf8e500bfa1dc5f1ac58d4a33f059ffa57e
|
7
|
+
data.tar.gz: 00c3494989f6b01d657ecbac82b7abaa4f1bd8dbf248b7c21bce77b4b8dd299df1ac6adb8506c450074ab7c2bf70bb47a81fad98c733d98883cb7e591b6971d2
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.40.0
|
data/lib/aws-sdk-sqs.rb
CHANGED
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -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 queue logic][10] in the *Amazon
|
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-once processing][11] in the *Amazon
|
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
|
#
|
@@ -819,7 +818,7 @@ module Aws::SQS
|
|
819
818
|
# deduplication occurs as specified.
|
820
819
|
#
|
821
820
|
# For information on throughput quotas, see [Quotas related to
|
822
|
-
# messages][13] in the *Amazon
|
821
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
823
822
|
#
|
824
823
|
#
|
825
824
|
#
|
@@ -839,8 +838,8 @@ module Aws::SQS
|
|
839
838
|
#
|
840
839
|
# @option params [Hash<String,String>] :tags
|
841
840
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
842
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
843
|
-
#
|
841
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
842
|
+
# Developer Guide*.
|
844
843
|
#
|
845
844
|
# When you use queue tags, keep the following guidelines in mind:
|
846
845
|
#
|
@@ -854,15 +853,15 @@ module Aws::SQS
|
|
854
853
|
# * A new tag with a key identical to that of an existing tag overwrites
|
855
854
|
# the existing tag.
|
856
855
|
#
|
857
|
-
# For a full list of tag restrictions, see [
|
858
|
-
# in the *Amazon
|
856
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
857
|
+
# in the *Amazon SQS Developer Guide*.
|
859
858
|
#
|
860
859
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
861
860
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
862
861
|
#
|
863
862
|
# Cross-account permissions don't apply to this action. For more
|
864
863
|
# information, see [Grant cross-account permissions to a role and a user
|
865
|
-
# name][3] in the *Amazon
|
864
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
866
865
|
#
|
867
866
|
# </note>
|
868
867
|
#
|
@@ -1028,7 +1027,7 @@ module Aws::SQS
|
|
1028
1027
|
#
|
1029
1028
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1030
1029
|
# information, see [Grant cross-account permissions to a role and a user
|
1031
|
-
# name][1] in the *Amazon
|
1030
|
+
# name][1] in the *Amazon SQS Developer Guide*.
|
1032
1031
|
#
|
1033
1032
|
# </note>
|
1034
1033
|
#
|
@@ -1078,6 +1077,9 @@ module Aws::SQS
|
|
1078
1077
|
# @option params [Array<String>] :attribute_names
|
1079
1078
|
# A list of attributes for which to retrieve information.
|
1080
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
|
+
#
|
1081
1083
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1082
1084
|
# calls this action, we recommend that you structure your code so that
|
1083
1085
|
# it can handle new attributes gracefully.
|
@@ -1135,7 +1137,7 @@ module Aws::SQS
|
|
1135
1137
|
# dead-letter queue functionality of the source queue as a JSON
|
1136
1138
|
# object. For more information about the redrive policy and
|
1137
1139
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1138
|
-
# the *Amazon
|
1140
|
+
# the *Amazon SQS Developer Guide*.
|
1139
1141
|
#
|
1140
1142
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1141
1143
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -1148,25 +1150,25 @@ module Aws::SQS
|
|
1148
1150
|
#
|
1149
1151
|
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1150
1152
|
# For more information about the visibility timeout, see [Visibility
|
1151
|
-
# Timeout][3] in the *Amazon
|
1153
|
+
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1152
1154
|
#
|
1153
1155
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1154
1156
|
#
|
1155
|
-
# * `KmsMasterKeyId` – Returns the ID of an
|
1156
|
-
# key (CMK) for Amazon SQS or a custom CMK. For more
|
1157
|
-
# [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].
|
1158
1160
|
#
|
1159
1161
|
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1160
1162
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1161
|
-
# decrypt messages before calling
|
1162
|
-
#
|
1163
|
+
# decrypt messages before calling KMS again. For more information, see
|
1164
|
+
# [How Does the Data Key Reuse Period Work?][6].
|
1163
1165
|
#
|
1164
1166
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1165
1167
|
# queues][7]\:
|
1166
1168
|
#
|
1167
1169
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1168
|
-
# For more information, see [FIFO queue logic][8] in the *Amazon
|
1169
|
-
#
|
1170
|
+
# For more information, see [FIFO queue logic][8] in the *Amazon SQS
|
1171
|
+
# Developer Guide*.
|
1170
1172
|
#
|
1171
1173
|
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
1172
1174
|
# `QueueName` ends with the `.fifo` suffix.
|
@@ -1175,8 +1177,7 @@ module Aws::SQS
|
|
1175
1177
|
#
|
1176
1178
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
1177
1179
|
# deduplication is enabled for the queue. For more information, see
|
1178
|
-
# [Exactly-once processing][9] in the *Amazon
|
1179
|
-
# Developer Guide*.
|
1180
|
+
# [Exactly-once processing][9] in the *Amazon SQS Developer Guide*.
|
1180
1181
|
#
|
1181
1182
|
# The following attributes apply only to [high throughput for FIFO
|
1182
1183
|
# queues][10]\:
|
@@ -1202,7 +1203,7 @@ module Aws::SQS
|
|
1202
1203
|
# deduplication occurs as specified.
|
1203
1204
|
#
|
1204
1205
|
# For information on throughput quotas, see [Quotas related to
|
1205
|
-
# messages][11] in the *Amazon
|
1206
|
+
# messages][11] in the *Amazon SQS Developer Guide*.
|
1206
1207
|
#
|
1207
1208
|
#
|
1208
1209
|
#
|
@@ -1250,7 +1251,7 @@ module Aws::SQS
|
|
1250
1251
|
# queue's owner. The queue's owner must grant you permission to access
|
1251
1252
|
# the queue. For more information about shared queue access, see `
|
1252
1253
|
# AddPermission ` or see [Allow Developers to Write Messages to a Shared
|
1253
|
-
# Queue][1] in the *Amazon
|
1254
|
+
# Queue][1] in the *Amazon SQS Developer Guide*.
|
1254
1255
|
#
|
1255
1256
|
#
|
1256
1257
|
#
|
@@ -1264,7 +1265,7 @@ module Aws::SQS
|
|
1264
1265
|
# Queue URLs and names are case-sensitive.
|
1265
1266
|
#
|
1266
1267
|
# @option params [String] :queue_owner_aws_account_id
|
1267
|
-
# The
|
1268
|
+
# The account ID of the account that created the queue.
|
1268
1269
|
#
|
1269
1270
|
# @return [Types::GetQueueUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1270
1271
|
#
|
@@ -1303,8 +1304,7 @@ module Aws::SQS
|
|
1303
1304
|
# receive the next page of results.
|
1304
1305
|
#
|
1305
1306
|
# For more information about using dead-letter queues, see [Using Amazon
|
1306
|
-
# SQS Dead-Letter Queues][1] in the *Amazon
|
1307
|
-
# Developer Guide*.
|
1307
|
+
# SQS Dead-Letter Queues][1] in the *Amazon SQS Developer Guide*.
|
1308
1308
|
#
|
1309
1309
|
#
|
1310
1310
|
#
|
@@ -1355,11 +1355,11 @@ module Aws::SQS
|
|
1355
1355
|
|
1356
1356
|
# List all cost allocation tags added to the specified Amazon SQS queue.
|
1357
1357
|
# For an overview, see [Tagging Your Amazon SQS Queues][1] in the
|
1358
|
-
# *Amazon
|
1358
|
+
# *Amazon SQS Developer Guide*.
|
1359
1359
|
#
|
1360
1360
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1361
1361
|
# information, see [Grant cross-account permissions to a role and a user
|
1362
|
-
# name][2] in the *Amazon
|
1362
|
+
# name][2] in the *Amazon SQS Developer Guide*.
|
1363
1363
|
#
|
1364
1364
|
# </note>
|
1365
1365
|
#
|
@@ -1410,7 +1410,7 @@ module Aws::SQS
|
|
1410
1410
|
#
|
1411
1411
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1412
1412
|
# information, see [Grant cross-account permissions to a role and a user
|
1413
|
-
# name][1] in the *Amazon
|
1413
|
+
# name][1] in the *Amazon SQS Developer Guide*.
|
1414
1414
|
#
|
1415
1415
|
# </note>
|
1416
1416
|
#
|
@@ -1501,8 +1501,8 @@ module Aws::SQS
|
|
1501
1501
|
|
1502
1502
|
# Retrieves one or more messages (up to 10), from the specified queue.
|
1503
1503
|
# Using the `WaitTimeSeconds` parameter enables long-poll support. For
|
1504
|
-
# more information, see [Amazon SQS Long Polling][1] in the *Amazon
|
1505
|
-
#
|
1504
|
+
# more information, see [Amazon SQS Long Polling][1] in the *Amazon SQS
|
1505
|
+
# Developer Guide*.
|
1506
1506
|
#
|
1507
1507
|
# Short poll is the default behavior where a weighted random set of
|
1508
1508
|
# machines is sampled on a `ReceiveMessage` call. Thus, only the
|
@@ -1530,14 +1530,14 @@ module Aws::SQS
|
|
1530
1530
|
#
|
1531
1531
|
# The receipt handle is the identifier you must provide when deleting
|
1532
1532
|
# the message. For more information, see [Queue and Message
|
1533
|
-
# Identifiers][3] in the *Amazon
|
1533
|
+
# Identifiers][3] in the *Amazon SQS Developer Guide*.
|
1534
1534
|
#
|
1535
1535
|
# You can provide the `VisibilityTimeout` parameter in your request. The
|
1536
1536
|
# parameter is applied to the messages that Amazon SQS returns in the
|
1537
1537
|
# response. If you don't include the parameter, the overall visibility
|
1538
1538
|
# timeout for the queue is used for the returned messages. For more
|
1539
|
-
# information, see [Visibility Timeout][4] in the *Amazon
|
1540
|
-
#
|
1539
|
+
# information, see [Visibility Timeout][4] in the *Amazon SQS Developer
|
1540
|
+
# Guide*.
|
1541
1541
|
#
|
1542
1542
|
# A message that isn't deleted or a message whose visibility isn't
|
1543
1543
|
# extended before the visibility timeout expires counts as a failed
|
@@ -1574,7 +1574,7 @@ module Aws::SQS
|
|
1574
1574
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1575
1575
|
# has been received across all queues but not deleted.
|
1576
1576
|
#
|
1577
|
-
# * `AWSTraceHeader` – Returns the
|
1577
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1578
1578
|
#
|
1579
1579
|
# * `SenderId`
|
1580
1580
|
#
|
@@ -1678,7 +1678,7 @@ module Aws::SQS
|
|
1678
1678
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
1679
1679
|
# handles. If a retry occurs within the deduplication interval, it
|
1680
1680
|
# resets the visibility timeout. For more information, see [Visibility
|
1681
|
-
# Timeout][1] in the *Amazon
|
1681
|
+
# Timeout][1] in the *Amazon SQS Developer Guide*.
|
1682
1682
|
#
|
1683
1683
|
# If a caller of the `ReceiveMessage` action still processes messages
|
1684
1684
|
# when the visibility timeout expires and messages become visible,
|
@@ -1707,8 +1707,8 @@ module Aws::SQS
|
|
1707
1707
|
# ``).
|
1708
1708
|
#
|
1709
1709
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
1710
|
-
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
1711
|
-
#
|
1710
|
+
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
1711
|
+
# Developer Guide*.
|
1712
1712
|
#
|
1713
1713
|
#
|
1714
1714
|
#
|
@@ -1766,7 +1766,7 @@ module Aws::SQS
|
|
1766
1766
|
#
|
1767
1767
|
# * Cross-account permissions don't apply to this action. For more
|
1768
1768
|
# information, see [Grant cross-account permissions to a role and a
|
1769
|
-
# user name][1] in the *Amazon
|
1769
|
+
# user name][1] in the *Amazon SQS Developer Guide*.
|
1770
1770
|
#
|
1771
1771
|
# * To remove the ability to change queue permissions, you must deny
|
1772
1772
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1856,8 +1856,8 @@ module Aws::SQS
|
|
1856
1856
|
#
|
1857
1857
|
# @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
1858
1858
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
1859
|
-
# more information, see [Amazon SQS
|
1860
|
-
# *Amazon
|
1859
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
1860
|
+
# *Amazon SQS Developer Guide*.
|
1861
1861
|
#
|
1862
1862
|
#
|
1863
1863
|
#
|
@@ -1869,7 +1869,7 @@ module Aws::SQS
|
|
1869
1869
|
#
|
1870
1870
|
# * Currently, the only supported message system attribute is
|
1871
1871
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1872
|
-
# correctly formatted
|
1872
|
+
# correctly formatted X-Ray trace header string.
|
1873
1873
|
#
|
1874
1874
|
# * The size of a message system attribute doesn't count towards the
|
1875
1875
|
# total size of a message.
|
@@ -1881,8 +1881,8 @@ module Aws::SQS
|
|
1881
1881
|
# particular `MessageDeduplicationId` is sent successfully, any messages
|
1882
1882
|
# sent with the same `MessageDeduplicationId` are accepted successfully
|
1883
1883
|
# but aren't delivered during the 5-minute deduplication interval. For
|
1884
|
-
# more information, see [ Exactly-once processing][1] in the *Amazon
|
1885
|
-
#
|
1884
|
+
# more information, see [ Exactly-once processing][1] in the *Amazon SQS
|
1885
|
+
# Developer Guide*.
|
1886
1886
|
#
|
1887
1887
|
# * Every message must have a unique `MessageDeduplicationId`,
|
1888
1888
|
#
|
@@ -1928,8 +1928,8 @@ module Aws::SQS
|
|
1928
1928
|
# ``).
|
1929
1929
|
#
|
1930
1930
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
1931
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
1932
|
-
#
|
1931
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
1932
|
+
# Guide*.
|
1933
1933
|
#
|
1934
1934
|
#
|
1935
1935
|
#
|
@@ -1960,8 +1960,7 @@ module Aws::SQS
|
|
1960
1960
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1961
1961
|
#
|
1962
1962
|
# For best practices of using `MessageGroupId`, see [Using the
|
1963
|
-
# MessageGroupId Property][1] in the *Amazon
|
1964
|
-
# Developer Guide*.
|
1963
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
1965
1964
|
#
|
1966
1965
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
1967
1966
|
# Standard queues.
|
@@ -2142,7 +2141,7 @@ module Aws::SQS
|
|
2142
2141
|
#
|
2143
2142
|
# * Cross-account permissions don't apply to this action. For more
|
2144
2143
|
# information, see [Grant cross-account permissions to a role and a
|
2145
|
-
# user name][1] in the *Amazon
|
2144
|
+
# user name][1] in the *Amazon SQS Developer Guide*.
|
2146
2145
|
#
|
2147
2146
|
# * To remove the ability to change queue permissions, you must deny
|
2148
2147
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2179,9 +2178,10 @@ module Aws::SQS
|
|
2179
2178
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2180
2179
|
# (4 days).
|
2181
2180
|
#
|
2182
|
-
# * `Policy` – The queue's policy. A valid
|
2183
|
-
# information about policy structure, see [Overview of
|
2184
|
-
# 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*.
|
2185
2185
|
#
|
2186
2186
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2187
2187
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -2191,7 +2191,7 @@ module Aws::SQS
|
|
2191
2191
|
# dead-letter queue functionality of the source queue as a JSON
|
2192
2192
|
# object. For more information about the redrive policy and
|
2193
2193
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2194
|
-
# the *Amazon
|
2194
|
+
# the *Amazon SQS Developer Guide*.
|
2195
2195
|
#
|
2196
2196
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2197
2197
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2211,33 +2211,32 @@ module Aws::SQS
|
|
2211
2211
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2212
2212
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2213
2213
|
# Default: 30. For more information about the visibility timeout, see
|
2214
|
-
# [Visibility Timeout][3] in the *Amazon
|
2215
|
-
# Developer Guide*.
|
2214
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2216
2215
|
#
|
2217
2216
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2218
2217
|
#
|
2219
|
-
# * `KmsMasterKeyId` – The ID of an
|
2220
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
2221
|
-
# Terms][5]. While the alias of the AWS-managed
|
2222
|
-
# always `alias/aws/sqs`, the alias of a custom
|
2223
|
-
# be `alias/MyAlias `. For more examples, see
|
2224
|
-
# 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*.
|
2225
2224
|
#
|
2226
2225
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2227
2226
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2228
|
-
# messages before calling
|
2229
|
-
#
|
2230
|
-
#
|
2231
|
-
#
|
2232
|
-
#
|
2233
|
-
#
|
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].
|
2234
2233
|
#
|
2235
2234
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2236
2235
|
# queues][9]\:
|
2237
2236
|
#
|
2238
2237
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2239
2238
|
# For more information, see [Exactly-once processing][10] in the
|
2240
|
-
# *Amazon
|
2239
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
2241
2240
|
#
|
2242
2241
|
# * Every message must have a unique `MessageDeduplicationId`.
|
2243
2242
|
#
|
@@ -2291,7 +2290,7 @@ module Aws::SQS
|
|
2291
2290
|
# deduplication occurs as specified.
|
2292
2291
|
#
|
2293
2292
|
# For information on throughput quotas, see [Quotas related to
|
2294
|
-
# messages][12] in the *Amazon
|
2293
|
+
# messages][12] in the *Amazon SQS Developer Guide*.
|
2295
2294
|
#
|
2296
2295
|
#
|
2297
2296
|
#
|
@@ -2329,8 +2328,8 @@ module Aws::SQS
|
|
2329
2328
|
end
|
2330
2329
|
|
2331
2330
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
2332
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2333
|
-
#
|
2331
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
2332
|
+
# Developer Guide*.
|
2334
2333
|
#
|
2335
2334
|
# When you use queue tags, keep the following guidelines in mind:
|
2336
2335
|
#
|
@@ -2344,12 +2343,12 @@ module Aws::SQS
|
|
2344
2343
|
# * A new tag with a key identical to that of an existing tag overwrites
|
2345
2344
|
# the existing tag.
|
2346
2345
|
#
|
2347
|
-
# For a full list of tag restrictions, see [
|
2348
|
-
# in the *Amazon
|
2346
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
2347
|
+
# in the *Amazon SQS Developer Guide*.
|
2349
2348
|
#
|
2350
2349
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2351
2350
|
# information, see [Grant cross-account permissions to a role and a user
|
2352
|
-
# name][3] in the *Amazon
|
2351
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
2353
2352
|
#
|
2354
2353
|
# </note>
|
2355
2354
|
#
|
@@ -2387,11 +2386,11 @@ module Aws::SQS
|
|
2387
2386
|
|
2388
2387
|
# Remove cost allocation tags from the specified Amazon SQS queue. For
|
2389
2388
|
# an overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2390
|
-
#
|
2389
|
+
# SQS Developer Guide*.
|
2391
2390
|
#
|
2392
2391
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2393
2392
|
# information, see [Grant cross-account permissions to a role and a user
|
2394
|
-
# name][2] in the *Amazon
|
2393
|
+
# name][2] in the *Amazon SQS Developer Guide*.
|
2395
2394
|
#
|
2396
2395
|
# </note>
|
2397
2396
|
#
|
@@ -2437,7 +2436,7 @@ module Aws::SQS
|
|
2437
2436
|
params: params,
|
2438
2437
|
config: config)
|
2439
2438
|
context[:gem_name] = 'aws-sdk-sqs'
|
2440
|
-
context[:gem_version] = '1.
|
2439
|
+
context[:gem_version] = '1.40.0'
|
2441
2440
|
Seahorse::Client::Request.new(handlers, context)
|
2442
2441
|
end
|
2443
2442
|
|