aws-sdk-sqs 1.53.0 → 1.54.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -67,15 +67,29 @@ 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
+ #
70
73
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchEntryIdsNotDistinct AWS API Documentation
71
74
  #
72
- class BatchEntryIdsNotDistinct < Aws::EmptyStructure; end
75
+ class BatchEntryIdsNotDistinct < Struct.new(
76
+ :message)
77
+ SENSITIVE = []
78
+ include Aws::Structure
79
+ end
73
80
 
74
81
  # The length of all the messages put together is more than the limit.
75
82
  #
83
+ # @!attribute [rw] message
84
+ # @return [String]
85
+ #
76
86
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchRequestTooLong AWS API Documentation
77
87
  #
78
- class BatchRequestTooLong < Aws::EmptyStructure; end
88
+ class BatchRequestTooLong < Struct.new(
89
+ :message)
90
+ SENSITIVE = []
91
+ include Aws::Structure
92
+ end
79
93
 
80
94
  # Gives a detailed description of the result of an action on each entry
81
95
  # in the request.
@@ -132,17 +146,6 @@ module Aws::SQS
132
146
  # Encloses a receipt handle and an entry id for each message in `
133
147
  # ChangeMessageVisibilityBatch.`
134
148
  #
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
- #
146
149
  # @!attribute [rw] id
147
150
  # An identifier for this particular receipt handle used to communicate
148
151
  # the result.
@@ -269,23 +272,33 @@ module Aws::SQS
269
272
  # * `MessageRetentionPeriod` – The length of time, in seconds, for
270
273
  # which Amazon SQS retains a message. Valid values: An integer from
271
274
  # 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
272
- # 345,600 (4 days).
275
+ # 345,600 (4 days). When you change a queue's attributes, the
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.
273
282
  #
274
283
  # * `Policy` – The queue's policy. A valid Amazon Web Services
275
284
  # policy. For more information about policy structure, see [Overview
276
- # of Amazon Web Services IAM Policies][1] in the *Amazon IAM User
277
- # Guide*.
285
+ # of Amazon Web Services IAM Policies][1] in the *IAM User Guide*.
278
286
  #
279
287
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
280
288
  # for which a ` ReceiveMessage ` action waits for a message to
281
289
  # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
282
290
  # 0.
283
291
  #
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
+ #
284
299
  # * `RedrivePolicy` – The string that includes the parameters for the
285
300
  # dead-letter queue functionality of the source queue as a JSON
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*.
301
+ # object. The parameters are as follows:
289
302
  #
290
303
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
291
304
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -293,22 +306,44 @@ module Aws::SQS
293
306
  #
294
307
  # * `maxReceiveCount` – The number of times a message is delivered
295
308
  # to the source queue before being moved to the dead-letter queue.
296
- # When the `ReceiveCount` for a message exceeds the
309
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
297
310
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
298
311
  # the dead-letter-queue.
299
312
  #
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.
313
+ # * `RedriveAllowPolicy` The string that includes the parameters for
314
+ # the permissions for the dead-letter queue redrive permission and
315
+ # which source queues can specify dead-letter queues as a JSON
316
+ # object. The parameters are as follows:
303
317
  #
304
- # </note>
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:
305
321
  #
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*.
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.
325
+ #
326
+ # * `denyAll` – No source queues can specify this queue as the
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.
343
+ #
344
+ # </note>
310
345
  #
311
- # The following attributes apply only to [server-side-encryption][4]\:
346
+ # The following attributes apply only to [server-side-encryption][4]:
312
347
  #
313
348
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
314
349
  # customer master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -325,15 +360,15 @@ module Aws::SQS
325
360
  # hours). Default: 300 (5 minutes). A shorter time period provides
326
361
  # better security but results in more calls to KMS which might incur
327
362
  # charges after Free Tier. For more information, see [How Does the
