aws-sdk-sqs 1.0.0.rc4 → 1.0.0.rc5
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/lib/aws-sdk-sqs.rb +1 -1
- data/lib/aws-sdk-sqs/client.rb +157 -116
- data/lib/aws-sdk-sqs/message.rb +1 -1
- data/lib/aws-sdk-sqs/queue.rb +51 -40
- data/lib/aws-sdk-sqs/resource.rb +46 -24
- data/lib/aws-sdk-sqs/types.rb +156 -100
- metadata +2 -2
data/lib/aws-sdk-sqs/message.rb
CHANGED
@@ -73,7 +73,7 @@ module Aws::SQS
|
|
73
73
|
# An MD5 digest of the non-URL-encoded message attribute string. You can
|
74
74
|
# use this attribute to verify that Amazon SQS received the message
|
75
75
|
# correctly. Amazon SQS URL-decodes the message before creating the MD5
|
76
|
-
# digest. For information
|
76
|
+
# digest. For information about MD5, see [RFC1321][1].
|
77
77
|
#
|
78
78
|
#
|
79
79
|
#
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -204,7 +204,7 @@ module Aws::SQS
|
|
204
204
|
# @example Request syntax with placeholder values
|
205
205
|
#
|
206
206
|
# message = queue.receive_messages({
|
207
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication
|
207
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
208
208
|
# message_attribute_names: ["MessageAttributeName"],
|
209
209
|
# max_number_of_messages: 1,
|
210
210
|
# visibility_timeout: 1,
|
@@ -431,33 +431,24 @@ module Aws::SQS
|
|
431
431
|
# @option options [required, String] :message_body
|
432
432
|
# The message to send. The maximum string size is 256 KB.
|
433
433
|
#
|
434
|
-
#
|
435
|
-
#
|
434
|
+
# A message can include only XML, JSON, and unformatted text. The
|
435
|
+
# following Unicode characters are allowed:
|
436
436
|
#
|
437
|
-
#
|
437
|
+
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
|
438
|
+
# \| `#x10000` to `#x10FFFF`
|
438
439
|
#
|
439
|
-
#
|
440
|
+
# Any characters not included in this list will be rejected. For more
|
441
|
+
# information, see the [W3C specification for characters][1].
|
440
442
|
#
|
441
|
-
# * `#xD`
|
442
443
|
#
|
443
|
-
# * `#x20` to `#xD7FF`
|
444
444
|
#
|
445
|
-
#
|
446
|
-
#
|
447
|
-
# * `#x10000` to `#x10FFFF`
|
448
|
-
#
|
449
|
-
# For more information, see [RFC1321][1]. If you send any characters
|
450
|
-
# that aren't included in this list, your request is rejected.
|
451
|
-
#
|
452
|
-
#
|
453
|
-
#
|
454
|
-
# [1]: https://www.ietf.org/rfc/rfc1321.txt
|
445
|
+
# [1]: http://www.w3.org/TR/REC-xml/#charsets
|
455
446
|
# @option options [Integer] :delay_seconds
|
456
|
-
# The
|
457
|
-
# 900. Maximum: 15 minutes. Messages with a positive
|
458
|
-
# value become available for processing after the delay
|
459
|
-
# finished. If you don't specify a value, the default value
|
460
|
-
# queue applies.
|
447
|
+
# The length of time, in seconds, for which to delay a specific message.
|
448
|
+
# Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive
|
449
|
+
# `DelaySeconds` value become available for processing after the delay
|
450
|
+
# period is finished. If you don't specify a value, the default value
|
451
|
+
# for the queue applies.
|
461
452
|
#
|
462
453
|
# <note markdown="1"> When you set `FifoQueue`, you can't set `DelaySeconds` per message.
|
463
454
|
# You can set this parameter only on a queue level.
|
@@ -501,9 +492,6 @@ module Aws::SQS
|
|
501
492
|
# identical content sent within the deduplication interval are treated
|
502
493
|
# as duplicates and only one copy of the message is delivered.
|
503
494
|
#
|
504
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
505
|
-
# identical content to be treated as duplicates.
|
506
|
-
#
|
507
495
|
# * If you send one message with `ContentBasedDeduplication` enabled and
|
508
496
|
# then another message with a `MessageDeduplicationId` that is the
|
509
497
|
# same as the one generated for the first `MessageDeduplicationId`,
|
@@ -559,6 +547,9 @@ module Aws::SQS
|
|
559
547
|
# MessageGroupId Property][1] in the *Amazon Simple Queue Service
|
560
548
|
# Developer Guide*.
|
561
549
|
#
|
550
|
+
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
551
|
+
# Standard queues.
|
552
|
+
#
|
562
553
|
#
|
563
554
|
#
|
564
555
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property
|
@@ -615,17 +606,17 @@ module Aws::SQS
|
|
615
606
|
# The following lists the names, descriptions, and values of the special
|
616
607
|
# request parameters that the `SetQueueAttributes` action uses:
|
617
608
|
#
|
618
|
-
# * `DelaySeconds` - The
|
619
|
-
# messages in the queue is delayed. Valid values: An
|
620
|
-
# 900 (15 minutes). The default is 0 (zero).
|
609
|
+
# * `DelaySeconds` - The length of time, in seconds, for which the
|
610
|
+
# delivery of all messages in the queue is delayed. Valid values: An
|
611
|
+
# integer from 0 to 900 (15 minutes). The default is 0 (zero).
|
621
612
|
#
|
622
613
|
# * `MaximumMessageSize` - The limit of how many bytes a message can
|
623
614
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
624
615
|
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is
|
625
616
|
# 262,144 (256 KiB).
|
626
617
|
#
|
627
|
-
# * `MessageRetentionPeriod` - The
|
628
|
-
# SQS retains a message. Valid values: An integer representing
|
618
|
+
# * `MessageRetentionPeriod` - The length of time, in seconds, for which
|
619
|
+
# Amazon SQS retains a message. Valid values: An integer representing
|
629
620
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is
|
630
621
|
# 345,600 (4 days).
|
631
622
|
#
|
@@ -633,9 +624,9 @@ module Aws::SQS
|
|
633
624
|
# information about policy structure, see [Overview of AWS IAM
|
634
625
|
# Policies][1] in the *Amazon IAM User Guide*.
|
635
626
|
#
|
636
|
-
# * `ReceiveMessageWaitTimeSeconds` - The
|
637
|
-
# ` ReceiveMessage ` action waits for a message to arrive.
|
638
|
-
# values: an integer from 0 to 20 (seconds). The default is 0.
|
627
|
+
# * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
|
628
|
+
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
629
|
+
# Valid values: an integer from 0 to 20 (seconds). The default is 0.
|
639
630
|
#
|
640
631
|
# * `RedrivePolicy` - The parameters for the dead letter queue
|
641
632
|
# functionality of the source queue. For more information about the
|
@@ -653,11 +644,29 @@ module Aws::SQS
|
|
653
644
|
# For more information about the visibility timeout, see [Visibility
|
654
645
|
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
655
646
|
#
|
647
|
+
# The following attributes apply only to [server-side-encryption][4]\:
|
648
|
+
#
|
649
|
+
# * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
|
650
|
+
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
651
|
+
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
652
|
+
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
653
|
+
# be `alias/aws/sqs`. For more examples, see [KeyId][6] in the *AWS
|
654
|
+
# Key Management Service API Reference*.
|
655
|
+
#
|
656
|
+
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
|
657
|
+
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
658
|
+
# messages before calling AWS KMS again. An integer representing
|
659
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
660
|
+
# hours). The default is 300 (5 minutes). A shorter time period
|
661
|
+
# provides better security but results in more calls to KMS which
|
662
|
+
# incur charges after Free Tier. For more information, see [How Does
|
663
|
+
# the Data Key Reuse Period Work?][8].
|
664
|
+
#
|
656
665
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
657
|
-
# queues][
|
666
|
+
# queues][9]\:
|
658
667
|
#
|
659
668
|
# * `ContentBasedDeduplication` - Enables content-based deduplication.
|
660
|
-
# For more information, see [Exactly-Once Processing][
|
669
|
+
# For more information, see [Exactly-Once Processing][10] in the
|
661
670
|
# *Amazon SQS Developer Guide*.
|
662
671
|
#
|
663
672
|
# * Every message must have a unique `MessageDeduplicationId`,
|
@@ -682,9 +691,6 @@ module Aws::SQS
|
|
682
691
|
# treated as duplicates and only one copy of the message is
|
683
692
|
# delivered.
|
684
693
|
#
|
685
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
686
|
-
# identical content to be treated as duplicates.
|
687
|
-
#
|
688
694
|
# * If you send one message with `ContentBasedDeduplication` enabled
|
689
695
|
# and then another message with a `MessageDeduplicationId` that is
|
690
696
|
# the same as the one generated for the first
|
@@ -711,8 +717,13 @@ module Aws::SQS
|
|
711
717
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
712
718
|
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
713
719
|
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
714
|
-
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
715
|
-
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
720
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
721
|
+
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
722
|
+
# [6]: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
723
|
+
# [7]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
724
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
725
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
726
|
+
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
716
727
|
# @return [EmptyStructure]
|
717
728
|
def set_attributes(options = {})
|
718
729
|
options = options.merge(queue_url: @url)
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -47,27 +47,28 @@ module Aws::SQS
|
|
47
47
|
# The following lists the names, descriptions, and values of the special
|
48
48
|
# request parameters that the `CreateQueue` action uses:
|
49
49
|
#
|
50
|
-
# * `DelaySeconds` - The
|
51
|
-
# messages in the queue is delayed. Valid values: An
|
52
|
-
# 900 seconds (15 minutes). The default is 0 (zero).
|
50
|
+
# * `DelaySeconds` - The length of time, in seconds, for which the
|
51
|
+
# delivery of all messages in the queue is delayed. Valid values: An
|
52
|
+
# integer from 0 to 900 seconds (15 minutes). The default is 0 (zero).
|
53
53
|
#
|
54
54
|
# * `MaximumMessageSize` - The limit of how many bytes a message can
|
55
55
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
56
56
|
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default is
|
57
57
|
# 262,144 (256 KiB).
|
58
58
|
#
|
59
|
-
# * `MessageRetentionPeriod` - The
|
60
|
-
# SQS retains a message. Valid values: An integer from 60
|
61
|
-
# minute) to 1,209,600 seconds (14 days). The default is
|
62
|
-
# days).
|
59
|
+
# * `MessageRetentionPeriod` - The length of time, in seconds, for which
|
60
|
+
# Amazon SQS retains a message. Valid values: An integer from 60
|
61
|
+
# seconds (1 minute) to 1,209,600 seconds (14 days). The default is
|
62
|
+
# 345,600 (4 days).
|
63
63
|
#
|
64
64
|
# * `Policy` - The queue's policy. A valid AWS policy. For more
|
65
65
|
# information about policy structure, see [Overview of AWS IAM
|
66
66
|
# Policies][1] in the *Amazon IAM User Guide*.
|
67
67
|
#
|
68
|
-
# * `ReceiveMessageWaitTimeSeconds` - The
|
69
|
-
# ` ReceiveMessage ` action waits for a message to arrive.
|
70
|
-
# values: An integer from 0 to 20 (seconds). The default is 0
|
68
|
+
# * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
|
69
|
+
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
70
|
+
# Valid values: An integer from 0 to 20 (seconds). The default is 0
|
71
|
+
# (zero).
|
71
72
|
#
|
72
73
|
# * `RedrivePolicy` - The parameters for the dead letter queue
|
73
74
|
# functionality of the source queue. For more information about the
|
@@ -85,20 +86,39 @@ module Aws::SQS
|
|
85
86
|
# For more information about the visibility timeout, see [Visibility
|
86
87
|
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
87
88
|
#
|
89
|
+
# The following attributes apply only to [server-side-encryption][4]\:
|
90
|
+
#
|
91
|
+
# * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
|
92
|
+
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
93
|
+
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
94
|
+
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
95
|
+
# be `alias/aws/sqs`. For more examples, see [KeyId][6] in the *AWS
|
96
|
+
# Key Management Service API Reference*.
|
97
|
+
#
|
98
|
+
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
|
99
|
+
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
100
|
+
# messages before calling AWS KMS again. An integer representing
|
101
|
+
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
102
|
+
# hours). The default is 300 (5 minutes). A shorter time period
|
103
|
+
# provides better security but results in more calls to KMS which
|
104
|
+
# incur charges after Free Tier. For more information, see [How Does
|
105
|
+
# the Data Key Reuse Period Work?][8].
|
106
|
+
#
|
88
107
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
89
|
-
# queues][
|
108
|
+
# queues][9]\:
|
90
109
|
#
|
91
|
-
# * `FifoQueue` - Designates a queue as FIFO.
|
92
|
-
# attribute only during queue creation.
|
93
|
-
# existing queue. When you set this
|
94
|
-
# `MessageGroupId`
|
110
|
+
# * `FifoQueue` - Designates a queue as FIFO. Valid values: `true`,
|
111
|
+
# `false`. You can provide this attribute only during queue creation.
|
112
|
+
# You can't change it for an existing queue. When you set this
|
113
|
+
# attribute, you must also provide the `MessageGroupId` for your
|
114
|
+
# messages explicitly.
|
95
115
|
#
|
96
|
-
# For more information, see [FIFO Queue Logic][
|
116
|
+
# For more information, see [FIFO Queue Logic][10] in the *Amazon SQS
|
97
117
|
# Developer Guide*.
|
98
118
|
#
|
99
119
|
# * `ContentBasedDeduplication` - Enables content-based deduplication.
|
100
|
-
# For more information, see
|
101
|
-
# *Amazon SQS Developer Guide*.
|
120
|
+
# Valid values: `true`, `false`. For more information, see
|
121
|
+
# [Exactly-Once Processing][11] in the *Amazon SQS Developer Guide*.
|
102
122
|
#
|
103
123
|
# * Every message must have a unique `MessageDeduplicationId`,
|
104
124
|
#
|
@@ -122,9 +142,6 @@ module Aws::SQS
|
|
122
142
|
# treated as duplicates and only one copy of the message is
|
123
143
|
# delivered.
|
124
144
|
#
|
125
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
126
|
-
# identical content to be treated as duplicates.
|
127
|
-
#
|
128
145
|
# * If you send one message with `ContentBasedDeduplication` enabled
|
129
146
|
# and then another message with a `MessageDeduplicationId` that is
|
130
147
|
# the same as the one generated for the first
|
@@ -151,9 +168,14 @@ module Aws::SQS
|
|
151
168
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
152
169
|
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
153
170
|
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
154
|
-
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
155
|
-
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
156
|
-
# [6]: http://docs.aws.amazon.com/
|
171
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
172
|
+
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
173
|
+
# [6]: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
174
|
+
# [7]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
175
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
176
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
177
|
+
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
178
|
+
# [11]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
157
179
|
# @return [Queue]
|
158
180
|
def create_queue(options = {})
|
159
181
|
resp = @client.create_queue(options)
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -150,7 +150,7 @@ module Aws::SQS
|
|
150
150
|
end
|
151
151
|
|
152
152
|
# Encloses a receipt handle and an entry id for each message in `
|
153
|
-
# ChangeMessageVisibilityBatch
|
153
|
+
# ChangeMessageVisibilityBatch.`
|
154
154
|
#
|
155
155
|
# All of the following list parameters must be prefixed with
|
156
156
|
# `ChangeMessageVisibilityBatchRequestEntry.n`, where `n` is an integer
|
@@ -218,7 +218,7 @@ module Aws::SQS
|
|
218
218
|
include Aws::Structure
|
219
219
|
end
|
220
220
|
|
221
|
-
# Encloses the `Id` of an entry in ` ChangeMessageVisibilityBatch
|
221
|
+
# Encloses the `Id` of an entry in ` ChangeMessageVisibilityBatch.`
|
222
222
|
#
|
223
223
|
# @!attribute [rw] id
|
224
224
|
# Represents a message whose visibility timeout has been changed
|
@@ -297,28 +297,29 @@ module Aws::SQS
|
|
297
297
|
# The following lists the names, descriptions, and values of the
|
298
298
|
# special request parameters that the `CreateQueue` action uses:
|
299
299
|
#
|
300
|
-
# * `DelaySeconds` - The
|
301
|
-
# all messages in the queue is delayed. Valid values: An
|
302
|
-
# from 0 to 900 seconds (15 minutes). The default is 0
|
300
|
+
# * `DelaySeconds` - The length of time, in seconds, for which the
|
301
|
+
# delivery of all messages in the queue is delayed. Valid values: An
|
302
|
+
# integer from 0 to 900 seconds (15 minutes). The default is 0
|
303
|
+
# (zero).
|
303
304
|
#
|
304
305
|
# * `MaximumMessageSize` - The limit of how many bytes a message can
|
305
306
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
306
307
|
# from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default
|
307
308
|
# is 262,144 (256 KiB).
|
308
309
|
#
|
309
|
-
# * `MessageRetentionPeriod` - The
|
310
|
-
# SQS retains a message. Valid values: An integer from
|
311
|
-
# minute) to 1,209,600 seconds (14 days). The default
|
312
|
-
# days).
|
310
|
+
# * `MessageRetentionPeriod` - The length of time, in seconds, for
|
311
|
+
# which Amazon SQS retains a message. Valid values: An integer from
|
312
|
+
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default
|
313
|
+
# is 345,600 (4 days).
|
313
314
|
#
|
314
315
|
# * `Policy` - The queue's policy. A valid AWS policy. For more
|
315
316
|
# information about policy structure, see [Overview of AWS IAM
|
316
317
|
# Policies][1] in the *Amazon IAM User Guide*.
|
317
318
|
#
|
318
|
-
# * `ReceiveMessageWaitTimeSeconds` - The
|
319
|
-
# a ` ReceiveMessage ` action waits for a message to
|
320
|
-
# values: An integer from 0 to 20 (seconds). The
|
321
|
-
# (zero).
|
319
|
+
# * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
|
320
|
+
# for which a ` ReceiveMessage ` action waits for a message to
|
321
|
+
# arrive. Valid values: An integer from 0 to 20 (seconds). The
|
322
|
+
# default is 0 (zero).
|
322
323
|
#
|
323
324
|
# * `RedrivePolicy` - The parameters for the dead letter queue
|
324
325
|
# functionality of the source queue. For more information about the
|
@@ -336,20 +337,39 @@ module Aws::SQS
|
|
336
337
|
# For more information about the visibility timeout, see [Visibility
|
337
338
|
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
338
339
|
#
|
340
|
+
# The following attributes apply only to [server-side-encryption][4]\:
|
341
|
+
#
|
342
|
+
# * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
|
343
|
+
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
344
|
+
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
345
|
+
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
346
|
+
# example, be `alias/aws/sqs`. For more examples, see [KeyId][6] in
|
347
|
+
# the *AWS Key Management Service API Reference*.
|
348
|
+
#
|
349
|
+
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
|
350
|
+
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
351
|
+
# decrypt messages before calling AWS KMS again. An integer
|
352
|
+
# representing seconds, between 60 seconds (1 minute) and 86,400
|
353
|
+
# seconds (24 hours). The default is 300 (5 minutes). A shorter time
|
354
|
+
# period provides better security but results in more calls to KMS
|
355
|
+
# which incur charges after Free Tier. For more information, see
|
356
|
+
# [How Does the Data Key Reuse Period Work?][8].
|
357
|
+
#
|
339
358
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
340
|
-
# queues][
|
359
|
+
# queues][9]\:
|
341
360
|
#
|
342
|
-
# * `FifoQueue` - Designates a queue as FIFO.
|
343
|
-
#
|
344
|
-
# existing queue. When you set
|
345
|
-
# `MessageGroupId`
|
361
|
+
# * `FifoQueue` - Designates a queue as FIFO. Valid values: `true`,
|
362
|
+
# `false`. You can provide this attribute only during queue
|
363
|
+
# creation. You can't change it for an existing queue. When you set
|
364
|
+
# this attribute, you must also provide the `MessageGroupId` for
|
365
|
+
# your messages explicitly.
|
346
366
|
#
|
347
|
-
# For more information, see [FIFO Queue Logic][
|
348
|
-
# Developer Guide*.
|
367
|
+
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
368
|
+
# SQS Developer Guide*.
|
349
369
|
#
|
350
370
|
# * `ContentBasedDeduplication` - Enables content-based deduplication.
|
351
|
-
# For more information, see
|
352
|
-
# *Amazon SQS Developer Guide*.
|
371
|
+
# Valid values: `true`, `false`. For more information, see
|
372
|
+
# [Exactly-Once Processing][11] in the *Amazon SQS Developer Guide*.
|
353
373
|
#
|
354
374
|
# * Every message must have a unique `MessageDeduplicationId`,
|
355
375
|
#
|
@@ -373,9 +393,6 @@ module Aws::SQS
|
|
373
393
|
# treated as duplicates and only one copy of the message is
|
374
394
|
# delivered.
|
375
395
|
#
|
376
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
377
|
-
# identical content to be treated as duplicates.
|
378
|
-
#
|
379
396
|
# * If you send one message with `ContentBasedDeduplication` enabled
|
380
397
|
# and then another message with a `MessageDeduplicationId` that is
|
381
398
|
# the same as the one generated for the first
|
@@ -402,9 +419,14 @@ module Aws::SQS
|
|
402
419
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
403
420
|
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
404
421
|
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
405
|
-
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
406
|
-
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
407
|
-
# [6]: http://docs.aws.amazon.com/
|
422
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
423
|
+
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
424
|
+
# [6]: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
425
|
+
# [7]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
426
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
427
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
428
|
+
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
429
|
+
# [11]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
408
430
|
# @return [Hash<String,String>]
|
409
431
|
#
|
410
432
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueueRequest AWS API Documentation
|
@@ -510,7 +532,7 @@ module Aws::SQS
|
|
510
532
|
include Aws::Structure
|
511
533
|
end
|
512
534
|
|
513
|
-
# Encloses the `Id` of an entry in ` DeleteMessageBatch
|
535
|
+
# Encloses the `Id` of an entry in ` DeleteMessageBatch.`
|
514
536
|
#
|
515
537
|
# @!attribute [rw] id
|
516
538
|
# Represents a successfully deleted message.
|
@@ -574,7 +596,7 @@ module Aws::SQS
|
|
574
596
|
#
|
575
597
|
# {
|
576
598
|
# queue_url: "String", # required
|
577
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication
|
599
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
578
600
|
# }
|
579
601
|
#
|
580
602
|
# @!attribute [rw] queue_url
|
@@ -622,16 +644,16 @@ module Aws::SQS
|
|
622
644
|
# * `MaximumMessageSize` - Returns the limit of how many bytes a
|
623
645
|
# message can contain before Amazon SQS rejects it.
|
624
646
|
#
|
625
|
-
# * `MessageRetentionPeriod` - Returns the
|
626
|
-
# Amazon SQS retains a message.
|
647
|
+
# * `MessageRetentionPeriod` - Returns the length of time, in seconds,
|
648
|
+
# for which Amazon SQS retains a message.
|
627
649
|
#
|
628
650
|
# * `Policy` - Returns the policy of the queue.
|
629
651
|
#
|
630
652
|
# * `QueueArn` - Returns the Amazon resource name (ARN) of the queue.
|
631
653
|
#
|
632
|
-
# * `ReceiveMessageWaitTimeSeconds` - Returns the
|
633
|
-
# for which the `ReceiveMessage` action waits for a message
|
634
|
-
# arrive.
|
654
|
+
# * `ReceiveMessageWaitTimeSeconds` - Returns the length of time, in
|
655
|
+
# seconds, for which the `ReceiveMessage` action waits for a message
|
656
|
+
# to arrive.
|
635
657
|
#
|
636
658
|
# * `RedrivePolicy` - Returns the parameters for dead letter queue
|
637
659
|
# functionality of the source queue. For more information about the
|
@@ -642,16 +664,31 @@ module Aws::SQS
|
|
642
664
|
# queue. For more information about the visibility timeout, see
|
643
665
|
# [Visibility Timeout][4] in the *Amazon SQS Developer Guide*.
|
644
666
|
#
|
667
|
+
# The following attributes apply only to [server-side-encryption][5]\:
|
668
|
+
#
|
669
|
+
# * `KmsMasterKeyId` - Returns the ID of an AWS-managed customer
|
670
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
671
|
+
# information, see [Key Terms][6].
|
672
|
+
#
|
673
|
+
# * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
|
674
|
+
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
675
|
+
# decrypt messages before calling AWS KMS again.
|
676
|
+
#
|
645
677
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
646
|
-
# queues][
|
678
|
+
# queues][7]\:
|
647
679
|
#
|
648
680
|
# * `FifoQueue` - Returns whether the queue is FIFO. For more
|
649
|
-
# information, see [FIFO Queue Logic][
|
681
|
+
# information, see [FIFO Queue Logic][8] in the *Amazon SQS
|
650
682
|
# Developer Guide*.
|
651
683
|
#
|
684
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
685
|
+
# `QueueName` ends with the `.fifo` suffix.
|
686
|
+
#
|
687
|
+
# </note>
|
688
|
+
#
|
652
689
|
# * `ContentBasedDeduplication` - Returns whether content-based
|
653
690
|
# deduplication is enabled for the queue. For more information, see
|
654
|
-
# [Exactly-Once Processing][
|
691
|
+
# [Exactly-Once Processing][9] in the *Amazon SQS Developer Guide*.
|
655
692
|
#
|
656
693
|
#
|
657
694
|
#
|
@@ -659,9 +696,11 @@ module Aws::SQS
|
|
659
696
|
# [2]: http://en.wikipedia.org/wiki/Unix_time
|
660
697
|
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
661
698
|
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
662
|
-
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
663
|
-
# [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
664
|
-
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
699
|
+
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
700
|
+
# [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
701
|
+
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
702
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
703
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
665
704
|
# @return [Array<String>]
|
666
705
|
#
|
667
706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -836,7 +875,8 @@ module Aws::SQS
|
|
836
875
|
# An MD5 digest of the non-URL-encoded message attribute string. You
|
837
876
|
# can use this attribute to verify that Amazon SQS received the
|
838
877
|
# message correctly. Amazon SQS URL-decodes the message before
|
839
|
-
# creating the MD5 digest. For information
|
878
|
+
# creating the MD5 digest. For information about MD5, see
|
879
|
+
# [RFC1321][1].
|
840
880
|
#
|
841
881
|
#
|
842
882
|
#
|
@@ -868,7 +908,7 @@ module Aws::SQS
|
|
868
908
|
|
869
909
|
# The user-specified message attribute value. For string data types, the
|
870
910
|
# `Value` attribute has the same restrictions on the content as the
|
871
|
-
# message body. For more information, see ` SendMessage
|
911
|
+
# message body. For more information, see ` SendMessage.`
|
872
912
|
#
|
873
913
|
# `Name`, `type`, `value` and the message body must not be empty or
|
874
914
|
# null. All parts of the message attribute, including `Name`, `Type`,
|
@@ -959,7 +999,7 @@ module Aws::SQS
|
|
959
999
|
#
|
960
1000
|
# {
|
961
1001
|
# queue_url: "String", # required
|
962
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication
|
1002
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
963
1003
|
# message_attribute_names: ["MessageAttributeName"],
|
964
1004
|
# max_number_of_messages: 1,
|
965
1005
|
# visibility_timeout: 1,
|
@@ -1287,11 +1327,11 @@ module Aws::SQS
|
|
1287
1327
|
# @return [String]
|
1288
1328
|
#
|
1289
1329
|
# @!attribute [rw] delay_seconds
|
1290
|
-
# The
|
1291
|
-
# values: 0 to 900. Maximum: 15 minutes. Messages with
|
1292
|
-
# `DelaySeconds` value become available for processing
|
1293
|
-
# period is finished. If you don't specify a value,
|
1294
|
-
# for the queue is applied.
|
1330
|
+
# The length of time, in seconds, for which a specific message is
|
1331
|
+
# delayed. Valid values: 0 to 900. Maximum: 15 minutes. Messages with
|
1332
|
+
# a positive `DelaySeconds` value become available for processing
|
1333
|
+
# after the delay period is finished. If you don't specify a value,
|
1334
|
+
# the default value for the queue is applied.
|
1295
1335
|
#
|
1296
1336
|
# <note markdown="1"> When you set `FifoQueue`, you can't set `DelaySeconds` per message.
|
1297
1337
|
# You can set this parameter only on a queue level.
|
@@ -1341,9 +1381,6 @@ module Aws::SQS
|
|
1341
1381
|
# treated as duplicates and only one copy of the message is
|
1342
1382
|
# delivered.
|
1343
1383
|
#
|
1344
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
1345
|
-
# identical content to be treated as duplicates.
|
1346
|
-
#
|
1347
1384
|
# * If you send one message with `ContentBasedDeduplication` enabled
|
1348
1385
|
# and then another message with a `MessageDeduplicationId` that is
|
1349
1386
|
# the same as the one generated for the first
|
@@ -1403,6 +1440,9 @@ module Aws::SQS
|
|
1403
1440
|
# MessageGroupId Property][1] in the *Amazon Simple Queue Service
|
1404
1441
|
# Developer Guide*.
|
1405
1442
|
#
|
1443
|
+
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
1444
|
+
# Standard queues.
|
1445
|
+
#
|
1406
1446
|
#
|
1407
1447
|
#
|
1408
1448
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property
|
@@ -1442,7 +1482,7 @@ module Aws::SQS
|
|
1442
1482
|
end
|
1443
1483
|
|
1444
1484
|
# Encloses a `MessageId` for a successfully-enqueued message in a `
|
1445
|
-
# SendMessageBatch
|
1485
|
+
# SendMessageBatch.`
|
1446
1486
|
#
|
1447
1487
|
# @!attribute [rw] id
|
1448
1488
|
# An identifier for the message in this batch.
|
@@ -1456,7 +1496,8 @@ module Aws::SQS
|
|
1456
1496
|
# An MD5 digest of the non-URL-encoded message attribute string. You
|
1457
1497
|
# can use this attribute to verify that Amazon SQS received the
|
1458
1498
|
# message correctly. Amazon SQS URL-decodes the message before
|
1459
|
-
# creating the MD5 digest. For information
|
1499
|
+
# creating the MD5 digest. For information about MD5, see
|
1500
|
+
# [RFC1321][1].
|
1460
1501
|
#
|
1461
1502
|
#
|
1462
1503
|
#
|
@@ -1467,7 +1508,8 @@ module Aws::SQS
|
|
1467
1508
|
# An MD5 digest of the non-URL-encoded message attribute string. You
|
1468
1509
|
# can use this attribute to verify that Amazon SQS received the
|
1469
1510
|
# message correctly. Amazon SQS URL-decodes the message before
|
1470
|
-
# creating the MD5 digest. For information
|
1511
|
+
# creating the MD5 digest. For information about MD5, see
|
1512
|
+
# [RFC1321][1].
|
1471
1513
|
#
|
1472
1514
|
#
|
1473
1515
|
#
|
@@ -1477,7 +1519,7 @@ module Aws::SQS
|
|
1477
1519
|
# @!attribute [rw] sequence_number
|
1478
1520
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1479
1521
|
#
|
1480
|
-
#
|
1522
|
+
# The large, non-consecutive number that Amazon SQS assigns to each
|
1481
1523
|
# message.
|
1482
1524
|
#
|
1483
1525
|
# The length of `SequenceNumber` is 128 bits. As `SequenceNumber`
|
@@ -1524,35 +1566,26 @@ module Aws::SQS
|
|
1524
1566
|
# @!attribute [rw] message_body
|
1525
1567
|
# The message to send. The maximum string size is 256 KB.
|
1526
1568
|
#
|
1527
|
-
#
|
1528
|
-
#
|
1529
|
-
#
|
1530
|
-
# * `#x9`
|
1531
|
-
#
|
1532
|
-
# * `#xA`
|
1533
|
-
#
|
1534
|
-
# * `#xD`
|
1535
|
-
#
|
1536
|
-
# * `#x20` to `#xD7FF`
|
1537
|
-
#
|
1538
|
-
# * `#xE000` to `#xFFFD`
|
1569
|
+
# A message can include only XML, JSON, and unformatted text. The
|
1570
|
+
# following Unicode characters are allowed:
|
1539
1571
|
#
|
1540
|
-
#
|
1572
|
+
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to
|
1573
|
+
# `#xFFFD` \| `#x10000` to `#x10FFFF`
|
1541
1574
|
#
|
1542
|
-
#
|
1543
|
-
#
|
1575
|
+
# Any characters not included in this list will be rejected. For more
|
1576
|
+
# information, see the [W3C specification for characters][1].
|
1544
1577
|
#
|
1545
1578
|
#
|
1546
1579
|
#
|
1547
|
-
# [1]:
|
1580
|
+
# [1]: http://www.w3.org/TR/REC-xml/#charsets
|
1548
1581
|
# @return [String]
|
1549
1582
|
#
|
1550
1583
|
# @!attribute [rw] delay_seconds
|
1551
|
-
# The
|
1552
|
-
# to 900. Maximum: 15 minutes. Messages with
|
1553
|
-
# value become available for processing
|
1554
|
-
# finished. If you don't specify a value,
|
1555
|
-
# queue applies.
|
1584
|
+
# The length of time, in seconds, for which to delay a specific
|
1585
|
+
# message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with
|
1586
|
+
# a positive `DelaySeconds` value become available for processing
|
1587
|
+
# after the delay period is finished. If you don't specify a value,
|
1588
|
+
# the default value for the queue applies.
|
1556
1589
|
#
|
1557
1590
|
# <note markdown="1"> When you set `FifoQueue`, you can't set `DelaySeconds` per message.
|
1558
1591
|
# You can set this parameter only on a queue level.
|
@@ -1602,9 +1635,6 @@ module Aws::SQS
|
|
1602
1635
|
# treated as duplicates and only one copy of the message is
|
1603
1636
|
# delivered.
|
1604
1637
|
#
|
1605
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
1606
|
-
# identical content to be treated as duplicates.
|
1607
|
-
#
|
1608
1638
|
# * If you send one message with `ContentBasedDeduplication` enabled
|
1609
1639
|
# and then another message with a `MessageDeduplicationId` that is
|
1610
1640
|
# the same as the one generated for the first
|
@@ -1664,6 +1694,9 @@ module Aws::SQS
|
|
1664
1694
|
# MessageGroupId Property][1] in the *Amazon Simple Queue Service
|
1665
1695
|
# Developer Guide*.
|
1666
1696
|
#
|
1697
|
+
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
1698
|
+
# Standard queues.
|
1699
|
+
#
|
1667
1700
|
#
|
1668
1701
|
#
|
1669
1702
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property
|
@@ -1687,7 +1720,8 @@ module Aws::SQS
|
|
1687
1720
|
# An MD5 digest of the non-URL-encoded message attribute string. You
|
1688
1721
|
# can use this attribute to verify that Amazon SQS received the
|
1689
1722
|
# message correctly. Amazon SQS URL-decodes the message before
|
1690
|
-
# creating the MD5 digest. For information
|
1723
|
+
# creating the MD5 digest. For information about MD5, see
|
1724
|
+
# [RFC1321][1].
|
1691
1725
|
#
|
1692
1726
|
#
|
1693
1727
|
#
|
@@ -1698,7 +1732,8 @@ module Aws::SQS
|
|
1698
1732
|
# An MD5 digest of the non-URL-encoded message attribute string. You
|
1699
1733
|
# can use this attribute to verify that Amazon SQS received the
|
1700
1734
|
# message correctly. Amazon SQS URL-decodes the message before
|
1701
|
-
# creating the MD5 digest. For information
|
1735
|
+
# creating the MD5 digest. For information about MD5, see
|
1736
|
+
# [RFC1321][1].
|
1702
1737
|
#
|
1703
1738
|
#
|
1704
1739
|
#
|
@@ -1718,7 +1753,7 @@ module Aws::SQS
|
|
1718
1753
|
# @!attribute [rw] sequence_number
|
1719
1754
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1720
1755
|
#
|
1721
|
-
#
|
1756
|
+
# The large, non-consecutive number that Amazon SQS assigns to each
|
1722
1757
|
# message.
|
1723
1758
|
#
|
1724
1759
|
# The length of `SequenceNumber` is 128 bits. `SequenceNumber`
|
@@ -1758,27 +1793,28 @@ module Aws::SQS
|
|
1758
1793
|
# special request parameters that the `SetQueueAttributes` action
|
1759
1794
|
# uses:
|
1760
1795
|
#
|
1761
|
-
# * `DelaySeconds` - The
|
1762
|
-
# all messages in the queue is delayed. Valid values: An
|
1763
|
-
# from 0 to 900 (15 minutes). The default is 0 (zero).
|
1796
|
+
# * `DelaySeconds` - The length of time, in seconds, for which the
|
1797
|
+
# delivery of all messages in the queue is delayed. Valid values: An
|
1798
|
+
# integer from 0 to 900 (15 minutes). The default is 0 (zero).
|
1764
1799
|
#
|
1765
1800
|
# * `MaximumMessageSize` - The limit of how many bytes a message can
|
1766
1801
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
1767
1802
|
# from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The
|
1768
1803
|
# default is 262,144 (256 KiB).
|
1769
1804
|
#
|
1770
|
-
# * `MessageRetentionPeriod` - The
|
1771
|
-
# SQS retains a message. Valid values: An integer
|
1772
|
-
# seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
1773
|
-
# 345,600 (4 days).
|
1805
|
+
# * `MessageRetentionPeriod` - The length of time, in seconds, for
|
1806
|
+
# which Amazon SQS retains a message. Valid values: An integer
|
1807
|
+
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
1808
|
+
# The default is 345,600 (4 days).
|
1774
1809
|
#
|
1775
1810
|
# * `Policy` - The queue's policy. A valid AWS policy. For more
|
1776
1811
|
# information about policy structure, see [Overview of AWS IAM
|
1777
1812
|
# Policies][1] in the *Amazon IAM User Guide*.
|
1778
1813
|
#
|
1779
|
-
# * `ReceiveMessageWaitTimeSeconds` - The
|
1780
|
-
# a ` ReceiveMessage ` action waits for a message to
|
1781
|
-
# values: an integer from 0 to 20 (seconds). The
|
1814
|
+
# * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
|
1815
|
+
# for which a ` ReceiveMessage ` action waits for a message to
|
1816
|
+
# arrive. Valid values: an integer from 0 to 20 (seconds). The
|
1817
|
+
# default is 0.
|
1782
1818
|
#
|
1783
1819
|
# * `RedrivePolicy` - The parameters for the dead letter queue
|
1784
1820
|
# functionality of the source queue. For more information about the
|
@@ -1796,11 +1832,29 @@ module Aws::SQS
|
|
1796
1832
|
# For more information about the visibility timeout, see [Visibility
|
1797
1833
|
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1798
1834
|
#
|
1835
|
+
# The following attributes apply only to [server-side-encryption][4]\:
|
1836
|
+
#
|
1837
|
+
# * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
|
1838
|
+
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1839
|
+
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
1840
|
+
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
1841
|
+
# example, be `alias/aws/sqs`. For more examples, see [KeyId][6] in
|
1842
|
+
# the *AWS Key Management Service API Reference*.
|
1843
|
+
#
|
1844
|
+
# * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
|
1845
|
+
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
1846
|
+
# decrypt messages before calling AWS KMS again. An integer
|
1847
|
+
# representing seconds, between 60 seconds (1 minute) and 86,400
|
1848
|
+
# seconds (24 hours). The default is 300 (5 minutes). A shorter time
|
1849
|
+
# period provides better security but results in more calls to KMS
|
1850
|
+
# which incur charges after Free Tier. For more information, see
|
1851
|
+
# [How Does the Data Key Reuse Period Work?][8].
|
1852
|
+
#
|
1799
1853
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
1800
|
-
# queues][
|
1854
|
+
# queues][9]\:
|
1801
1855
|
#
|
1802
1856
|
# * `ContentBasedDeduplication` - Enables content-based deduplication.
|
1803
|
-
# For more information, see [Exactly-Once Processing][
|
1857
|
+
# For more information, see [Exactly-Once Processing][10] in the
|
1804
1858
|
# *Amazon SQS Developer Guide*.
|
1805
1859
|
#
|
1806
1860
|
# * Every message must have a unique `MessageDeduplicationId`,
|
@@ -1825,9 +1879,6 @@ module Aws::SQS
|
|
1825
1879
|
# treated as duplicates and only one copy of the message is
|
1826
1880
|
# delivered.
|
1827
1881
|
#
|
1828
|
-
# * You can also use `ContentBasedDeduplication` for messages with
|
1829
|
-
# identical content to be treated as duplicates.
|
1830
|
-
#
|
1831
1882
|
# * If you send one message with `ContentBasedDeduplication` enabled
|
1832
1883
|
# and then another message with a `MessageDeduplicationId` that is
|
1833
1884
|
# the same as the one generated for the first
|
@@ -1854,8 +1905,13 @@ module Aws::SQS
|
|
1854
1905
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
1855
1906
|
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
1856
1907
|
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1857
|
-
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1858
|
-
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1908
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
1909
|
+
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
1910
|
+
# [6]: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
1911
|
+
# [7]: http://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
1912
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
1913
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
1914
|
+
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
1859
1915
|
# @return [Hash<String,String>]
|
1860
1916
|
#
|
1861
1917
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation
|