aws-sdk-sqs 1.24.0 → 1.29.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -70,6 +72,7 @@ module Aws::SQS
70
72
  :label,
71
73
  :aws_account_ids,
72
74
  :actions)
75
+ SENSITIVE = []
73
76
  include Aws::Structure
74
77
  end
75
78
 
@@ -93,7 +96,8 @@ module Aws::SQS
93
96
  # @return [String]
94
97
  #
95
98
  # @!attribute [rw] sender_fault
96
- # Specifies whether the error happened due to the producer.
99
+ # Specifies whether the error happened due to the caller of the batch
100
+ # API action.
97
101
  # @return [Boolean]
98
102
  #
99
103
  # @!attribute [rw] code
@@ -111,6 +115,7 @@ module Aws::SQS
111
115
  :sender_fault,
112
116
  :code,
113
117
  :message)
118
+ SENSITIVE = []
114
119
  include Aws::Structure
115
120
  end
116
121
 
@@ -145,6 +150,7 @@ module Aws::SQS
145
150
  class ChangeMessageVisibilityBatchRequest < Struct.new(
146
151
  :queue_url,
147
152
  :entries)
153
+ SENSITIVE = []
148
154
  include Aws::Structure
149
155
  end
150
156
 
@@ -175,7 +181,11 @@ module Aws::SQS
175
181
  # An identifier for this particular receipt handle used to communicate
176
182
  # the result.
177
183
  #
178
- # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
184
+ # <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
185
+ #
186
+ # This identifier can have up to 80 characters. The following
187
+ # characters are accepted: alphanumeric characters, hyphens(-), and
188
+ # underscores (\_).
179
189
  #
180
190
  # </note>
181
191
  # @return [String]
@@ -194,6 +204,7 @@ module Aws::SQS
194
204
  :id,
195
205
  :receipt_handle,
196
206
  :visibility_timeout)
207
+ SENSITIVE = []
197
208
  include Aws::Structure
198
209
  end
199
210
 
@@ -214,6 +225,7 @@ module Aws::SQS
214
225
  class ChangeMessageVisibilityBatchResult < Struct.new(
215
226
  :successful,
216
227
  :failed)
228
+ SENSITIVE = []
217
229
  include Aws::Structure
218
230
  end
219
231
 
@@ -228,6 +240,7 @@ module Aws::SQS
228
240
  #
229
241
  class ChangeMessageVisibilityBatchResultEntry < Struct.new(
230
242
  :id)
243
+ SENSITIVE = []
231
244
  include Aws::Structure
232
245
  end
233
246
 
@@ -264,6 +277,7 @@ module Aws::SQS
264
277
  :queue_url,
265
278
  :receipt_handle,
266
279
  :visibility_timeout)
280
+ SENSITIVE = []
267
281
  include Aws::Structure
268
282
  end
269
283
 
@@ -299,40 +313,40 @@ module Aws::SQS
299
313
  # The following lists the names, descriptions, and values of the
300
314
  # special request parameters that the `CreateQueue` action uses:
301
315
  #
302
- # * `DelaySeconds` - The length of time, in seconds, for which the
316
+ # * `DelaySeconds` The length of time, in seconds, for which the
303
317
  # delivery of all messages in the queue is delayed. Valid values: An
304
318
  # integer from 0 to 900 seconds (15 minutes). Default: 0.
305
319
  #
306
- # * `MaximumMessageSize` - The limit of how many bytes a message can
320
+ # * `MaximumMessageSize` The limit of how many bytes a message can
307
321
  # contain before Amazon SQS rejects it. Valid values: An integer
308
322
  # from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
309
323
  # 262,144 (256 KiB).
310
324
  #
311
- # * `MessageRetentionPeriod` - The length of time, in seconds, for
325
+ # * `MessageRetentionPeriod` The length of time, in seconds, for
312
326
  # which Amazon SQS retains a message. Valid values: An integer from
313
327
  # 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
314
328
  # 345,600 (4 days).
315
329
  #
316
- # * `Policy` - The queue's policy. A valid AWS policy. For more
330
+ # * `Policy` The queue's policy. A valid AWS policy. For more
317
331
  # information about policy structure, see [Overview of AWS IAM
318
332
  # Policies][1] in the *Amazon IAM User Guide*.
319
333
  #
320
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
334
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
321
335
  # for which a ` ReceiveMessage ` action waits for a message to
322
336
  # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
323
337
  # 0.
324
338
  #
325
- # * `RedrivePolicy` - The string that includes the parameters for the
326
- # dead-letter queue functionality of the source queue. For more
327
- # information about the redrive policy and dead-letter queues, see
328
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
329
- # Queue Service Developer Guide*.
339
+ # * `RedrivePolicy` The string that includes the parameters for the
340
+ # dead-letter queue functionality of the source queue as a JSON
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 Simple Queue Service Developer Guide*.
330
344
  #