328
- # Data Key Reuse Period Work?][8].
363
+ # Data Key Reuse Period Work?][8]
329
364
  #
330
365
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption
331
366
  # using SQS owned encryption keys. Only one server-side encryption
332
- # option is supported per queue (e.g. [SSE-KMS][9] or
367
+ # option is supported per queue (for example, [SSE-KMS][9] or
333
368
  # [SSE-SQS][10]).
334
369
  #
335
370
  # The following attributes apply only to [FIFO (first-in-first-out)
336
- # queues][11]\:
371
+ # queues][11]:
337
372
  #
338
373
  # * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
339
374
  # and `false`. If you don't specify the `FifoQueue` attribute,
@@ -379,7 +414,7 @@ module Aws::SQS
379
414
  # duplicates and only one copy of the message is delivered.
380
415
  #
381
416
  # The following attributes apply only to [high throughput for FIFO
382
- # queues][14]\:
417
+ # queues][14]:
383
418
  #
384
419
  # * `DeduplicationScope` – Specifies whether message deduplication
385
420
  # occurs at the message group or queue level. Valid values are
@@ -407,8 +442,8 @@ module Aws::SQS
407
442
  #
408
443
  #
409
444
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
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
445
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
446
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
412
447
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
413
448
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
414
449
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -448,7 +483,7 @@ module Aws::SQS
448
483
  #
449
484
  # Cross-account permissions don't apply to this action. For more
450
485
  # information, see [Grant cross-account permissions to a role and a
451
- # user name][3] in the *Amazon SQS Developer Guide*.
486
+ # username][3] in the *Amazon SQS Developer Guide*.
452
487
  #
453
488
  # </note>
454
489
  #
@@ -600,9 +635,16 @@ module Aws::SQS
600
635
 
601
636
  # The batch request doesn't contain any entries.
602
637
  #
638
+ # @!attribute [rw] message
639
+ # @return [String]
640
+ #
603
641
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/EmptyBatchRequest AWS API Documentation
604
642
  #
605
- class EmptyBatchRequest < Aws::EmptyStructure; end
643
+ class EmptyBatchRequest < Struct.new(
644
+ :message)
645
+ SENSITIVE = []
646
+ include Aws::Structure
647
+ end
606
648
 
607
649
  # @!attribute [rw] queue_url
608
650
  # The URL of the Amazon SQS queue whose attribute information is
@@ -614,7 +656,7 @@ module Aws::SQS
614
656
  # @!attribute [rw] attribute_names
615
657
  # A list of attributes for which to retrieve information.
616
658
  #
617
- # The `AttributeName.N` parameter is optional, but if you don't
659
+ # The `AttributeNames` parameter is optional, but if you don't
618
660
  # specify values for this parameter, the request returns empty
619
661
  # results.
620
662
  #
@@ -628,10 +670,10 @@ module Aws::SQS
628
670
  #
629
671
  # The `ApproximateNumberOfMessagesDelayed`,
630
672
  # `ApproximateNumberOfMessagesNotVisible`, and
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.
673
+ # `ApproximateNumberOfMessages` metrics may not achieve consistency
674
+ # until at least 1 minute after the producers stop sending messages.
675
+ # This period is required for the queue metadata to reach eventual
676
+ # consistency.
635
677
  #
636
678
  # * `All` – Returns all values.
637
679
  #
@@ -663,7 +705,14 @@ module Aws::SQS
663
705
  # message can contain before Amazon SQS rejects it.
664
706
  #
665
707
  # * `MessageRetentionPeriod` – Returns the length of time, in seconds,
666
- # for which Amazon SQS retains a message.
708
+ # for which Amazon SQS retains a message. When you change a queue's
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.
667
716
  #
668
717
  # * `Policy` – Returns the policy of the queue.
669
718
  #
@@ -673,11 +722,15 @@ module Aws::SQS
673
722
  # seconds, for which the `ReceiveMessage` action waits for a message
