aws-sdk-sqs 1.54.0 → 1.56.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +145 -231
- data/lib/aws-sdk-sqs/client_api.rb +51 -219
- data/lib/aws-sdk-sqs/errors.rb +0 -246
- data/lib/aws-sdk-sqs/message.rb +9 -3
- data/lib/aws-sdk-sqs/queue.rb +59 -69
- data/lib/aws-sdk-sqs/resource.rb +33 -61
- data/lib/aws-sdk-sqs/types.rb +83 -443
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -67,29 +67,15 @@ module Aws::SQS
|
|
67
67
|
|
68
68
|
# Two or more batch entries in the request have the same `Id`.
|
69
69
|
#
|
70
|
-
# @!attribute [rw] message
|
71
|
-
# @return [String]
|
72
|
-
#
|
73
70
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchEntryIdsNotDistinct AWS API Documentation
|
74
71
|
#
|
75
|
-
class BatchEntryIdsNotDistinct <
|
76
|
-
:message)
|
77
|
-
SENSITIVE = []
|
78
|
-
include Aws::Structure
|
79
|
-
end
|
72
|
+
class BatchEntryIdsNotDistinct < Aws::EmptyStructure; end
|
80
73
|
|
81
74
|
# The length of all the messages put together is more than the limit.
|
82
75
|
#
|
83
|
-
# @!attribute [rw] message
|
84
|
-
# @return [String]
|
85
|
-
#
|
86
76
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchRequestTooLong AWS API Documentation
|
87
77
|
#
|
88
|
-
class BatchRequestTooLong <
|
89
|
-
:message)
|
90
|
-
SENSITIVE = []
|
91
|
-
include Aws::Structure
|
92
|
-
end
|
78
|
+
class BatchRequestTooLong < Aws::EmptyStructure; end
|
93
79
|
|
94
80
|
# Gives a detailed description of the result of an action on each entry
|
95
81
|
# in the request.
|
@@ -146,6 +132,17 @@ module Aws::SQS
|
|
146
132
|
# Encloses a receipt handle and an entry id for each message in `
|
147
133
|
# ChangeMessageVisibilityBatch.`
|
148
134
|
#
|
135
|
+
# All of the following list parameters must be prefixed with
|
136
|
+
# `ChangeMessageVisibilityBatchRequestEntry.n`, where `n` is an integer
|
137
|
+
# value starting with `1`. For example, a parameter list for this action
|
138
|
+
# might look like this:
|
139
|
+
#
|
140
|
+
# `&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
|
141
|
+
#
|
142
|
+
# `&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle`
|
143
|
+
#
|
144
|
+
# `&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
|
145
|
+
#
|
149
146
|
# @!attribute [rw] id
|
150
147
|
# An identifier for this particular receipt handle used to communicate
|
151
148
|
# the result.
|
@@ -272,33 +269,23 @@ module Aws::SQS
|
|
272
269
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
273
270
|
# which Amazon SQS retains a message. Valid values: An integer from
|
274
271
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
275
|
-
# 345,600 (4 days).
|
276
|
-
# change can take up to 60 seconds for most of the attributes to
|
277
|
-
# propagate throughout the Amazon SQS system. Changes made to the
|
278
|
-
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
279
|
-
# will impact existing messages in the queue potentially causing
|
280
|
-
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
281
|
-
# reduced below the age of existing messages.
|
272
|
+
# 345,600 (4 days).
|
282
273
|
#
|
283
274
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
284
275
|
# policy. For more information about policy structure, see [Overview
|
285
|
-
# of Amazon Web Services IAM Policies][1] in the *IAM User
|
276
|
+
# of Amazon Web Services IAM Policies][1] in the *Amazon IAM User
|
277
|
+
# Guide*.
|
286
278
|
#
|
287
279
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
288
280
|
# for which a ` ReceiveMessage ` action waits for a message to
|
289
281
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
290
282
|
# 0.
|
291
283
|
#
|
292
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
293
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
294
|
-
# Default: 30. For more information about the visibility timeout,
|
295
|
-
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
296
|
-
#
|
297
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
298
|
-
#
|
299
284
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
300
285
|
# dead-letter queue functionality of the source queue as a JSON
|
301
|
-
# object.
|
286
|
+
# object. For more information about the redrive policy and
|
287
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
288
|
+
# in the *Amazon SQS Developer Guide*.
|
302
289
|
#
|
303
290
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
304
291
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -306,42 +293,20 @@ module Aws::SQS
|
|
306
293
|
#
|
307
294
|
# * `maxReceiveCount` – The number of times a message is delivered
|
308
295
|
# to the source queue before being moved to the dead-letter queue.
|
309
|
-
#
|
296
|
+
# When the `ReceiveCount` for a message exceeds the
|
310
297
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
311
298
|
# the dead-letter-queue.
|
312
299
|
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
316
|
-
# object. The parameters are as follows:
|
317
|
-
#
|
318
|
-
# * `redrivePermission` – The permission type that defines which
|
319
|
-
# source queues can specify the current queue as the dead-letter
|
320
|
-
# queue. Valid values are:
|
321
|
-
#
|
322
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
323
|
-
# Services account in the same Region can specify this queue as
|
324
|
-
# the dead-letter queue.
|
300
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
301
|
+
# Similarly, the dead-letter queue of a standard queue must also be
|
302
|
+
# a standard queue.
|
325
303
|
#
|
326
|
-
#
|
327
|
-
# dead-letter queue.
|
328
|
-
#
|
329
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
330
|
-
# parameter can specify this queue as the dead-letter queue.
|
331
|
-
#
|
332
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
333
|
-
# source queues that can specify this queue as the dead-letter
|
334
|
-
# queue and redrive messages. You can specify this parameter only
|
335
|
-
# when the `redrivePermission` parameter is set to `byQueue`. You
|
336
|
-
# can specify up to 10 source queue ARNs. To allow more than 10
|
337
|
-
# source queues to specify dead-letter queues, set the
|
338
|
-
# `redrivePermission` parameter to `allowAll`.
|
339
|
-
#
|
340
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
341
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
342
|
-
# standard queue.
|
304
|
+
# </note>
|
343
305
|
#
|
344
|
-
#
|
306
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
307
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
308
|
+
# Default: 30. For more information about the visibility timeout,
|
309
|
+
# see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
345
310
|
#
|
346
311
|
# The following attributes apply only to [server-side-encryption][4]:
|
347
312
|
#
|
@@ -360,11 +325,11 @@ module Aws::SQS
|
|
360
325
|
# hours). Default: 300 (5 minutes). A shorter time period provides
|
361
326
|
# better security but results in more calls to KMS which might incur
|
362
327
|
# charges after Free Tier. For more information, see [How Does the
|
363
|
-
# Data Key Reuse Period Work?][8]
|
328
|
+
# Data Key Reuse Period Work?][8].
|
364
329
|
#
|
365
330
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
366
331
|
# using SQS owned encryption keys. Only one server-side encryption
|
367
|
-
# option is supported per queue (
|
332
|
+
# option is supported per queue (e.g. [SSE-KMS][9] or
|
368
333
|
# [SSE-SQS][10]).
|
369
334
|
#
|
370
335
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
@@ -442,8 +407,8 @@ module Aws::SQS
|
|
442
407
|
#
|
443
408
|
#
|
444
409
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
445
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
446
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
410
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
411
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
447
412
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
448
413
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
449
414
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -483,7 +448,7 @@ module Aws::SQS
|
|
483
448
|
#
|
484
449
|
# Cross-account permissions don't apply to this action. For more
|
485
450
|
# information, see [Grant cross-account permissions to a role and a
|
486
|
-
#
|
451
|
+
# user name][3] in the *Amazon SQS Developer Guide*.
|
487
452
|
#
|
488
453
|
# </note>
|
489
454
|
#
|
@@ -635,16 +600,9 @@ module Aws::SQS
|
|
635
600
|
|
636
601
|
# The batch request doesn't contain any entries.
|
637
602
|
#
|
638
|
-
# @!attribute [rw] message
|
639
|
-
# @return [String]
|
640
|
-
#
|
641
603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/EmptyBatchRequest AWS API Documentation
|
642
604
|
#
|
643
|
-
class EmptyBatchRequest <
|
644
|
-
:message)
|
645
|
-
SENSITIVE = []
|
646
|
-
include Aws::Structure
|
647
|
-
end
|
605
|
+
class EmptyBatchRequest < Aws::EmptyStructure; end
|
648
606
|
|
649
607
|
# @!attribute [rw] queue_url
|
650
608
|
# The URL of the Amazon SQS queue whose attribute information is
|
@@ -656,7 +614,7 @@ module Aws::SQS
|
|
656
614
|
# @!attribute [rw] attribute_names
|
657
615
|
# A list of attributes for which to retrieve information.
|
658
616
|
#
|
659
|
-
# The `
|
617
|
+
# The `AttributeName.N` parameter is optional, but if you don't
|
660
618
|
# specify values for this parameter, the request returns empty
|
661
619
|
# results.
|
662
620
|
#
|
@@ -670,10 +628,10 @@ module Aws::SQS
|
|
670
628
|
#
|
671
629
|
# The `ApproximateNumberOfMessagesDelayed`,
|
672
630
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
673
|
-
# `
|
674
|
-
# until at least 1 minute after the producers stop sending
|
675
|
-
# This period is required for the queue metadata to reach
|
676
|
-
# consistency.
|
631
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
632
|
+
# consistency until at least 1 minute after the producers stop sending
|
633
|
+
# messages. This period is required for the queue metadata to reach
|
634
|
+
# eventual consistency.
|
677
635
|
#
|
678
636
|
# * `All` – Returns all values.
|
679
637
|
#
|
@@ -705,14 +663,7 @@ module Aws::SQS
|
|
705
663
|
# message can contain before Amazon SQS rejects it.
|
706
664
|
#
|
707
665
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
708
|
-
# for which Amazon SQS retains a message.
|
709
|
-
# attributes, the change can take up to 60 seconds for most of the
|
710
|
-
# attributes to propagate throughout the Amazon SQS system. Changes
|
711
|
-
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
712
|
-
# minutes and will impact existing messages in the queue potentially
|
713
|
-
# causing them to be expired and deleted if the
|
714
|
-
# `MessageRetentionPeriod` is reduced below the age of existing
|
715
|
-
# messages.
|
666
|
+
# for which Amazon SQS retains a message.
|
716
667
|
#
|
717
668
|
# * `Policy` – Returns the policy of the queue.
|
718
669
|
#
|
@@ -722,15 +673,11 @@ module Aws::SQS
|
|
722
673
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
723
674
|
# to arrive.
|
724
675
|
#
|
725
|
-
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
726
|
-
# queue. For more information about the visibility timeout, see
|
727
|
-
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
728
|
-
#
|
729
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
730
|
-
#
|
731
676
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
732
677
|
# dead-letter queue functionality of the source queue as a JSON
|
733
|
-
# object.
|
678
|
+
# object. For more information about the redrive policy and
|
679
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
680
|
+
# in the *Amazon SQS Developer Guide*.
|
734
681
|
#
|
735
682
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
736
683
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -738,42 +685,13 @@ module Aws::SQS
|
|
738
685
|
#
|
739
686
|
# * `maxReceiveCount` – The number of times a message is delivered
|
740
687
|
# to the source queue before being moved to the dead-letter queue.
|
741
|
-
#
|
688
|
+
# When the `ReceiveCount` for a message exceeds the
|
742
689
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
743
690
|
# the dead-letter-queue.
|
744
691
|
#
|
745
|
-
# * `
|
746
|
-
#
|
747
|
-
#
|
748
|
-
# object. The parameters are as follows:
|
749
|
-
#
|
750
|
-
# * `redrivePermission` – The permission type that defines which
|
751
|
-
# source queues can specify the current queue as the dead-letter
|
752
|
-
# queue. Valid values are:
|
753
|
-
#
|
754
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
755
|
-
# Services account in the same Region can specify this queue as
|
756
|
-
# the dead-letter queue.
|
757
|
-
#
|
758
|
-
# * `denyAll` – No source queues can specify this queue as the
|
759
|
-
# dead-letter queue.
|
760
|
-
#
|
761
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
762
|
-
# parameter can specify this queue as the dead-letter queue.
|
763
|
-
#
|
764
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
765
|
-
# source queues that can specify this queue as the dead-letter
|
766
|
-
# queue and redrive messages. You can specify this parameter only
|
767
|
-
# when the `redrivePermission` parameter is set to `byQueue`. You
|
768
|
-
# can specify up to 10 source queue ARNs. To allow more than 10
|
769
|
-
# source queues to specify dead-letter queues, set the
|
770
|
-
# `redrivePermission` parameter to `allowAll`.
|
771
|
-
#
|
772
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
773
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
774
|
-
# standard queue.
|
775
|
-
#
|
776
|
-
# </note>
|
692
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
693
|
+
# queue. For more information about the visibility timeout, see
|
694
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
777
695
|
#
|
778
696
|
# The following attributes apply only to [server-side-encryption][4]:
|
779
697
|
#
|
@@ -788,8 +706,8 @@ module Aws::SQS
|
|
788
706
|
#
|
789
707
|
# * `SqsManagedSseEnabled` – Returns information about whether the
|
790
708
|
# queue is using SSE-SQS encryption using SQS owned encryption keys.
|
791
|
-
# Only one server-side encryption option is supported per queue
|
792
|
-
#
|
709
|
+
# Only one server-side encryption option is supported per queue
|
710
|
+
# (e.g. [SSE-KMS][7] or [SSE-SQS][8]).
|
793
711
|
#
|
794
712
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
795
713
|
# queues][9]:
|
@@ -836,8 +754,8 @@ module Aws::SQS
|
|
836
754
|
#
|
837
755
|
#
|
838
756
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
839
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
840
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
757
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
758
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
841
759
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
842
760
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
843
761
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -914,58 +832,18 @@ module Aws::SQS
|
|
914
832
|
include Aws::Structure
|
915
833
|
end
|
916
834
|
|
917
|
-
# The `accountId` is invalid.
|
918
|
-
#
|
919
|
-
# @!attribute [rw] message
|
920
|
-
# @return [String]
|
921
|
-
#
|
922
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAddress AWS API Documentation
|
923
|
-
#
|
924
|
-
class InvalidAddress < Struct.new(
|
925
|
-
:message)
|
926
|
-
SENSITIVE = []
|
927
|
-
include Aws::Structure
|
928
|
-
end
|
929
|
-
|
930
835
|
# The specified attribute doesn't exist.
|
931
836
|
#
|
932
|
-
# @!attribute [rw] message
|
933
|
-
# @return [String]
|
934
|
-
#
|
935
837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeName AWS API Documentation
|
936
838
|
#
|
937
|
-
class InvalidAttributeName <
|
938
|
-
:message)
|
939
|
-
SENSITIVE = []
|
940
|
-
include Aws::Structure
|
941
|
-
end
|
942
|
-
|
943
|
-
# A queue attribute value is invalid.
|
944
|
-
#
|
945
|
-
# @!attribute [rw] message
|
946
|
-
# @return [String]
|
947
|
-
#
|
948
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeValue AWS API Documentation
|
949
|
-
#
|
950
|
-
class InvalidAttributeValue < Struct.new(
|
951
|
-
:message)
|
952
|
-
SENSITIVE = []
|
953
|
-
include Aws::Structure
|
954
|
-
end
|
839
|
+
class InvalidAttributeName < Aws::EmptyStructure; end
|
955
840
|
|
956
841
|
# The `Id` of a batch entry in a batch request doesn't abide by the
|
957
842
|
# specification.
|
958
843
|
#
|
959
|
-
# @!attribute [rw] message
|
960
|
-
# @return [String]
|
961
|
-
#
|
962
844
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidBatchEntryId AWS API Documentation
|
963
845
|
#
|
964
|
-
class InvalidBatchEntryId <
|
965
|
-
:message)
|
966
|
-
SENSITIVE = []
|
967
|
-
include Aws::Structure
|
968
|
-
end
|
846
|
+
class InvalidBatchEntryId < Aws::EmptyStructure; end
|
969
847
|
|
970
848
|
# The specified receipt handle isn't valid for the current version.
|
971
849
|
#
|
@@ -975,131 +853,9 @@ module Aws::SQS
|
|
975
853
|
|
976
854
|
# The message contains characters outside the allowed set.
|
977
855
|
#
|
978
|
-
# @!attribute [rw] message
|
979
|
-
# @return [String]
|
980
|
-
#
|
981
856
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidMessageContents AWS API Documentation
|
982
857
|
#
|
983
|
-
class InvalidMessageContents <
|
984
|
-
:message)
|
985
|
-
SENSITIVE = []
|
986
|
-
include Aws::Structure
|
987
|
-
end
|
988
|
-
|
989
|
-
# When the request to a queue is not HTTPS and SigV4.
|
990
|
-
#
|
991
|
-
# @!attribute [rw] message
|
992
|
-
# @return [String]
|
993
|
-
#
|
994
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidSecurity AWS API Documentation
|
995
|
-
#
|
996
|
-
class InvalidSecurity < Struct.new(
|
997
|
-
:message)
|
998
|
-
SENSITIVE = []
|
999
|
-
include Aws::Structure
|
1000
|
-
end
|
1001
|
-
|
1002
|
-
# The caller doesn't have the required KMS access.
|
1003
|
-
#
|
1004
|
-
# @!attribute [rw] message
|
1005
|
-
# @return [String]
|
1006
|
-
#
|
1007
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsAccessDenied AWS API Documentation
|
1008
|
-
#
|
1009
|
-
class KmsAccessDenied < Struct.new(
|
1010
|
-
:message)
|
1011
|
-
SENSITIVE = []
|
1012
|
-
include Aws::Structure
|
1013
|
-
end
|
1014
|
-
|
1015
|
-
# The request was denied due to request throttling.
|
1016
|
-
#
|
1017
|
-
# @!attribute [rw] message
|
1018
|
-
# @return [String]
|
1019
|
-
#
|
1020
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsDisabled AWS API Documentation
|
1021
|
-
#
|
1022
|
-
class KmsDisabled < Struct.new(
|
1023
|
-
:message)
|
1024
|
-
SENSITIVE = []
|
1025
|
-
include Aws::Structure
|
1026
|
-
end
|
1027
|
-
|
1028
|
-
# The request was rejected for one of the following reasons:
|
1029
|
-
#
|
1030
|
-
# * The KeyUsage value of the KMS key is incompatible with the API
|
1031
|
-
# operation.
|
1032
|
-
#
|
1033
|
-
# * The encryption algorithm or signing algorithm specified for the
|
1034
|
-
# operation is incompatible with the type of key material in the KMS
|
1035
|
-
# key (KeySpec).
|
1036
|
-
#
|
1037
|
-
# @!attribute [rw] message
|
1038
|
-
# @return [String]
|
1039
|
-
#
|
1040
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsInvalidKeyUsage AWS API Documentation
|
1041
|
-
#
|
1042
|
-
class KmsInvalidKeyUsage < Struct.new(
|
1043
|
-
:message)
|
1044
|
-
SENSITIVE = []
|
1045
|
-
include Aws::Structure
|
1046
|
-
end
|
1047
|
-
|
1048
|
-
# The request was rejected because the state of the specified resource
|
1049
|
-
# is not valid for this request.
|
1050
|
-
#
|
1051
|
-
# @!attribute [rw] message
|
1052
|
-
# @return [String]
|
1053
|
-
#
|
1054
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsInvalidState AWS API Documentation
|
1055
|
-
#
|
1056
|
-
class KmsInvalidState < Struct.new(
|
1057
|
-
:message)
|
1058
|
-
SENSITIVE = []
|
1059
|
-
include Aws::Structure
|
1060
|
-
end
|
1061
|
-
|
1062
|
-
# The request was rejected because the specified entity or resource
|
1063
|
-
# could not be found.
|
1064
|
-
#
|
1065
|
-
# @!attribute [rw] message
|
1066
|
-
# @return [String]
|
1067
|
-
#
|
1068
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsNotFound AWS API Documentation
|
1069
|
-
#
|
1070
|
-
class KmsNotFound < Struct.new(
|
1071
|
-
:message)
|
1072
|
-
SENSITIVE = []
|
1073
|
-
include Aws::Structure
|
1074
|
-
end
|
1075
|
-
|
1076
|
-
# The request was rejected because the specified key policy isn't
|
1077
|
-
# syntactically or semantically correct.
|
1078
|
-
#
|
1079
|
-
# @!attribute [rw] message
|
1080
|
-
# @return [String]
|
1081
|
-
#
|
1082
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsOptInRequired AWS API Documentation
|
1083
|
-
#
|
1084
|
-
class KmsOptInRequired < Struct.new(
|
1085
|
-
:message)
|
1086
|
-
SENSITIVE = []
|
1087
|
-
include Aws::Structure
|
1088
|
-
end
|
1089
|
-
|
1090
|
-
# Amazon Web Services KMS throttles requests for the following
|
1091
|
-
# conditions.
|
1092
|
-
#
|
1093
|
-
# @!attribute [rw] message
|
1094
|
-
# @return [String]
|
1095
|
-
#
|
1096
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/KmsThrottled AWS API Documentation
|
1097
|
-
#
|
1098
|
-
class KmsThrottled < Struct.new(
|
1099
|
-
:message)
|
1100
|
-
SENSITIVE = []
|
1101
|
-
include Aws::Structure
|
1102
|
-
end
|
858
|
+
class InvalidMessageContents < Aws::EmptyStructure; end
|
1103
859
|
|
1104
860
|
# @!attribute [rw] queue_url
|
1105
861
|
# The URL of a dead-letter queue.
|
@@ -1314,7 +1070,7 @@ module Aws::SQS
|
|
1314
1070
|
#
|
1315
1071
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1316
1072
|
# null. All parts of the message attribute, including `Name`, `Type`,
|
1317
|
-
# and `Value`, are part of the message size restriction (256
|
1073
|
+
# and `Value`, are part of the message size restriction (256 KB or
|
1318
1074
|
# 262,144 bytes).
|
1319
1075
|
#
|
1320
1076
|
# @!attribute [rw] string_value
|
@@ -1425,35 +1181,21 @@ module Aws::SQS
|
|
1425
1181
|
end
|
1426
1182
|
|
1427
1183
|
# The specified action violates a limit. For example, `ReceiveMessage`
|
1428
|
-
# returns this error if the maximum number of
|
1184
|
+
# returns this error if the maximum number of inflight messages is
|
1429
1185
|
# reached and `AddPermission` returns this error if the maximum number
|
1430
1186
|
# of permissions for the queue is reached.
|
1431
1187
|
#
|
1432
|
-
# @!attribute [rw] message
|
1433
|
-
# @return [String]
|
1434
|
-
#
|
1435
1188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/OverLimit AWS API Documentation
|
1436
1189
|
#
|
1437
|
-
class OverLimit <
|
1438
|
-
:message)
|
1439
|
-
SENSITIVE = []
|
1440
|
-
include Aws::Structure
|
1441
|
-
end
|
1190
|
+
class OverLimit < Aws::EmptyStructure; end
|
1442
1191
|
|
1443
1192
|
# Indicates that the specified queue previously received a `PurgeQueue`
|
1444
1193
|
# request within the last 60 seconds (the time it can take to delete the
|
1445
1194
|
# messages in the queue).
|
1446
1195
|
#
|
1447
|
-
# @!attribute [rw] message
|
1448
|
-
# @return [String]
|
1449
|
-
#
|
1450
1196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueInProgress AWS API Documentation
|
1451
1197
|
#
|
1452
|
-
class PurgeQueueInProgress <
|
1453
|
-
:message)
|
1454
|
-
SENSITIVE = []
|
1455
|
-
include Aws::Structure
|
1456
|
-
end
|
1198
|
+
class PurgeQueueInProgress < Aws::EmptyStructure; end
|
1457
1199
|
|
1458
1200
|
# @!attribute [rw] queue_url
|
1459
1201
|
# The URL of the queue from which the `PurgeQueue` action deletes
|
@@ -1473,57 +1215,29 @@ module Aws::SQS
|
|
1473
1215
|
# You must wait 60 seconds after deleting a queue before you can create
|
1474
1216
|
# another queue with the same name.
|
1475
1217
|
#
|
1476
|
-
# @!attribute [rw] message
|
1477
|
-
# @return [String]
|
1478
|
-
#
|
1479
1218
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDeletedRecently AWS API Documentation
|
1480
1219
|
#
|
1481
|
-
class QueueDeletedRecently <
|
1482
|
-
:message)
|
1483
|
-
SENSITIVE = []
|
1484
|
-
include Aws::Structure
|
1485
|
-
end
|
1220
|
+
class QueueDeletedRecently < Aws::EmptyStructure; end
|
1486
1221
|
|
1487
1222
|
# The specified queue doesn't exist.
|
1488
1223
|
#
|
1489
|
-
# @!attribute [rw] message
|
1490
|
-
# @return [String]
|
1491
|
-
#
|
1492
1224
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDoesNotExist AWS API Documentation
|
1493
1225
|
#
|
1494
|
-
class QueueDoesNotExist <
|
1495
|
-
:message)
|
1496
|
-
SENSITIVE = []
|
1497
|
-
include Aws::Structure
|
1498
|
-
end
|
1226
|
+
class QueueDoesNotExist < Aws::EmptyStructure; end
|
1499
1227
|
|
1500
1228
|
# A queue with this name already exists. Amazon SQS returns this error
|
1501
1229
|
# only if the request includes attributes whose values differ from those
|
1502
1230
|
# of the existing queue.
|
1503
1231
|
#
|
1504
|
-
# @!attribute [rw] message
|
1505
|
-
# @return [String]
|
1506
|
-
#
|
1507
1232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueNameExists AWS API Documentation
|
1508
1233
|
#
|
1509
|
-
class QueueNameExists <
|
1510
|
-
:message)
|
1511
|
-
SENSITIVE = []
|
1512
|
-
include Aws::Structure
|
1513
|
-
end
|
1234
|
+
class QueueNameExists < Aws::EmptyStructure; end
|
1514
1235
|
|
1515
1236
|
# The specified receipt handle isn't valid.
|
1516
1237
|
#
|
1517
|
-
# @!attribute [rw] message
|
1518
|
-
# @return [String]
|
1519
|
-
#
|
1520
1238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiptHandleIsInvalid AWS API Documentation
|
1521
1239
|
#
|
1522
|
-
class ReceiptHandleIsInvalid <
|
1523
|
-
:message)
|
1524
|
-
SENSITIVE = []
|
1525
|
-
include Aws::Structure
|
1526
|
-
end
|
1240
|
+
class ReceiptHandleIsInvalid < Aws::EmptyStructure; end
|
1527
1241
|
|
1528
1242
|
# @!attribute [rw] queue_url
|
1529
1243
|
# The URL of the Amazon SQS queue from which messages are received.
|
@@ -1548,7 +1262,7 @@ module Aws::SQS
|
|
1548
1262
|
#
|
1549
1263
|
# * `SenderId`
|
1550
1264
|
#
|
1551
|
-
# * For
|
1265
|
+
# * For an IAM user, returns the IAM user ID, for example
|
1552
1266
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1553
1267
|
#
|
1554
1268
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1559,8 +1273,7 @@ module Aws::SQS
|
|
1559
1273
|
#
|
1560
1274
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1561
1275
|
# using SQS owned encryption keys. Only one server-side encryption
|
1562
|
-
# option is supported per queue (
|
1563
|
-
# [SSE-SQS][3]).
|
1276
|
+
# option is supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
|
1564
1277
|
#
|
1565
1278
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1566
1279
|
# producer that calls the ` SendMessage ` action.
|
@@ -1749,32 +1462,6 @@ module Aws::SQS
|
|
1749
1462
|
include Aws::Structure
|
1750
1463
|
end
|
1751
1464
|
|
1752
|
-
# The request was denied due to request throttling.
|
1753
|
-
#
|
1754
|
-
# * The rate of requests per second exceeds the AWS KMS request quota
|
1755
|
-
# for an account and Region.
|
1756
|
-
#
|
1757
|
-
# * A burst or sustained high rate of requests to change the state of
|
1758
|
-
# the same KMS key. This condition is often known as a "hot key."
|
1759
|
-
#
|
1760
|
-
# * Requests for operations on KMS keys in a Amazon Web Services
|
1761
|
-
# CloudHSM key store might be throttled at a lower-than-expected rate
|
1762
|
-
# when the Amazon Web Services CloudHSM cluster associated with the
|
1763
|
-
# Amazon Web Services CloudHSM key store is processing numerous
|
1764
|
-
# commands, including those unrelated to the Amazon Web Services
|
1765
|
-
# CloudHSM key store.
|
1766
|
-
#
|
1767
|
-
# @!attribute [rw] message
|
1768
|
-
# @return [String]
|
1769
|
-
#
|
1770
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/RequestThrottled AWS API Documentation
|
1771
|
-
#
|
1772
|
-
class RequestThrottled < Struct.new(
|
1773
|
-
:message)
|
1774
|
-
SENSITIVE = []
|
1775
|
-
include Aws::Structure
|
1776
|
-
end
|
1777
|
-
|
1778
1465
|
# @!attribute [rw] queue_url
|
1779
1466
|
# The URL of the Amazon SQS queue to which batched messages are sent.
|
1780
1467
|
#
|
@@ -2063,7 +1750,7 @@ module Aws::SQS
|
|
2063
1750
|
#
|
2064
1751
|
# @!attribute [rw] message_body
|
2065
1752
|
# The message to send. The minimum size is one character. The maximum
|
2066
|
-
# size is 256
|
1753
|
+
# size is 256 KB.
|
2067
1754
|
#
|
2068
1755
|
# A message can include only XML, JSON, and unformatted text. The
|
2069
1756
|
# following Unicode characters are allowed:
|
@@ -2318,13 +2005,7 @@ module Aws::SQS
|
|
2318
2005
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2319
2006
|
# which Amazon SQS retains a message. Valid values: An integer
|
2320
2007
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2321
|
-
# Default: 345,600 (4 days).
|
2322
|
-
# the change can take up to 60 seconds for most of the attributes to
|
2323
|
-
# propagate throughout the Amazon SQS system. Changes made to the
|
2324
|
-
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
2325
|
-
# will impact existing messages in the queue potentially causing
|
2326
|
-
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
2327
|
-
# reduced below the age of existing messages.
|
2008
|
+
# Default: 345,600 (4 days).
|
2328
2009
|
#
|
2329
2010
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2330
2011
|
# policy. For more information about policy structure, see [Overview
|
@@ -2336,16 +2017,11 @@ module Aws::SQS
|
|
2336
2017
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2337
2018
|
# 0.
|
2338
2019
|
#
|
2339
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2340
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2341
|
-
# Default: 30. For more information about the visibility timeout,
|
2342
|
-
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2343
|
-
#
|
2344
|
-
# The following attributes apply only to [dead-letter queues:][3]
|
2345
|
-
#
|
2346
2020
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2347
2021
|
# dead-letter queue functionality of the source queue as a JSON
|
2348
|
-
# object.
|
2022
|
+
# object. For more information about the redrive policy and
|
2023
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2024
|
+
# in the *Amazon SQS Developer Guide*.
|
2349
2025
|
#
|
2350
2026
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2351
2027
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2353,42 +2029,20 @@ module Aws::SQS
|
|
2353
2029
|
#
|
2354
2030
|
# * `maxReceiveCount` – The number of times a message is delivered
|
2355
2031
|
# to the source queue before being moved to the dead-letter queue.
|
2356
|
-
#
|
2032
|
+
# When the `ReceiveCount` for a message exceeds the
|
2357
2033
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2358
2034
|
# the dead-letter-queue.
|
2359
2035
|
#
|
2360
|
-
#
|
2361
|
-
#
|
2362
|
-
#
|
2363
|
-
# object. The parameters are as follows:
|
2036
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2037
|
+
# Similarly, the dead-letter queue of a standard queue must also be
|
2038
|
+
# a standard queue.
|
2364
2039
|
#
|
2365
|
-
#
|
2366
|
-
# source queues can specify the current queue as the dead-letter
|
2367
|
-
# queue. Valid values are:
|
2368
|
-
#
|
2369
|
-
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2370
|
-
# Services account in the same Region can specify this queue as
|
2371
|
-
# the dead-letter queue.
|
2372
|
-
#
|
2373
|
-
# * `denyAll` – No source queues can specify this queue as the
|
2374
|
-
# dead-letter queue.
|
2375
|
-
#
|
2376
|
-
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2377
|
-
# parameter can specify this queue as the dead-letter queue.
|
2378
|
-
#
|
2379
|
-
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2380
|
-
# source queues that can specify this queue as the dead-letter
|
2381
|
-
# queue and redrive messages. You can specify this parameter only
|
2382
|
-
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2383
|
-
# can specify up to 10 source queue ARNs. To allow more than 10
|
2384
|
-
# source queues to specify dead-letter queues, set the
|
2385
|
-
# `redrivePermission` parameter to `allowAll`.
|
2386
|
-
#
|
2387
|
-
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2388
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
2389
|
-
# standard queue.
|
2040
|
+
# </note>
|
2390
2041
|
#
|
2391
|
-
#
|
2042
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2043
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2044
|
+
# Default: 30. For more information about the visibility timeout,
|
2045
|
+
# see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2392
2046
|
#
|
2393
2047
|
# The following attributes apply only to [server-side-encryption][4]:
|
2394
2048
|
#
|
@@ -2411,7 +2065,7 @@ module Aws::SQS
|
|
2411
2065
|
#
|
2412
2066
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
2413
2067
|
# using SQS owned encryption keys. Only one server-side encryption
|
2414
|
-
# option is supported per queue (
|
2068
|
+
# option is supported per queue (e.g. [SSE-KMS][9] or
|
2415
2069
|
# [SSE-SQS][10]).
|
2416
2070
|
#
|
2417
2071
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
@@ -2478,8 +2132,8 @@ module Aws::SQS
|
|
2478
2132
|
#
|
2479
2133
|
#
|
2480
2134
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2481
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2482
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2135
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2136
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2483
2137
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2484
2138
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2485
2139
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2521,29 +2175,15 @@ module Aws::SQS
|
|
2521
2175
|
|
2522
2176
|
# The batch request contains more entries than permissible.
|
2523
2177
|
#
|
2524
|
-
# @!attribute [rw] message
|
2525
|
-
# @return [String]
|
2526
|
-
#
|
2527
2178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TooManyEntriesInBatchRequest AWS API Documentation
|
2528
2179
|
#
|
2529
|
-
class TooManyEntriesInBatchRequest <
|
2530
|
-
:message)
|
2531
|
-
SENSITIVE = []
|
2532
|
-
include Aws::Structure
|
2533
|
-
end
|
2180
|
+
class TooManyEntriesInBatchRequest < Aws::EmptyStructure; end
|
2534
2181
|
|
2535
2182
|
# Error code 400. Unsupported operation.
|
2536
2183
|
#
|
2537
|
-
# @!attribute [rw] message
|
2538
|
-
# @return [String]
|
2539
|
-
#
|
2540
2184
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UnsupportedOperation AWS API Documentation
|
2541
2185
|
#
|
2542
|
-
class UnsupportedOperation <
|
2543
|
-
:message)
|
2544
|
-
SENSITIVE = []
|
2545
|
-
include Aws::Structure
|
2546
|
-
end
|
2186
|
+
class UnsupportedOperation < Aws::EmptyStructure; end
|
2547
2187
|
|
2548
2188
|
# @!attribute [rw] queue_url
|
2549
2189
|
# The URL of the queue.
|