331
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
345
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
332
346
  # dead-letter queue to which Amazon SQS moves messages after the
333
347
  # value of `maxReceiveCount` is exceeded.
334
348
  #
335
- # * `maxReceiveCount` - The number of times a message is delivered
349
+ # * `maxReceiveCount` The number of times a message is delivered
336
350
  # to the source queue before being moved to the dead-letter queue.
337
351
  # When the `ReceiveCount` for a message exceeds the
338
352
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
@@ -344,7 +358,7 @@ module Aws::SQS
344
358
  #
345
359
  # </note>
346
360
  #
347
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
361
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
348
362
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
349
363
  # Default: 30. For more information about the visibility timeout,
350
364
  # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
@@ -352,14 +366,14 @@ module Aws::SQS
352
366
  #
353
367
  # The following attributes apply only to [server-side-encryption][4]\:
354
368
  #
355
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
369
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
356
370
  # (CMK) for Amazon SQS or a custom CMK. For more information, see
357
371
  # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
358
372
  # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
359
373
  # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
360
374
  # the *AWS Key Management Service API Reference*.
361
375
  #
362
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
376
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds,
363
377
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
364
378
  # decrypt messages before calling AWS KMS again. An integer
365
379
  # representing seconds, between 60 seconds (1 minute) and 86,400
@@ -371,7 +385,7 @@ module Aws::SQS
371
385
  # The following attributes apply only to [FIFO (first-in-first-out)
372
386
  # queues][9]\:
373
387
  #
374
- # * `FifoQueue` - Designates a queue as FIFO. Valid values: `true`,
388
+ # * `FifoQueue` Designates a queue as FIFO. Valid values: `true`,
375
389
  # `false`. If you don't specify the `FifoQueue` attribute, Amazon
376
390
  # SQS creates a standard queue. You can provide this attribute only
377
391
  # during queue creation. You can't change it for an existing queue.
@@ -381,7 +395,7 @@ module Aws::SQS
381
395
  # For more information, see [FIFO Queue Logic][10] in the *Amazon
382
396
  # Simple Queue Service Developer Guide*.
383
397
  #
384
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
398
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
385
399
  # Valid values: `true`, `false`. For more information, see
386
400
  # [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
387
401
  # Developer Guide*.
@@ -471,6 +485,7 @@ module Aws::SQS
471
485
  :queue_name,
472
486
  :attributes,
473
487
  :tags)
488
+ SENSITIVE = []
474
489
  include Aws::Structure
475
490
  end
476
491
 
@@ -484,6 +499,7 @@ module Aws::SQS
484
499
  #
485
500
  class CreateQueueResult < Struct.new(
486
501
  :queue_url)
502
+ SENSITIVE = []
487
503
  include Aws::Structure
488
504
  end
489
505
 
@@ -515,6 +531,7 @@ module Aws::SQS
515
531
  class DeleteMessageBatchRequest < Struct.new(
516
532
  :queue_url,
517
533
  :entries)
534
+ SENSITIVE = []
518
535
  include Aws::Structure
519
536
  end
520
537
 
@@ -532,7 +549,11 @@ module Aws::SQS
532
549
  # An identifier for this particular receipt handle. This is used to
533
550
  # communicate the result.
534
551
  #
535
- # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
552
+ # <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
553
+ #
554
+ # This identifier can have up to 80 characters. The following
555
+ # characters are accepted: alphanumeric characters, hyphens(-), and
556
+ # underscores (\_).
536
557
  #
537
558
  # </note>
538
559
  # @return [String]
@@ -546,6 +567,7 @@ module Aws::SQS
546
567
  class DeleteMessageBatchRequestEntry < Struct.new(
547
568
  :id,
548
569
  :receipt_handle)
570
+ SENSITIVE = []
549
571
  include Aws::Structure
550
572
  end
551
573
 
@@ -566,6 +588,7 @@ module Aws::SQS
566
588
  class DeleteMessageBatchResult < Struct.new(
567
589
  :successful,
568
590
  :failed)
591
+ SENSITIVE = []
569
592
  include Aws::Structure
570
593
  end
571
594
 
@@ -579,6 +602,7 @@ module Aws::SQS
579
602
  #
580
603
  class DeleteMessageBatchResultEntry < Struct.new(
581
604
  :id)
605
+ SENSITIVE = []
582
606
  include Aws::Structure
583
607
  end
584
608
 
@@ -605,6 +629,7 @@ module Aws::SQS
605
629
  class DeleteMessageRequest < Struct.new(
606
630
  :queue_url,
607
631
  :receipt_handle)