674
723
  # to arrive.
675
724
  #
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
+ #
676
731
  # * `RedrivePolicy` – The string that includes the parameters for the
677
732
  # dead-letter queue functionality of the source queue as a JSON
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*.
733
+ # object. The parameters are as follows:
681
734
  #
682
735
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
683
736
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -685,15 +738,44 @@ module Aws::SQS
685
738
  #
686
739
  # * `maxReceiveCount` – The number of times a message is delivered
687
740
  # to the source queue before being moved to the dead-letter queue.
688
- # When the `ReceiveCount` for a message exceeds the
741
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
689
742
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
690
743
  # the dead-letter-queue.
691
744
  #
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*.
745
+ # * `RedriveAllowPolicy` – The string that includes the parameters for
746
+ # the permissions for the dead-letter queue redrive permission and
747
+ # which source queues can specify dead-letter queues as a JSON
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.
695
760
  #
696
- # The following attributes apply only to [server-side-encryption][4]\:
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>
777
+ #
778
+ # The following attributes apply only to [server-side-encryption][4]:
697
779
  #
698
780
  # * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
699
781
  # managed customer master key (CMK) for Amazon SQS or a custom CMK.
@@ -706,11 +788,11 @@ module Aws::SQS
706
788
  #
707
789
  # * `SqsManagedSseEnabled` – Returns information about whether the
708
790
  # queue is using SSE-SQS encryption using SQS owned encryption keys.
709
- # Only one server-side encryption option is supported per queue
710
- # (e.g. [SSE-KMS][7] or [SSE-SQS][8]).
791
+ # Only one server-side encryption option is supported per queue (for
792
+ # example, [SSE-KMS][7] or [SSE-SQS][8]).
711
793
  #
712
794
  # The following attributes apply only to [FIFO (first-in-first-out)
713
- # queues][9]\:
795
+ # queues][9]:
714
796
  #
715
797
  # * `FifoQueue` – Returns information about whether the queue is FIFO.
716
798
  # For more information, see [FIFO queue logic][10] in the *Amazon
@@ -726,7 +808,7 @@ module Aws::SQS
726
808
  # [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
727
809
  #
728
810
  # The following attributes apply only to [high throughput for FIFO
729
- # queues][12]\:
811
+ # queues][12]:
730
812
  #
731
813
  # * `DeduplicationScope` – Specifies whether message deduplication
732
814
  # occurs at the message group or queue level. Valid values are
@@ -754,8 +836,8 @@ module Aws::SQS
754
836
  #
755
837
  #
756
838
  # [1]: http://en.wikipedia.org/wiki/Unix_time
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
839
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
840
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
759
841
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
760
842
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
761
843
  # [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
@@ -832,18 +914,58 @@ module Aws::SQS
832
914
  include Aws::Structure
833
915
  end
834
916
 
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
+
835
930
  # The specified attribute doesn't exist.
836
931
  #
932
+ # @!attribute [rw] message
933
+ # @return [String]
934
+ #
837
935
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeName AWS API Documentation
838
936
  #
