aws-sdk-sqs 1.45.0 → 1.48.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +109 -159
- data/lib/aws-sdk-sqs/message.rb +2 -1
- data/lib/aws-sdk-sqs/queue.rb +38 -53
- data/lib/aws-sdk-sqs/resource.rb +31 -51
- data/lib/aws-sdk-sqs/types.rb +101 -159
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -34,10 +34,10 @@ module Aws::SQS
|
|
34
34
|
# @return [String]
|
35
35
|
#
|
36
36
|
# @!attribute [rw] aws_account_ids
|
37
|
-
# The account numbers of the [principals][1] who
|
38
|
-
# permission. For information about locating the
|
39
|
-
# identification, see [Your Amazon Web Services
|
40
|
-
# *Amazon SQS Developer Guide*.
|
37
|
+
# The Amazon Web Services account numbers of the [principals][1] who
|
38
|
+
# are to receive permission. For information about locating the Amazon
|
39
|
+
# Web Services account identification, see [Your Amazon Web Services
|
40
|
+
# Identifiers][2] in the *Amazon SQS Developer Guide*.
|
41
41
|
#
|
42
42
|
#
|
43
43
|
#
|
@@ -336,16 +336,11 @@ module Aws::SQS
|
|
336
336
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
337
337
|
# 0.
|
338
338
|
#
|
339
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
340
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
341
|
-
# Default: 30. For more information about the visibility timeout,
|
342
|
-
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
343
|
-
#
|
344
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
345
|
-
#
|
346
339
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
347
340
|
# dead-letter queue functionality of the source queue as a JSON
|
348
|
-
# object.
|
341
|
+
# object. For more information about the redrive policy and
|
342
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
+
# in the *Amazon SQS Developer Guide*.
|
349
344
|
#
|
350
345
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
351
346
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -357,38 +352,16 @@ module Aws::SQS
|
|
357
352
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
358
353
|
# the dead-letter-queue.
|
359
354
|
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
# object. The parameters are as follows:
|
364
|
-
#
|
365
|
-
# * `redrivePermission` – The permission type that defines which
|
366
|
-
# source queues can specify the current queue as the dead-letter
|
367
|
-
# queue. Valid values are:
|
368
|
-
#
|
369
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
370
|
-
# Services account in the same Region can specify this queue as
|
371
|
-
# the dead-letter queue.
|
372
|
-
#
|
373
|
-
# * `denyAll` – No source queues can specify this queue as the
|
374
|
-
# dead-letter queue.
|
375
|
-
#
|
376
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
377
|
-
# parameter can specify this queue as the dead-letter queue.
|
355
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
356
|
+
# Similarly, the dead-letter queue of a standard queue must also be
|
357
|
+
# a standard queue.
|
378
358
|
#
|
379
|
-
#
|
380
|
-
# source queues that can specify this queue as the dead-letter
|
381
|
-
# queue and redrive messages. You can specify this parameter only
|
382
|
-
# when the `redrivePermission` parameter is set to `byQueue`. You
|
383
|
-
# can specify up to 10 source queue ARNs. To allow more than 10
|
384
|
-
# source queues to specify dead-letter queues, set the
|
385
|
-
# `redrivePermission` parameter to `allowAll`.
|
386
|
-
#
|
387
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
388
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
389
|
-
# standard queue.
|
359
|
+
# </note>
|
390
360
|
#
|
391
|
-
#
|
361
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
362
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
363
|
+
# Default: 30. For more information about the visibility timeout,
|
364
|
+
# see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
392
365
|
#
|
393
366
|
# The following attributes apply only to [server-side-encryption][4]\:
|
394
367
|
#
|
@@ -409,8 +382,13 @@ module Aws::SQS
|
|
409
382
|
# charges after Free Tier. For more information, see [How Does the
|
410
383
|
# Data Key Reuse Period Work?][8].
|
411
384
|
#
|
385
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
386
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
387
|
+
# option is supported per queue (e.g. [SSE-KMS][9] or
|
388
|
+
# [SSE-SQS][10]).
|
389
|
+
#
|
412
390
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
413
|
-
# queues][
|
391
|
+
# queues][11]\:
|
414
392
|
#
|
415
393
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
416
394
|
# and `false`. If you don't specify the `FifoQueue` attribute,
|
@@ -419,12 +397,12 @@ module Aws::SQS
|
|
419
397
|
# existing queue. When you set this attribute, you must also provide
|
420
398
|
# the `MessageGroupId` for your messages explicitly.
|
421
399
|
#
|
422
|
-
# For more information, see [FIFO queue logic][
|
400
|
+
# For more information, see [FIFO queue logic][12] in the *Amazon
|
423
401
|
# SQS Developer Guide*.
|
424
402
|
#
|
425
403
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
426
404
|
# Valid values are `true` and `false`. For more information, see
|
427
|
-
# [Exactly-once processing][
|
405
|
+
# [Exactly-once processing][13] in the *Amazon SQS Developer Guide*.
|
428
406
|
# Note the following:
|
429
407
|
#
|
430
408
|
# * Every message must have a unique `MessageDeduplicationId`.
|
@@ -456,7 +434,7 @@ module Aws::SQS
|
|
456
434
|
# duplicates and only one copy of the message is delivered.
|
457
435
|
#
|
458
436
|
# The following attributes apply only to [high throughput for FIFO
|
459
|
-
# queues][
|
437
|
+
# queues][14]\:
|
460
438
|
#
|
461
439
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
462
440
|
# occurs at the message group or queue level. Valid values are
|
@@ -479,23 +457,25 @@ module Aws::SQS
|
|
479
457
|
# deduplication occurs as specified.
|
480
458
|
#
|
481
459
|
# For information on throughput quotas, see [Quotas related to
|
482
|
-
# messages][
|
460
|
+
# messages][15] in the *Amazon SQS Developer Guide*.
|
483
461
|
#
|
484
462
|
#
|
485
463
|
#
|
486
464
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
487
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
488
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
465
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
466
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
489
467
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
490
468
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
491
469
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
492
470
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
493
471
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
494
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
495
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
496
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
497
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
498
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
472
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
473
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
474
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
475
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
476
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
477
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
478
|
+
# [15]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
499
479
|
# @return [Hash<String,String>]
|
500
480
|
#
|
501
481
|
# @!attribute [rw] tags
|
@@ -720,7 +700,7 @@ module Aws::SQS
|
|
720
700
|
#
|
721
701
|
# {
|
722
702
|
# queue_url: "String", # required
|
723
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy
|
703
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
724
704
|
# }
|
725
705
|
#
|
726
706
|
# @!attribute [rw] queue_url
|
@@ -792,15 +772,11 @@ module Aws::SQS
|
|
792
772
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
793
773
|
# to arrive.
|
794
774
|
#
|
795
|
-
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
796
|
-
# queue. For more information about the visibility timeout, see
|
797
|
-
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
798
|
-
#
|
799
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
800
|
-
#
|
801
775
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
802
776
|
# dead-letter queue functionality of the source queue as a JSON
|
803
|
-
# object.
|
777
|
+
# object. For more information about the redrive policy and
|
778
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
779
|
+
# in the *Amazon SQS Developer Guide*.
|
804
780
|
#
|
805
781
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
806
782
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -812,38 +788,9 @@ module Aws::SQS
|
|
812
788
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
813
789
|
# the dead-letter-queue.
|
814
790
|
#
|
815
|
-
# * `
|
816
|
-
#
|
817
|
-
#
|
818
|
-
# object. The parameters are as follows:
|
819
|
-
#
|
820
|
-
# * `redrivePermission` – The permission type that defines which
|
821
|
-
# source queues can specify the current queue as the dead-letter
|
822
|
-
# queue. Valid values are:
|
823
|
-
#
|
824
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
825
|
-
# Services account in the same Region can specify this queue as
|
826
|
-
# the dead-letter queue.
|
827
|
-
#
|
828
|
-
# * `denyAll` – No source queues can specify this queue as the
|
829
|
-
# dead-letter queue.
|
830
|
-
#
|
831
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
832
|
-
# parameter can specify this queue as the dead-letter queue.
|
833
|
-
#
|
834
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
835
|
-
# source queues that can specify this queue as the dead-letter
|
836
|
-
# queue and redrive messages. You can specify this parameter only
|
837
|
-
# when the `redrivePermission` parameter is set to `byQueue`. You
|
838
|
-
# can specify up to 10 source queue ARNs. To allow more than 10
|
839
|
-
# source queues to specify dead-letter queues, set the
|
840
|
-
# `redrivePermission` parameter to `allowAll`.
|
841
|
-
#
|
842
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
843
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
844
|
-
# standard queue.
|
845
|
-
#
|
846
|
-
# </note>
|
791
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
792
|
+
# queue. For more information about the visibility timeout, see
|
793
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
847
794
|
#
|
848
795
|
# The following attributes apply only to [server-side-encryption][4]\:
|
849
796
|
#
|
@@ -856,24 +803,29 @@ module Aws::SQS
|
|
856
803
|
# decrypt messages before calling KMS again. For more information,
|
857
804
|
# see [How Does the Data Key Reuse Period Work?][6].
|
858
805
|
#
|
806
|
+
# * `SqsManagedSseEnabled` – Returns information about whether the
|
807
|
+
# queue is using SSE-SQS encryption using SQS owned encryption keys.
|
808
|
+
# Only one server-side encryption option is supported per queue
|
809
|
+
# (e.g. [SSE-KMS][7] or [SSE-SQS][8]).
|
810
|
+
#
|
859
811
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
860
|
-
# queues][
|
812
|
+
# queues][9]\:
|
861
813
|
#
|
862
814
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
863
|
-
# For more information, see [FIFO queue logic][
|
864
|
-
# Developer Guide*.
|
815
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon
|
816
|
+
# SQS Developer Guide*.
|
865
817
|
#
|
866
|
-
# <note markdown="1"> To determine whether a queue is [FIFO][
|
818
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][9], you can check whether
|
867
819
|
# `QueueName` ends with the `.fifo` suffix.
|
868
820
|
#
|
869
821
|
# </note>
|
870
822
|
#
|
871
823
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
872
824
|
# deduplication is enabled for the queue. For more information, see
|
873
|
-
# [Exactly-once processing][
|
825
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
874
826
|
#
|
875
827
|
# The following attributes apply only to [high throughput for FIFO
|
876
|
-
# queues][
|
828
|
+
# queues][12]\:
|
877
829
|
#
|
878
830
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
879
831
|
# occurs at the message group or queue level. Valid values are
|
@@ -896,21 +848,23 @@ module Aws::SQS
|
|
896
848
|
# deduplication occurs as specified.
|
897
849
|
#
|
898
850
|
# For information on throughput quotas, see [Quotas related to
|
899
|
-
# messages][
|
851
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
900
852
|
#
|
901
853
|
#
|
902
854
|
#
|
903
855
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
904
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
905
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
856
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
857
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
906
858
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
907
859
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
908
860
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
909
|
-
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
910
|
-
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
911
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
912
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
913
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
861
|
+
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
862
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
863
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
864
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
865
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
866
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
867
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
914
868
|
# @return [Array<String>]
|
915
869
|
#
|
916
870
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -953,7 +907,8 @@ module Aws::SQS
|
|
953
907
|
# @return [String]
|
954
908
|
#
|
955
909
|
# @!attribute [rw] queue_owner_aws_account_id
|
956
|
-
# The account ID of the account that created the
|
910
|
+
# The Amazon Web Services account ID of the account that created the
|
911
|
+
# queue.
|
957
912
|
# @return [String]
|
958
913
|
#
|
959
914
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
|
@@ -1159,7 +1114,8 @@ module Aws::SQS
|
|
1159
1114
|
#
|
1160
1115
|
# @!attribute [rw] message_id
|
1161
1116
|
# A unique identifier for the message. A `MessageId`is considered
|
1162
|
-
# unique across all accounts for an extended
|
1117
|
+
# unique across all Amazon Web Services accounts for an extended
|
1118
|
+
# period of time.
|
1163
1119
|
# @return [String]
|
1164
1120
|
#
|
1165
1121
|
# @!attribute [rw] receipt_handle
|
@@ -1449,7 +1405,7 @@ module Aws::SQS
|
|
1449
1405
|
#
|
1450
1406
|
# {
|
1451
1407
|
# queue_url: "String", # required
|
1452
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy
|
1408
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
1453
1409
|
# message_attribute_names: ["MessageAttributeName"],
|
1454
1410
|
# max_number_of_messages: 1,
|
1455
1411
|
# visibility_timeout: 1,
|
@@ -1489,6 +1445,10 @@ module Aws::SQS
|
|
1489
1445
|
# * `SentTimestamp` – Returns the time the message was sent to the
|
1490
1446
|
# queue ([epoch time][1] in milliseconds).
|
1491
1447
|
#
|
1448
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1449
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
1450
|
+
# option is supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
|
1451
|
+
#
|
1492
1452
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1493
1453
|
# producer that calls the ` SendMessage ` action.
|
1494
1454
|
#
|
@@ -1501,6 +1461,8 @@ module Aws::SQS
|
|
1501
1461
|
#
|
1502
1462
|
#
|
1503
1463
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1464
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1465
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1504
1466
|
# @return [Array<String>]
|
1505
1467
|
#
|
1506
1468
|
# @!attribute [rw] message_attribute_names
|
@@ -2339,16 +2301,11 @@ module Aws::SQS
|
|
2339
2301
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2340
2302
|
# 0.
|
2341
2303
|
#
|
2342
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2343
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2344
|
-
# Default: 30. For more information about the visibility timeout,
|
2345
|
-
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2346
|
-
#
|
2347
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
2348
|
-
#
|
2349
2304
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2350
2305
|
# dead-letter queue functionality of the source queue as a JSON
|
2351
|
-
# object.
|
2306
|
+
# object. For more information about the redrive policy and
|
2307
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2308
|
+
# in the *Amazon SQS Developer Guide*.
|
2352
2309
|
#
|
2353
2310
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2354
2311
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2360,38 +2317,16 @@ module Aws::SQS
|
|
2360
2317
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2361
2318
|
# the dead-letter-queue.
|
2362
2319
|
#
|
2363
|
-
#
|
2364
|
-
#
|
2365
|
-
#
|
2366
|
-
# object. The parameters are as follows:
|
2367
|
-
#
|
2368
|
-
# * `redrivePermission` – The permission type that defines which
|
2369
|
-
# source queues can specify the current queue as the dead-letter
|
2370
|
-
# queue. Valid values are:
|
2371
|
-
#
|
2372
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2373
|
-
# Services account in the same Region can specify this queue as
|
2374
|
-
# the dead-letter queue.
|
2320
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2321
|
+
# Similarly, the dead-letter queue of a standard queue must also be
|
2322
|
+
# a standard queue.
|
2375
2323
|
#
|
2376
|
-
#
|
2377
|
-
# dead-letter queue.
|
2378
|
-
#
|
2379
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2380
|
-
# parameter can specify this queue as the dead-letter queue.
|
2381
|
-
#
|
2382
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2383
|
-
# source queues that can specify this queue as the dead-letter
|
2384
|
-
# queue and redrive messages. You can specify this parameter only
|
2385
|
-
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2386
|
-
# can specify up to 10 source queue ARNs. To allow more than 10
|
2387
|
-
# source queues to specify dead-letter queues, set the
|
2388
|
-
# `redrivePermission` parameter to `allowAll`.
|
2389
|
-
#
|
2390
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2391
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
2392
|
-
# standard queue.
|
2324
|
+
# </note>
|
2393
2325
|
#
|
2394
|
-
#
|
2326
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2327
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2328
|
+
# Default: 30. For more information about the visibility timeout,
|
2329
|
+
# see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2395
2330
|
#
|
2396
2331
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2397
2332
|
#
|
@@ -2412,11 +2347,16 @@ module Aws::SQS
|
|
2412
2347
|
# charges after Free Tier. For more information, see [How Does the
|
2413
2348
|
# Data Key Reuse Period Work?][8].
|
2414
2349
|
#
|
2350
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
2351
|
+
# using SQS owned encryption keys. Only one server-side encryption
|
2352
|
+
# option is supported per queue (e.g. [SSE-KMS][9] or
|
2353
|
+
# [SSE-SQS][10]).
|
2354
|
+
#
|
2415
2355
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2416
|
-
# queues][
|
2356
|
+
# queues][11]\:
|
2417
2357
|
#
|
2418
2358
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2419
|
-
# For more information, see [Exactly-once processing][
|
2359
|
+
# For more information, see [Exactly-once processing][12] in the
|
2420
2360
|
# *Amazon SQS Developer Guide*. Note the following:
|
2421
2361
|
#
|
2422
2362
|
# * Every message must have a unique `MessageDeduplicationId`.
|
@@ -2448,7 +2388,7 @@ module Aws::SQS
|
|
2448
2388
|
# duplicates and only one copy of the message is delivered.
|
2449
2389
|
#
|
2450
2390
|
# The following attributes apply only to [high throughput for FIFO
|
2451
|
-
# queues][
|
2391
|
+
# queues][13]\:
|
2452
2392
|
#
|
2453
2393
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2454
2394
|
# occurs at the message group or queue level. Valid values are
|
@@ -2471,22 +2411,24 @@ module Aws::SQS
|
|
2471
2411
|
# deduplication occurs as specified.
|
2472
2412
|
#
|
2473
2413
|
# For information on throughput quotas, see [Quotas related to
|
2474
|
-
# messages][
|
2414
|
+
# messages][14] in the *Amazon SQS Developer Guide*.
|
2475
2415
|
#
|
2476
2416
|
#
|
2477
2417
|
#
|
2478
2418
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2479
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2480
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2419
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2420
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2481
2421
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2482
2422
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2483
2423
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
2484
2424
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
2485
2425
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2486
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2487
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2488
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2489
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2426
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
2427
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
2428
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2429
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
2430
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2431
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2490
2432
|
# @return [Hash<String,String>]
|
2491
2433
|
#
|
2492
2434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation
|
data/lib/aws-sdk-sqs.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-sqs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.48.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-11-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.122.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.122.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|