632
+ SENSITIVE = []
608
633
  include Aws::Structure
609
634
  end
610
635
 
@@ -625,6 +650,7 @@ module Aws::SQS
625
650
  #
626
651
  class DeleteQueueRequest < Struct.new(
627
652
  :queue_url)
653
+ SENSITIVE = []
628
654
  include Aws::Structure
629
655
  end
630
656
 
@@ -660,74 +686,81 @@ module Aws::SQS
660
686
  #
661
687
  # The following attributes are supported:
662
688
  #
663
- # * `All` - Returns all values.
689
+ # The `ApproximateNumberOfMessagesDelayed`,
690
+ # `ApproximateNumberOfMessagesNotVisible`, and
691
+ # `ApproximateNumberOfMessagesVisible` metrics may not achieve
692
+ # consistency until at least 1 minute after the producers stop sending
693
+ # messages. This period is required for the queue metadata to reach
694
+ # eventual consistency.
695
+ #
696
+ # * `All` – Returns all values.
664
697
  #
665
- # * `ApproximateNumberOfMessages` - Returns the approximate number of
698
+ # * `ApproximateNumberOfMessages` Returns the approximate number of
666
699
  # messages available for retrieval from the queue.
667
700
  #
668
- # * `ApproximateNumberOfMessagesDelayed` - Returns the approximate
701
+ # * `ApproximateNumberOfMessagesDelayed` Returns the approximate
669
702
  # number of messages in the queue that are delayed and not available
670
703
  # for reading immediately. This can happen when the queue is
671
704
  # configured as a delay queue or when a message has been sent with a
672
705
  # delay parameter.
673
706
  #
674
- # * `ApproximateNumberOfMessagesNotVisible` - Returns the approximate
707
+ # * `ApproximateNumberOfMessagesNotVisible` Returns the approximate
675
708
  # number of messages that are in flight. Messages are considered to
676
709
  # be *in flight* if they have been sent to a client but have not yet
677
710
  # been deleted or have not yet reached the end of their visibility
678
711
  # window.
679
712
  #
680
- # * `CreatedTimestamp` - Returns the time when the queue was created
713
+ # * `CreatedTimestamp` Returns the time when the queue was created
681
714
  # in seconds ([epoch time][1]).
682
715
  #
683
- # * `DelaySeconds` - Returns the default delay on the queue in
716
+ # * `DelaySeconds` Returns the default delay on the queue in
684
717
  # seconds.
685
718
  #
686
- # * `LastModifiedTimestamp` - Returns the time when the queue was last
719
+ # * `LastModifiedTimestamp` Returns the time when the queue was last
687
720
  # changed in seconds ([epoch time][1]).
688
721
  #
689
- # * `MaximumMessageSize` - Returns the limit of how many bytes a
722
+ # * `MaximumMessageSize` Returns the limit of how many bytes a
690
723
  # message can contain before Amazon SQS rejects it.
691
724
  #
692
- # * `MessageRetentionPeriod` - Returns the length of time, in seconds,
725
+ # * `MessageRetentionPeriod` Returns the length of time, in seconds,
693
726
  # for which Amazon SQS retains a message.
694
727
  #
695
- # * `Policy` - Returns the policy of the queue.
728
+ # * `Policy` Returns the policy of the queue.
696
729
  #
697
- # * `QueueArn` - Returns the Amazon resource name (ARN) of the queue.
730
+ # * `QueueArn` Returns the Amazon resource name (ARN) of the queue.
698
731
  #
699
- # * `ReceiveMessageWaitTimeSeconds` - Returns the length of time, in
732
+ # * `ReceiveMessageWaitTimeSeconds` Returns the length of time, in
700
733
  # seconds, for which the `ReceiveMessage` action waits for a message
701
734
  # to arrive.
702
735
  #
703
- # * `RedrivePolicy` - Returns the string that includes the parameters
704
- # for dead-letter queue functionality of the source queue. For more
705
- # information about the redrive policy and dead-letter queues, see
706
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
707
- # Queue Service Developer Guide*.
736
+ # * `RedrivePolicy` The string that includes the parameters for the
737
+ # dead-letter queue functionality of the source queue as a JSON
738
+ # object. For more information about the redrive policy and
739
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
740
+ # in the *Amazon Simple Queue Service Developer Guide*.
708
741
  #
709
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
742
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
710
743
  # dead-letter queue to which Amazon SQS moves messages after the
711
744
  # value of `maxReceiveCount` is exceeded.
712
745
  #
713
- # * `maxReceiveCount` - The number of times a message is delivered
746
+ # * `maxReceiveCount` The number of times a message is delivered
714
747
  # to the source queue before being moved to the dead-letter queue.