839
- class InvalidAttributeName < Aws::EmptyStructure; end
937
+ class InvalidAttributeName < Struct.new(
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
840
955
 
841
956
  # The `Id` of a batch entry in a batch request doesn't abide by the
842
957
  # specification.
843
958
  #
959
+ # @!attribute [rw] message
960
+ # @return [String]
961
+ #
844
962
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidBatchEntryId AWS API Documentation
845
963
  #
846
- class InvalidBatchEntryId < Aws::EmptyStructure; end
964
+ class InvalidBatchEntryId < Struct.new(
965
+ :message)
966
+ SENSITIVE = []
967
+ include Aws::Structure
968
+ end
847
969
 
848
970
  # The specified receipt handle isn't valid for the current version.
849
971
  #
@@ -853,9 +975,131 @@ module Aws::SQS
853
975
 
854
976
  # The message contains characters outside the allowed set.
855
977
  #
978
+ # @!attribute [rw] message
979
+ # @return [String]
980
+ #
856
981
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidMessageContents AWS API Documentation
857
982
  #
858
- class InvalidMessageContents < Aws::EmptyStructure; end
983
+ class InvalidMessageContents < Struct.new(
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
859
1103
 
860
1104
  # @!attribute [rw] queue_url
861
1105
  # The URL of a dead-letter queue.
@@ -1070,7 +1314,7 @@ module Aws::SQS
1070
1314
  #
1071
1315
  # `Name`, `type`, `value` and the message body must not be empty or
1072
1316
  # null. All parts of the message attribute, including `Name`, `Type`,
1073
- # and `Value`, are part of the message size restriction (256 KB or
1317
+ # and `Value`, are part of the message size restriction (256 KiB or
1074
1318
  # 262,144 bytes).
1075
1319
  #
1076
1320
  # @!attribute [rw] string_value
@@ -1181,21 +1425,35 @@ module Aws::SQS
1181
1425
  end
1182
1426
 
1183
1427
  # The specified action violates a limit. For example, `ReceiveMessage`
1184
- # returns this error if the maximum number of inflight messages is
1428
+ # returns this error if the maximum number of in flight messages is
1185
1429
  # reached and `AddPermission` returns this error if the maximum number
1186
1430
  # of permissions for the queue is reached.
1187
1431
  #
1432
+ # @!attribute [rw] message
1433
+ # @return [String]
1434
+ #
1188
1435
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/OverLimit AWS API Documentation
1189
1436
  #
1190
- class OverLimit < Aws::EmptyStructure; end
1437
+ class OverLimit < Struct.new(
1438
+ :message)
1439
+ SENSITIVE = []
1440
+ include Aws::Structure
1441
+ end
1191
1442
 
1192
1443
  # Indicates that the specified queue previously received a `PurgeQueue`
1193
1444
  # request within the last 60 seconds (the time it can take to delete the
1194
1445
  # messages in the queue).
1195
1446
  #
1447
+ # @!attribute [rw] message
1448
+ # @return [String]
1449
+ #
1196
1450
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueInProgress AWS API Documentation
1197
1451
  #
1198
- class PurgeQueueInProgress < Aws::EmptyStructure; end
1452
+ class PurgeQueueInProgress < Struct.new(
1453
+ :message)
1454
+ SENSITIVE = []
1455
+ include Aws::Structure
1456
+ end
1199
1457
 
1200
1458
  # @!attribute [rw] queue_url
1201
1459
  # The URL of the queue from which the `PurgeQueue` action deletes
@@ -1215,29 +1473,57 @@ module Aws::SQS
1215
1473
  # You must wait 60 seconds after deleting a queue before you can create
1216
1474
  # another queue with the same name.
1217
1475
  #
1476
+ # @!attribute [rw] message
1477
+ # @return [String]
1478
+ #
1218
1479
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDeletedRecently AWS API Documentation
1219
1480
  #
1220
- class QueueDeletedRecently < Aws::EmptyStructure; end
1481
+ class QueueDeletedRecently < Struct.new(
1482
+ :message)
1483
+ SENSITIVE = []
1484
+ include Aws::Structure
1485
+ end
1221
1486
 
1222
1487
  # The specified queue doesn't exist.
1223
1488
  #
1489
+ # @!attribute [rw] message
1490
+ # @return [String]
1491
+ #
1224
1492
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDoesNotExist AWS API Documentation
1225
1493
  #
1226
- class QueueDoesNotExist < Aws::EmptyStructure; end
1494
+ class QueueDoesNotExist < Struct.new(
1495
+ :message)
1496
+ SENSITIVE = []
1497
+ include Aws::Structure
1498
+ end
1227
1499
 
1228
1500
  # A queue with this name already exists. Amazon SQS returns this error
1229
1501
  # only if the request includes attributes whose values differ from those
1230
1502
  # of the existing queue.
1231
1503
  #
1504
+ # @!attribute [rw] message
1505
+ # @return [String]
1506
+ #
1232
1507
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueNameExists AWS API Documentation
1233
1508
  #
1234
- class QueueNameExists < Aws::EmptyStructure; end
1509
+ class QueueNameExists < Struct.new(
1510
+ :message)
1511
+ SENSITIVE = []
1512
+ include Aws::Structure
1513
+ end
1235
1514
 
1236
1515
  # The specified receipt handle isn't valid.
1237
1516
  #
1517
+ # @!attribute [rw] message
1518
+ # @return [String]
1519
+ #
1238
1520
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiptHandleIsInvalid AWS API Documentation
1239
1521
  #
1240
- class ReceiptHandleIsInvalid < Aws::EmptyStructure; end
1522
+ class ReceiptHandleIsInvalid < Struct.new(
1523
+ :message)
1524
+ SENSITIVE = []
1525
+ include Aws::Structure
1526
+ end
1241
1527
 
1242
1528
  # @!attribute [rw] queue_url
1243
1529
  # The URL of the Amazon SQS queue from which messages are received.
@@ -1262,7 +1548,7 @@ module Aws::SQS
1262
1548
  #
1263
1549
  # * `SenderId`
1264
1550
  #
1265
- # * For an IAM user, returns the IAM user ID, for example
1551
+ # * For a user, returns the user ID, for example
1266
1552
  # `ABCDEFGHI1JKLMNOPQ23R`.
1267
1553
  #
1268
1554
  # * For an IAM role, returns the IAM role ID, for example
@@ -1273,7 +1559,8 @@ module Aws::SQS
1273
1559
  #
1274
1560
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption
1275
1561
  # using SQS owned encryption keys. Only one server-side encryption
1276
- # option is supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
1562
+ # option is supported per queue (for example, [SSE-KMS][2] or
1563
+ # [SSE-SQS][3]).
1277
1564
  #
1278
1565
  # * `MessageDeduplicationId` – Returns the value provided by the
1279
1566
  # producer that calls the ` SendMessage ` action.
@@ -1462,6 +1749,32 @@ module Aws::SQS
1462
1749
  include Aws::Structure
1463
1750
  end
1464
1751
 
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
+
1465
1778
  # @!attribute [rw] queue_url
1466
1779
  # The URL of the Amazon SQS queue to which batched messages are sent.
1467
1780
  #
@@ -1750,7 +2063,7 @@ module Aws::SQS
1750
2063
  #
1751
2064
  # @!attribute [rw] message_body
1752
2065
  # The message to send. The minimum size is one character. The maximum
1753
- # size is 256 KB.
2066
+ # size is 256 KiB.
1754
2067
  #
1755
2068
  # A message can include only XML, JSON, and unformatted text. The
1756
2069
  # following Unicode characters are allowed:
@@ -2005,7 +2318,13 @@ module Aws::SQS
2005
2318
  # * `MessageRetentionPeriod` – The length of time, in seconds, for
2006
2319
  # which Amazon SQS retains a message. Valid values: An integer
2007
2320
  # representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
2008
- # Default: 345,600 (4 days).
2321
+ # Default: 345,600 (4 days). When you change a queue's attributes,
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.
2009
2328
  #
2010
2329
  # * `Policy` – The queue's policy. A valid Amazon Web Services
2011
2330
  # policy. For more information about policy structure, see [Overview
@@ -2017,11 +2336,16 @@ module Aws::SQS
2017
2336
  # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
2018
2337
  # 0.
2019
2338
  #
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
+ #
2020
2346
  # * `RedrivePolicy` – The string that includes the parameters for the
2021
2347
  # dead-letter queue functionality of the source queue as a JSON
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*.
2348
+ # object. The parameters are as follows:
2025
2349
  #
2026
2350
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2027
2351
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -2029,22 +2353,44 @@ module Aws::SQS
2029
2353
  #
2030
2354
  # * `maxReceiveCount` – The number of times a message is delivered
2031
2355
  # to the source queue before being moved to the dead-letter queue.
2032
- # When the `ReceiveCount` for a message exceeds the
2356
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
2033
2357
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
2034
2358
  # the dead-letter-queue.
2035
2359
  #
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.
2360
+ # * `RedriveAllowPolicy` The string that includes the parameters for
2361
+ # the permissions for the dead-letter queue redrive permission and
2362
+ # which source queues can specify dead-letter queues as a JSON
2363
+ # object. The parameters are as follows:
2039
2364
  #
2040
- # </note>
2365
+ # * `redrivePermission` – The permission type that defines which
2366
+ # source queues can specify the current queue as the dead-letter
2367
+ # queue. Valid values are:
2041
2368
  #
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*.
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.
2046
2390
  #
2047
- # The following attributes apply only to [server-side-encryption][4]\:
2391
+ # </note>
2392
+ #
2393
+ # The following attributes apply only to [server-side-encryption][4]:
2048
2394
  #
2049
2395
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
2050
2396
  # customer master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -2065,11 +2411,11 @@ module Aws::SQS
2065
2411
  #
2066
2412
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption
2067
2413
  # using SQS owned encryption keys. Only one server-side encryption
2068
- # option is supported per queue (e.g. [SSE-KMS][9] or
2414
+ # option is supported per queue (for example, [SSE-KMS][9] or
2069
2415
  # [SSE-SQS][10]).
2070
2416
  #
2071
2417
  # The following attribute applies only to [FIFO (first-in-first-out)
2072
- # queues][11]\:
2418
+ # queues][11]:
2073
2419
  #
2074
2420
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
2075
2421
  # For more information, see [Exactly-once processing][12] in the
@@ -2104,7 +2450,7 @@ module Aws::SQS
2104
2450
  # duplicates and only one copy of the message is delivered.
2105
2451
  #
2106
2452
  # The following attributes apply only to [high throughput for FIFO
2107
- # queues][13]\:
2453
+ # queues][13]:
2108
2454
  #
2109
2455
  # * `DeduplicationScope` – Specifies whether message deduplication
2110
2456
  # occurs at the message group or queue level. Valid values are
@@ -2132,8 +2478,8 @@ module Aws::SQS
2132
2478
  #
2133
2479
  #
2134
2480
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
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
2481
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
2482
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
2137
2483
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
2138
2484
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
2139
2485
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -2175,15 +2521,29 @@ module Aws::SQS
2175
2521
 
2176
2522
  # The batch request contains more entries than permissible.
2177
2523
  #
2524
+ # @!attribute [rw] message
2525
+ # @return [String]
2526
+ #
2178
2527
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TooManyEntriesInBatchRequest AWS API Documentation
2179
2528
  #
2180
- class TooManyEntriesInBatchRequest < Aws::EmptyStructure; end
2529
+ class TooManyEntriesInBatchRequest < Struct.new(
2530
+ :message)
2531
+ SENSITIVE = []
2532
+ include Aws::Structure
2533
+ end
2181
2534
 
2182
2535
  # Error code 400. Unsupported operation.
2183
2536
  #
2537
+ # @!attribute [rw] message
2538
+ # @return [String]
2539
+ #
2184
2540
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UnsupportedOperation AWS API Documentation
2185
2541
  #
2186
- class UnsupportedOperation < Aws::EmptyStructure; end
2542
+ class UnsupportedOperation < Struct.new(
2543
+ :message)
2544
+ SENSITIVE = []
2545
+ include Aws::Structure
2546
+ end
2187
2547
 
2188
2548
  # @!attribute [rw] queue_url
2189
2549
  # The URL of the queue.