715
748
  # When the `ReceiveCount` for a message exceeds the
716
749
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
717
750
  # the dead-letter-queue.
718
751
  #
719
- # * `VisibilityTimeout` - Returns the visibility timeout for the
752
+ # * `VisibilityTimeout` Returns the visibility timeout for the
720
753
  # queue. For more information about the visibility timeout, see
721
754
  # [Visibility Timeout][3] in the *Amazon Simple Queue Service
722
755
  # Developer Guide*.
723
756
  #
724
757
  # The following attributes apply only to [server-side-encryption][4]\:
725
758
  #
726
- # * `KmsMasterKeyId` - Returns the ID of an AWS-managed customer
759
+ # * `KmsMasterKeyId` Returns the ID of an AWS-managed customer
727
760
  # master key (CMK) for Amazon SQS or a custom CMK. For more
728
761
  # information, see [Key Terms][5].
729
762
  #
730
- # * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
763
+ # * `KmsDataKeyReusePeriodSeconds` Returns the length of time, in
731
764
  # seconds, for which Amazon SQS can reuse a data key to encrypt or
732
765
  # decrypt messages before calling AWS KMS again. For more
733
766
  # information, see [How Does the Data Key Reuse Period Work?][6].
@@ -735,7 +768,7 @@ module Aws::SQS
735
768
  # The following attributes apply only to [FIFO (first-in-first-out)
736
769
  # queues][7]\:
737
770
  #
738
- # * `FifoQueue` - Returns whether the queue is FIFO. For more
771
+ # * `FifoQueue` Returns whether the queue is FIFO. For more
739
772
  # information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
740
773
  # Service Developer Guide*.
741
774
  #
@@ -744,7 +777,7 @@ module Aws::SQS
744
777
  #
745
778
  # </note>
746
779
  #
747
- # * `ContentBasedDeduplication` - Returns whether content-based
780
+ # * `ContentBasedDeduplication` Returns whether content-based
748
781
  # deduplication is enabled for the queue. For more information, see
749
782
  # [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
750
783
  # Developer Guide*.
@@ -767,6 +800,7 @@ module Aws::SQS
767
800
  class GetQueueAttributesRequest < Struct.new(
768
801
  :queue_url,
769
802
  :attribute_names)
803
+ SENSITIVE = []
770
804
  include Aws::Structure
771
805
  end
772
806
 
@@ -780,6 +814,7 @@ module Aws::SQS
780
814
  #
781
815
  class GetQueueAttributesResult < Struct.new(
782
816
  :attributes)
817
+ SENSITIVE = []
783
818
  include Aws::Structure
784
819
  end
785
820
 
@@ -808,6 +843,7 @@ module Aws::SQS
808
843
  class GetQueueUrlRequest < Struct.new(
809
844
  :queue_name,
810
845
  :queue_owner_aws_account_id)
846
+ SENSITIVE = []
811
847
  include Aws::Structure
812
848
  end
813
849
 
@@ -826,6 +862,7 @@ module Aws::SQS
826
862
  #
827
863
  class GetQueueUrlResult < Struct.new(
828
864
  :queue_url)
865
+ SENSITIVE = []
829
866
  include Aws::Structure
830
867
  end
831
868
 
@@ -859,6 +896,8 @@ module Aws::SQS
859
896
  #
860
897
  # {
861
898
  # queue_url: "String", # required
899
+ # next_token: "Token",
900
+ # max_results: 1,
862
901
  # }
863
902
  #
864
903
  # @!attribute [rw] queue_url
@@ -867,10 +906,21 @@ module Aws::SQS
867
906
  # Queue URLs and names are case-sensitive.
868
907
  # @return [String]
869
908
  #
909
+ # @!attribute [rw] next_token
910
+ # Pagination token to request the next set of results.
911
+ # @return [String]
912
+ #
913
+ # @!attribute [rw] max_results
914
+ # Maximum number of results to include in the response.
915
+ # @return [Integer]
916
+ #
870
917
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
871
918
  #
872
919
  class ListDeadLetterSourceQueuesRequest < Struct.new(
873
- :queue_url)
920
+ :queue_url,
921
+ :next_token,
922
+ :max_results)
923
+ SENSITIVE = []
874
924
  include Aws::Structure
875
925
  end
876
926
 
@@ -881,10 +931,16 @@ module Aws::SQS
881
931
  # attribute configured with a dead-letter queue.
882
932
  # @return [Array<String>]
883
933
  #
934
+ # @!attribute [rw] next_token
935
+ # Pagination token to include in the next request.
936
+ # @return [String]
937
+ #
884
938
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
885
939
  #
886
940
  class ListDeadLetterSourceQueuesResult < Struct.new(
887
- :queue_urls)
941
+ :queue_urls,
942
+ :next_token)
943
+ SENSITIVE = []
888
944
  include Aws::Structure
889
945
  end
890
946
 
@@ -903,6 +959,7 @@ module Aws::SQS
903
959
  #
904
960
  class ListQueueTagsRequest < Struct.new(
905
961
  :queue_url)
962
+ SENSITIVE = []
906
963
  include Aws::Structure
907
964
  end
908
965
 
@@ -914,6 +971,7 @@ module Aws::SQS
914
971
  #
915
972
  class ListQueueTagsResult < Struct.new(
916
973
  :tags)
974
+ SENSITIVE = []
917
975
  include Aws::Structure
918
976
  end
919
977
 
@@ -922,6 +980,8 @@ module Aws::SQS
922
980
  #
923
981
  # {
924
982
  # queue_name_prefix: "String",
983
+ # next_token: "Token",
984
+ # max_results: 1,
925
985
  # }
926
986
  #
927
987
  # @!attribute [rw] queue_name_prefix
@@ -931,23 +991,41 @@ module Aws::SQS
931
991
  # Queue URLs and names are case-sensitive.
932
992
  # @return [String]
933
993
  #
994
+ # @!attribute [rw] next_token
995
+ # Pagination token to request the next set of results.
996
+ # @return [String]
997
+ #
998
+ # @!attribute [rw] max_results
999
+ # Maximum number of results to include in the response.
1000
+ # @return [Integer]
1001
+ #
934
1002
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
935
1003
  #
936
1004
  class ListQueuesRequest < Struct.new(
937
- :queue_name_prefix)
1005
+ :queue_name_prefix,
1006
+ :next_token,
1007
+ :max_results)
1008
+ SENSITIVE = []
938
1009
  include Aws::Structure
939
1010
  end
940
1011
 
941
1012
  # A list of your queues.
942
1013
  #
943
1014
  # @!attribute [rw] queue_urls
944
- # A list of queue URLs, up to 1,000 entries.
1015
+ # A list of queue URLs, up to 1,000 entries, or the value of
1016
+ # MaxResults that you sent in the request.
945
1017
  # @return [Array<String>]
946
1018
  #
1019
+ # @!attribute [rw] next_token
1020
+ # Pagination token to include in the next request.
1021
+ # @return [String]
1022
+ #
947
1023
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult AWS API Documentation
948
1024
  #
949
1025
  class ListQueuesResult < Struct.new(
950
- :queue_urls)
1026
+ :queue_urls,
1027
+ :next_token)
1028
+ SENSITIVE = []
951
1029
  include Aws::Structure
952
1030
  end
953
1031
 
@@ -1032,6 +1110,7 @@ module Aws::SQS
1032
1110
  :attributes,
1033
1111
  :md5_of_message_attributes,
1034
1112
  :message_attributes)
1113
+ SENSITIVE = []
1035
1114
  include Aws::Structure
1036
1115
  end
1037
1116
 
@@ -1099,6 +1178,7 @@ module Aws::SQS
1099
1178
  :string_list_values,
1100
1179
  :binary_list_values,
1101
1180
  :data_type)
1181
+ SENSITIVE = []
1102
1182
  include Aws::Structure
1103
1183
  end
1104
1184
 
@@ -1170,6 +1250,7 @@ module Aws::SQS
1170
1250
  :string_list_values,
1171
1251
  :binary_list_values,
1172
1252
  :data_type)
1253
+ SENSITIVE = []
1173
1254
  include Aws::Structure
1174
1255
  end
1175
1256
 
@@ -1208,6 +1289,7 @@ module Aws::SQS
1208
1289
  #
1209
1290
  class PurgeQueueRequest < Struct.new(
1210
1291
  :queue_url)
1292
+ SENSITIVE = []
1211
1293
  include Aws::Structure
1212
1294
  end
1213
1295
 
@@ -1261,16 +1343,16 @@ module Aws::SQS
1261
1343
  # A list of attributes that need to be returned along with each
1262
1344
  # message. These attributes include:
1263
1345
  #
1264
- # * `All` - Returns all values.
1346
+ # * `All` Returns all values.
1265
1347
  #
1266
- # * `ApproximateFirstReceiveTimestamp` - Returns the time the message
1348
+ # * `ApproximateFirstReceiveTimestamp` Returns the time the message
1267
1349
  # was first received from the queue ([epoch time][1] in
1268
1350
  # milliseconds).
1269
1351
  #
1270
- # * `ApproximateReceiveCount` - Returns the number of times a message
1271
- # has been received from the queue but not deleted.
1352
+ # * `ApproximateReceiveCount` Returns the number of times a message
1353
+ # has been received across all queues but not deleted.
1272
1354
  #
1273
- # * `AWSTraceHeader` - Returns the AWS X-Ray trace header string.
1355
+ # * `AWSTraceHeader` Returns the AWS X-Ray trace header string.
1274
1356
  #
1275
1357
  # * `SenderId`
1276
1358
  #
@@ -1280,17 +1362,17 @@ module Aws::SQS
1280
1362
  # * For an IAM role, returns the IAM role ID, for example
1281
1363
  # `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
1282
1364
  #
1283
- # * `SentTimestamp` - Returns the time the message was sent to the
1365
+ # * `SentTimestamp` Returns the time the message was sent to the
1284
1366
  # queue ([epoch time][1] in milliseconds).
1285
1367
  #
1286
- # * `MessageDeduplicationId` - Returns the value provided by the
1368
+ # * `MessageDeduplicationId` Returns the value provided by the
1287
1369
  # producer that calls the ` SendMessage ` action.
1288
1370
  #
1289
- # * `MessageGroupId` - Returns the value provided by the producer that
1371
+ # * `MessageGroupId` Returns the value provided by the producer that
1290
1372
  # calls the ` SendMessage ` action. Messages with the same
1291
1373
  # `MessageGroupId` are returned in sequence.
1292
1374
  #
1293
- # * `SequenceNumber` - Returns the value provided by Amazon SQS.
1375
+ # * `SequenceNumber` Returns the value provided by Amazon SQS.
1294
1376
  #
1295
1377
  #
1296
1378
  #
@@ -1338,6 +1420,18 @@ module Aws::SQS
1338
1420
  # call returns sooner than `WaitTimeSeconds`. If no messages are
1339
1421
  # available and the wait time expires, the call returns successfully
1340
1422
  # with an empty list of messages.
1423
+ #
1424
+ # To avoid HTTP errors, ensure that the HTTP response timeout for
1425
+ # `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
1426
+ # parameter. For example, with the Java SDK, you can set HTTP
1427
+ # transport settings using the [ NettyNioAsyncHttpClient][1] for
1428
+ # asynchronous clients, or the [ ApacheHttpClient][2] for synchronous
1429
+ # clients.
1430
+ #
1431
+ #
1432
+ #
1433
+ # [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
1434
+ # [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
1341
1435
  # @return [Integer]
1342
1436
  #
1343
1437
  # @!attribute [rw] receive_request_attempt_id
@@ -1345,10 +1439,10 @@ module Aws::SQS
1345
1439
  #
1346
1440
  # The token used for deduplication of `ReceiveMessage` calls. If a
1347
1441
  # networking issue occurs after a `ReceiveMessage` action, and instead
1348
- # of a response you receive a generic error, you can retry the same
1349
- # action with an identical `ReceiveRequestAttemptId` to retrieve the
1350
- # same set of messages, even if their visibility timeout has not yet
1351
- # expired.
1442
+ # of a response you receive a generic error, it is possible to retry
1443
+ # the same action with an identical `ReceiveRequestAttemptId` to
1444
+ # retrieve the same set of messages, even if their visibility timeout
1445
+ # has not yet expired.
1352
1446
  #
1353
1447
  # * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
1354
1448
  # `ReceiveMessage` action.
@@ -1360,7 +1454,7 @@ module Aws::SQS
1360
1454
  # `ReceiveRequestAttemptId`, Amazon SQS generates a
1361
1455
  # `ReceiveRequestAttemptId`.
1362
1456
  #
1363
- # * You can retry the `ReceiveMessage` action with the same
1457
+ # * It is possible to retry the `ReceiveMessage` action with the same
1364
1458
  # `ReceiveRequestAttemptId` if none of the messages have been
1365
1459
  # modified (deleted or had their visibility changes).
1366
1460
  #
@@ -1394,7 +1488,7 @@ module Aws::SQS
1394
1488
  # visibility timeout expires. As a result, delays might occur but
1395
1489
  # the messages in the queue remain in a strict order.
1396
1490
  #
1397
- # The length of `ReceiveRequestAttemptId` is 128 characters.
1491
+ # The maximum length of `ReceiveRequestAttemptId` is 128 characters.
1398
1492
  # `ReceiveRequestAttemptId` can contain alphanumeric characters
1399
1493
  # (`a-z`, `A-Z`, `0-9`) and punctuation (``
1400
1494
  # !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
@@ -1419,6 +1513,7 @@ module Aws::SQS
1419
1513
  :visibility_timeout,
1420
1514
  :wait_time_seconds,
1421
1515
  :receive_request_attempt_id)
1516
+ SENSITIVE = []
1422
1517
  include Aws::Structure
1423
1518
  end
1424
1519
 
@@ -1432,6 +1527,7 @@ module Aws::SQS
1432
1527
  #
1433
1528
  class ReceiveMessageResult < Struct.new(
1434
1529
  :messages)
1530
+ SENSITIVE = []
1435
1531
  include Aws::Structure
1436
1532
  end
1437
1533
 
@@ -1459,6 +1555,7 @@ module Aws::SQS
1459
1555
  class RemovePermissionRequest < Struct.new(
1460
1556
  :queue_url,
1461
1557
  :label)
1558
+ SENSITIVE = []
1462
1559
  include Aws::Structure
1463
1560
  end
1464
1561
 
@@ -1511,6 +1608,7 @@ module Aws::SQS
1511
1608
  class SendMessageBatchRequest < Struct.new(
1512
1609
  :queue_url,
1513
1610
  :entries)
1611
+ SENSITIVE = []
1514
1612
  include Aws::Structure
1515
1613
  end
1516
1614
 
@@ -1550,7 +1648,7 @@ module Aws::SQS
1550
1648
  # An identifier for a message in this batch used to communicate the
1551
1649
  # result.
1552
1650
  #
1553
- # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
1651
+ # <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
1554
1652
  #
1555
1653
  # This identifier can have up to 80 characters. The following
1556
1654
  # characters are accepted: alphanumeric characters, hyphens(-), and
@@ -1592,7 +1690,7 @@ module Aws::SQS
1592
1690
  #
1593
1691
  # * Currently, the only supported message system attribute is
1594
1692
  # `AWSTraceHeader`. Its type must be `String` and its value must be
1595
- # a correctly formatted AWS X-Ray trace string.
1693
+ # a correctly formatted AWS X-Ray trace header string.
1596
1694
  #
1597
1695
  # * The size of a message system attribute doesn't count towards the
1598
1696
  # total size of a message.
@@ -1710,6 +1808,7 @@ module Aws::SQS
1710
1808
  :message_system_attributes,
1711
1809
  :message_deduplication_id,
1712
1810
  :message_group_id)
1811
+ SENSITIVE = []
1713
1812
  include Aws::Structure
1714
1813
  end
1715
1814
 
@@ -1731,6 +1830,7 @@ module Aws::SQS
1731
1830
  class SendMessageBatchResult < Struct.new(
1732
1831
  :successful,
1733
1832
  :failed)
1833
+ SENSITIVE = []
1734
1834
  include Aws::Structure
1735
1835
  end
1736
1836
 
@@ -1800,6 +1900,7 @@ module Aws::SQS
1800
1900
  :md5_of_message_attributes,
1801
1901
  :md5_of_message_system_attributes,
1802
1902
  :sequence_number)
1903
+ SENSITIVE = []
1803
1904
  include Aws::Structure
1804
1905
  end
1805
1906
 
@@ -1884,7 +1985,7 @@ module Aws::SQS
1884
1985
  #
1885
1986
  # * Currently, the only supported message system attribute is
1886
1987
  # `AWSTraceHeader`. Its type must be `String` and its value must be
1887
- # a correctly formatted AWS X-Ray trace string.
1988
+ # a correctly formatted AWS X-Ray trace header string.
1888
1989
  #
1889
1990
  # * The size of a message system attribute doesn't count towards the
1890
1991
  # total size of a message.
@@ -1941,7 +2042,7 @@ module Aws::SQS
1941
2042
  #
1942
2043
  # </note>
1943
2044
  #
1944
- # The length of `MessageDeduplicationId` is 128 characters.
2045
+ # The maximum length of `MessageDeduplicationId` is 128 characters.
1945
2046
  # `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
1946
2047
  # `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
1947
2048
  # ``).
@@ -2002,6 +2103,7 @@ module Aws::SQS
2002
2103
  :message_system_attributes,
2003
2104
  :message_deduplication_id,
2004
2105
  :message_group_id)
2106
+ SENSITIVE = []
2005
2107
  include Aws::Structure
2006
2108
  end
2007
2109
 
@@ -2066,6 +2168,7 @@ module Aws::SQS
2066
2168
  :md5_of_message_system_attributes,
2067
2169
  :message_id,
2068
2170
  :sequence_number)
2171
+ SENSITIVE = []
2069
2172
  include Aws::Structure
2070
2173
  end
2071
2174
 
@@ -2092,40 +2195,40 @@ module Aws::SQS
2092
2195
  # special request parameters that the `SetQueueAttributes` action
2093
2196
  # uses:
2094
2197
  #
2095
- # * `DelaySeconds` - The length of time, in seconds, for which the
2198
+ # * `DelaySeconds` The length of time, in seconds, for which the
2096
2199
  # delivery of all messages in the queue is delayed. Valid values: An
2097
2200
  # integer from 0 to 900 (15 minutes). Default: 0.
2098
2201
  #
2099
- # * `MaximumMessageSize` - The limit of how many bytes a message can
2202
+ # * `MaximumMessageSize` The limit of how many bytes a message can
2100
2203
  # contain before Amazon SQS rejects it. Valid values: An integer
2101
2204
  # from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
2102
2205
  # 262,144 (256 KiB).
2103
2206
  #
2104
- # * `MessageRetentionPeriod` - The length of time, in seconds, for
2207
+ # * `MessageRetentionPeriod` The length of time, in seconds, for
2105
2208
  # which Amazon SQS retains a message. Valid values: An integer
2106
2209
  # representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
2107
2210
  # Default: 345,600 (4 days).
2108
2211
  #
2109
- # * `Policy` - The queue's policy. A valid AWS policy. For more
2212
+ # * `Policy` The queue's policy. A valid AWS policy. For more
2110
2213
  # information about policy structure, see [Overview of AWS IAM
2111
2214
  # Policies][1] in the *Amazon IAM User Guide*.
2112
2215
  #
2113
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
2216
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
2114
2217
  # for which a ` ReceiveMessage ` action waits for a message to
2115
- # arrive. Valid values: an integer from 0 to 20 (seconds). Default:
2218
+ # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
2116
2219
  # 0.
2117
2220
  #
2118
- # * `RedrivePolicy` - The string that includes the parameters for the
2119
- # dead-letter queue functionality of the source queue. For more
2120
- # information about the redrive policy and dead-letter queues, see
2121
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
2122
- # Queue Service Developer Guide*.
2221
+ # * `RedrivePolicy` The string that includes the parameters for the
2222
+ # dead-letter queue functionality of the source queue as a JSON
2223
+ # object. For more information about the redrive policy and
2224
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
2225
+ # in the *Amazon Simple Queue Service Developer Guide*.
2123
2226
  #
2124
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
2227
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
2125
2228
  # dead-letter queue to which Amazon SQS moves messages after the
2126
2229
  # value of `maxReceiveCount` is exceeded.
2127
2230
  #
2128
- # * `maxReceiveCount` - The number of times a message is delivered
2231
+ # * `maxReceiveCount` The number of times a message is delivered
2129
2232
  # to the source queue before being moved to the dead-letter queue.
2130
2233
  # When the `ReceiveCount` for a message exceeds the
2131
2234
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
@@ -2137,22 +2240,22 @@ module Aws::SQS
2137
2240
  #
2138
2241
  # </note>
2139
2242
  #
2140
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
2141
- # seconds. Valid values: an integer from 0 to 43,200 (12 hours).
2243
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
2244
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2142
2245
  # Default: 30. For more information about the visibility timeout,
2143
2246
  # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
2144
2247
  # Developer Guide*.
2145
2248
  #
2146
2249
  # The following attributes apply only to [server-side-encryption][4]\:
2147
2250
  #
2148
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
2251
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
2149
2252
  # (CMK) for Amazon SQS or a custom CMK. For more information, see
2150
2253
  # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
2151
2254
  # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
2152
2255
  # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
2153
2256
  # the *AWS Key Management Service API Reference*.
2154
2257
  #
2155
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
2258
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds,
2156
2259
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
2157
2260
  # decrypt messages before calling AWS KMS again. An integer
2158
2261
  # representing seconds, between 60 seconds (1 minute) and 86,400
@@ -2164,7 +2267,7 @@ module Aws::SQS
2164
2267
  # The following attribute applies only to [FIFO (first-in-first-out)
2165
2268
  # queues][9]\:
2166
2269
  #
2167
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
2270
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
2168
2271
  # For more information, see [Exactly-Once Processing][10] in the
2169
2272
  # *Amazon Simple Queue Service Developer Guide*.
2170
2273
  #
@@ -2215,6 +2318,7 @@ module Aws::SQS
2215
2318
  class SetQueueAttributesRequest < Struct.new(
2216
2319
  :queue_url,
2217
2320
  :attributes)
2321
+ SENSITIVE = []
2218
2322
  include Aws::Structure
2219
2323
  end
2220
2324
 
@@ -2241,6 +2345,7 @@ module Aws::SQS
2241
2345
  class TagQueueRequest < Struct.new(
2242
2346
  :queue_url,
2243
2347
  :tags)
2348
+ SENSITIVE = []
2244
2349
  include Aws::Structure
2245
2350
  end
2246
2351
 
@@ -2277,6 +2382,7 @@ module Aws::SQS
2277
2382
  class UntagQueueRequest < Struct.new(
2278
2383
  :queue_url,
2279
2384
  :tag_keys)
2385
+ SENSITIVE = []
2280
2386
  include Aws::Structure
2281
2387
  end
2282
2388