aws-sdk-sqs 1.27.1 → 1.28.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sqs.rb +3 -1
- data/lib/aws-sdk-sqs/client.rb +137 -97
- data/lib/aws-sdk-sqs/client_api.rb +22 -0
- data/lib/aws-sdk-sqs/customizations.rb +2 -0
- data/lib/aws-sdk-sqs/errors.rb +2 -0
- data/lib/aws-sdk-sqs/message.rb +2 -0
- data/lib/aws-sdk-sqs/plugins/md5s.rb +2 -0
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +2 -0
- data/lib/aws-sdk-sqs/queue.rb +56 -41
- data/lib/aws-sdk-sqs/queue_poller.rb +2 -0
- data/lib/aws-sdk-sqs/resource.rb +28 -24
- data/lib/aws-sdk-sqs/types.rb +151 -86
- metadata +2 -2
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -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:
|
@@ -93,7 +95,8 @@ module Aws::SQS
|
|
93
95
|
# @return [String]
|
94
96
|
#
|
95
97
|
# @!attribute [rw] sender_fault
|
96
|
-
# Specifies whether the error happened due to the
|
98
|
+
# Specifies whether the error happened due to the caller of the batch
|
99
|
+
# API action.
|
97
100
|
# @return [Boolean]
|
98
101
|
#
|
99
102
|
# @!attribute [rw] code
|
@@ -175,7 +178,11 @@ module Aws::SQS
|
|
175
178
|
# An identifier for this particular receipt handle used to communicate
|
176
179
|
# the result.
|
177
180
|
#
|
178
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
181
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
182
|
+
#
|
183
|
+
# This identifier can have up to 80 characters. The following
|
184
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
185
|
+
# underscores (\_).
|
179
186
|
#
|
180
187
|
# </note>
|
181
188
|
# @return [String]
|
@@ -299,40 +306,40 @@ module Aws::SQS
|
|
299
306
|
# The following lists the names, descriptions, and values of the
|
300
307
|
# special request parameters that the `CreateQueue` action uses:
|
301
308
|
#
|
302
|
-
# * `DelaySeconds`
|
309
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
303
310
|
# delivery of all messages in the queue is delayed. Valid values: An
|
304
311
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
305
312
|
#
|
306
|
-
# * `MaximumMessageSize`
|
313
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
307
314
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
308
315
|
# from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
|
309
316
|
# 262,144 (256 KiB).
|
310
317
|
#
|
311
|
-
# * `MessageRetentionPeriod`
|
318
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
312
319
|
# which Amazon SQS retains a message. Valid values: An integer from
|
313
320
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
314
321
|
# 345,600 (4 days).
|
315
322
|
#
|
316
|
-
# * `Policy`
|
323
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
317
324
|
# information about policy structure, see [Overview of AWS IAM
|
318
325
|
# Policies][1] in the *Amazon IAM User Guide*.
|
319
326
|
#
|
320
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
327
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
321
328
|
# for which a ` ReceiveMessage ` action waits for a message to
|
322
329
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
323
330
|
# 0.
|
324
331
|
#
|
325
|
-
# * `RedrivePolicy`
|
326
|
-
# dead-letter queue functionality of the source queue
|
327
|
-
# information about the redrive policy and
|
328
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
329
|
-
# Queue Service Developer Guide*.
|
332
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
333
|
+
# dead-letter queue functionality of the source queue as a JSON
|
334
|
+
# object. For more information about the redrive policy and
|
335
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
336
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
330
337
|
#
|
331
|
-
# * `deadLetterTargetArn`
|
338
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
332
339
|
# dead-letter queue to which Amazon SQS moves messages after the
|
333
340
|
# value of `maxReceiveCount` is exceeded.
|
334
341
|
#
|
335
|
-
# * `maxReceiveCount`
|
342
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
336
343
|
# to the source queue before being moved to the dead-letter queue.
|
337
344
|
# When the `ReceiveCount` for a message exceeds the
|
338
345
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -344,7 +351,7 @@ module Aws::SQS
|
|
344
351
|
#
|
345
352
|
# </note>
|
346
353
|
#
|
347
|
-
# * `VisibilityTimeout`
|
354
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
348
355
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
349
356
|
# Default: 30. For more information about the visibility timeout,
|
350
357
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -352,14 +359,14 @@ module Aws::SQS
|
|
352
359
|
#
|
353
360
|
# The following attributes apply only to [server-side-encryption][4]\:
|
354
361
|
#
|
355
|
-
# * `KmsMasterKeyId`
|
362
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
356
363
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
357
364
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
358
365
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
359
366
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
360
367
|
# the *AWS Key Management Service API Reference*.
|
361
368
|
#
|
362
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
369
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
363
370
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
364
371
|
# decrypt messages before calling AWS KMS again. An integer
|
365
372
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -371,7 +378,7 @@ module Aws::SQS
|
|
371
378
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
372
379
|
# queues][9]\:
|
373
380
|
#
|
374
|
-
# * `FifoQueue`
|
381
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
375
382
|
# `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
376
383
|
# SQS creates a standard queue. You can provide this attribute only
|
377
384
|
# during queue creation. You can't change it for an existing queue.
|
@@ -381,7 +388,7 @@ module Aws::SQS
|
|
381
388
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
382
389
|
# Simple Queue Service Developer Guide*.
|
383
390
|
#
|
384
|
-
# * `ContentBasedDeduplication`
|
391
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
385
392
|
# Valid values: `true`, `false`. For more information, see
|
386
393
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
387
394
|
# Developer Guide*.
|
@@ -532,7 +539,11 @@ module Aws::SQS
|
|
532
539
|
# An identifier for this particular receipt handle. This is used to
|
533
540
|
# communicate the result.
|
534
541
|
#
|
535
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
542
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
543
|
+
#
|
544
|
+
# This identifier can have up to 80 characters. The following
|
545
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
546
|
+
# underscores (\_).
|
536
547
|
#
|
537
548
|
# </note>
|
538
549
|
# @return [String]
|
@@ -660,74 +671,81 @@ module Aws::SQS
|
|
660
671
|
#
|
661
672
|
# The following attributes are supported:
|
662
673
|
#
|
663
|
-
#
|
674
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
675
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
676
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
677
|
+
# consistency until at least 1 minute after the producers stop sending
|
678
|
+
# messages. This period is required for the queue metadata to reach
|
679
|
+
# eventual consistency.
|
680
|
+
#
|
681
|
+
# * `All` – Returns all values.
|
664
682
|
#
|
665
|
-
# * `ApproximateNumberOfMessages`
|
683
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
666
684
|
# messages available for retrieval from the queue.
|
667
685
|
#
|
668
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
686
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
669
687
|
# number of messages in the queue that are delayed and not available
|
670
688
|
# for reading immediately. This can happen when the queue is
|
671
689
|
# configured as a delay queue or when a message has been sent with a
|
672
690
|
# delay parameter.
|
673
691
|
#
|
674
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
692
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
675
693
|
# number of messages that are in flight. Messages are considered to
|
676
694
|
# be *in flight* if they have been sent to a client but have not yet
|
677
695
|
# been deleted or have not yet reached the end of their visibility
|
678
696
|
# window.
|
679
697
|
#
|
680
|
-
# * `CreatedTimestamp`
|
698
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created
|
681
699
|
# in seconds ([epoch time][1]).
|
682
700
|
#
|
683
|
-
# * `DelaySeconds`
|
701
|
+
# * `DelaySeconds` – Returns the default delay on the queue in
|
684
702
|
# seconds.
|
685
703
|
#
|
686
|
-
# * `LastModifiedTimestamp`
|
704
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
687
705
|
# changed in seconds ([epoch time][1]).
|
688
706
|
#
|
689
|
-
# * `MaximumMessageSize`
|
707
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a
|
690
708
|
# message can contain before Amazon SQS rejects it.
|
691
709
|
#
|
692
|
-
# * `MessageRetentionPeriod`
|
710
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
693
711
|
# for which Amazon SQS retains a message.
|
694
712
|
#
|
695
|
-
# * `Policy`
|
713
|
+
# * `Policy` – Returns the policy of the queue.
|
696
714
|
#
|
697
|
-
# * `QueueArn`
|
715
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
698
716
|
#
|
699
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
717
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
700
718
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
701
719
|
# to arrive.
|
702
720
|
#
|
703
|
-
# * `RedrivePolicy`
|
704
|
-
#
|
705
|
-
# information about the redrive policy and
|
706
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
707
|
-
# Queue Service Developer Guide*.
|
721
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
722
|
+
# dead-letter queue functionality of the source queue as a JSON
|
723
|
+
# object. For more information about the redrive policy and
|
724
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
725
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
708
726
|
#
|
709
|
-
# * `deadLetterTargetArn`
|
727
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
710
728
|
# dead-letter queue to which Amazon SQS moves messages after the
|
711
729
|
# value of `maxReceiveCount` is exceeded.
|
712
730
|
#
|
713
|
-
# * `maxReceiveCount`
|
731
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
714
732
|
# to the source queue before being moved to the dead-letter queue.
|
715
733
|
# When the `ReceiveCount` for a message exceeds the
|
716
734
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
717
735
|
# the dead-letter-queue.
|
718
736
|
#
|
719
|
-
# * `VisibilityTimeout`
|
737
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
720
738
|
# queue. For more information about the visibility timeout, see
|
721
739
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
722
740
|
# Developer Guide*.
|
723
741
|
#
|
724
742
|
# The following attributes apply only to [server-side-encryption][4]\:
|
725
743
|
#
|
726
|
-
# * `KmsMasterKeyId`
|
744
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer
|
727
745
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
728
746
|
# information, see [Key Terms][5].
|
729
747
|
#
|
730
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
748
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
731
749
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
732
750
|
# decrypt messages before calling AWS KMS again. For more
|
733
751
|
# information, see [How Does the Data Key Reuse Period Work?][6].
|
@@ -735,7 +753,7 @@ module Aws::SQS
|
|
735
753
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
736
754
|
# queues][7]\:
|
737
755
|
#
|
738
|
-
# * `FifoQueue`
|
756
|
+
# * `FifoQueue` – Returns whether the queue is FIFO. For more
|
739
757
|
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
740
758
|
# Service Developer Guide*.
|
741
759
|
#
|
@@ -744,7 +762,7 @@ module Aws::SQS
|
|
744
762
|
#
|
745
763
|
# </note>
|
746
764
|
#
|
747
|
-
# * `ContentBasedDeduplication`
|
765
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
748
766
|
# deduplication is enabled for the queue. For more information, see
|
749
767
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
750
768
|
# Developer Guide*.
|
@@ -859,6 +877,8 @@ module Aws::SQS
|
|
859
877
|
#
|
860
878
|
# {
|
861
879
|
# queue_url: "String", # required
|
880
|
+
# next_token: "Token",
|
881
|
+
# max_results: 1,
|
862
882
|
# }
|
863
883
|
#
|
864
884
|
# @!attribute [rw] queue_url
|
@@ -867,10 +887,20 @@ module Aws::SQS
|
|
867
887
|
# Queue URLs and names are case-sensitive.
|
868
888
|
# @return [String]
|
869
889
|
#
|
890
|
+
# @!attribute [rw] next_token
|
891
|
+
# Pagination token to request the next set of results.
|
892
|
+
# @return [String]
|
893
|
+
#
|
894
|
+
# @!attribute [rw] max_results
|
895
|
+
# Maximum number of results to include in the response.
|
896
|
+
# @return [Integer]
|
897
|
+
#
|
870
898
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
|
871
899
|
#
|
872
900
|
class ListDeadLetterSourceQueuesRequest < Struct.new(
|
873
|
-
:queue_url
|
901
|
+
:queue_url,
|
902
|
+
:next_token,
|
903
|
+
:max_results)
|
874
904
|
include Aws::Structure
|
875
905
|
end
|
876
906
|
|
@@ -881,10 +911,15 @@ module Aws::SQS
|
|
881
911
|
# attribute configured with a dead-letter queue.
|
882
912
|
# @return [Array<String>]
|
883
913
|
#
|
914
|
+
# @!attribute [rw] next_token
|
915
|
+
# Pagination token to include in the next request.
|
916
|
+
# @return [String]
|
917
|
+
#
|
884
918
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
|
885
919
|
#
|
886
920
|
class ListDeadLetterSourceQueuesResult < Struct.new(
|
887
|
-
:queue_urls
|
921
|
+
:queue_urls,
|
922
|
+
:next_token)
|
888
923
|
include Aws::Structure
|
889
924
|
end
|
890
925
|
|
@@ -922,6 +957,8 @@ module Aws::SQS
|
|
922
957
|
#
|
923
958
|
# {
|
924
959
|
# queue_name_prefix: "String",
|
960
|
+
# next_token: "Token",
|
961
|
+
# max_results: 1,
|
925
962
|
# }
|
926
963
|
#
|
927
964
|
# @!attribute [rw] queue_name_prefix
|
@@ -931,23 +968,39 @@ module Aws::SQS
|
|
931
968
|
# Queue URLs and names are case-sensitive.
|
932
969
|
# @return [String]
|
933
970
|
#
|
971
|
+
# @!attribute [rw] next_token
|
972
|
+
# Pagination token to request the next set of results.
|
973
|
+
# @return [String]
|
974
|
+
#
|
975
|
+
# @!attribute [rw] max_results
|
976
|
+
# Maximum number of results to include in the response.
|
977
|
+
# @return [Integer]
|
978
|
+
#
|
934
979
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
|
935
980
|
#
|
936
981
|
class ListQueuesRequest < Struct.new(
|
937
|
-
:queue_name_prefix
|
982
|
+
:queue_name_prefix,
|
983
|
+
:next_token,
|
984
|
+
:max_results)
|
938
985
|
include Aws::Structure
|
939
986
|
end
|
940
987
|
|
941
988
|
# A list of your queues.
|
942
989
|
#
|
943
990
|
# @!attribute [rw] queue_urls
|
944
|
-
# A list of queue URLs, up to 1,000 entries
|
991
|
+
# A list of queue URLs, up to 1,000 entries, or the value of
|
992
|
+
# MaxResults that you sent in the request.
|
945
993
|
# @return [Array<String>]
|
946
994
|
#
|
995
|
+
# @!attribute [rw] next_token
|
996
|
+
# Pagination token to include in the next request.
|
997
|
+
# @return [String]
|
998
|
+
#
|
947
999
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult AWS API Documentation
|
948
1000
|
#
|
949
1001
|
class ListQueuesResult < Struct.new(
|
950
|
-
:queue_urls
|
1002
|
+
:queue_urls,
|
1003
|
+
:next_token)
|
951
1004
|
include Aws::Structure
|
952
1005
|
end
|
953
1006
|
|
@@ -1261,16 +1314,16 @@ module Aws::SQS
|
|
1261
1314
|
# A list of attributes that need to be returned along with each
|
1262
1315
|
# message. These attributes include:
|
1263
1316
|
#
|
1264
|
-
# * `All`
|
1317
|
+
# * `All` – Returns all values.
|
1265
1318
|
#
|
1266
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1319
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1267
1320
|
# was first received from the queue ([epoch time][1] in
|
1268
1321
|
# milliseconds).
|
1269
1322
|
#
|
1270
|
-
# * `ApproximateReceiveCount`
|
1271
|
-
# has been received
|
1323
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1324
|
+
# has been received across all queues but not deleted.
|
1272
1325
|
#
|
1273
|
-
# * `AWSTraceHeader`
|
1326
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1274
1327
|
#
|
1275
1328
|
# * `SenderId`
|
1276
1329
|
#
|
@@ -1280,17 +1333,17 @@ module Aws::SQS
|
|
1280
1333
|
# * For an IAM role, returns the IAM role ID, for example
|
1281
1334
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1282
1335
|
#
|
1283
|
-
# * `SentTimestamp`
|
1336
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1284
1337
|
# queue ([epoch time][1] in milliseconds).
|
1285
1338
|
#
|
1286
|
-
# * `MessageDeduplicationId`
|
1339
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1287
1340
|
# producer that calls the ` SendMessage ` action.
|
1288
1341
|
#
|
1289
|
-
# * `MessageGroupId`
|
1342
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1290
1343
|
# calls the ` SendMessage ` action. Messages with the same
|
1291
1344
|
# `MessageGroupId` are returned in sequence.
|
1292
1345
|
#
|
1293
|
-
# * `SequenceNumber`
|
1346
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1294
1347
|
#
|
1295
1348
|
#
|
1296
1349
|
#
|
@@ -1338,6 +1391,18 @@ module Aws::SQS
|
|
1338
1391
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1339
1392
|
# available and the wait time expires, the call returns successfully
|
1340
1393
|
# with an empty list of messages.
|
1394
|
+
#
|
1395
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1396
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1397
|
+
# parameter. For example, with the Java SDK, you can set HTTP
|
1398
|
+
# transport settings using the [ NettyNioAsyncHttpClient][1] for
|
1399
|
+
# asynchronous clients, or the [ ApacheHttpClient][2] for synchronous
|
1400
|
+
# clients.
|
1401
|
+
#
|
1402
|
+
#
|
1403
|
+
#
|
1404
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1405
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1341
1406
|
# @return [Integer]
|
1342
1407
|
#
|
1343
1408
|
# @!attribute [rw] receive_request_attempt_id
|
@@ -1345,10 +1410,10 @@ module Aws::SQS
|
|
1345
1410
|
#
|
1346
1411
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1347
1412
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1348
|
-
# of a response you receive a generic error,
|
1349
|
-
# action with an identical `ReceiveRequestAttemptId` to
|
1350
|
-
# same set of messages, even if their visibility timeout
|
1351
|
-
# expired.
|
1413
|
+
# of a response you receive a generic error, it is possible to retry
|
1414
|
+
# the same action with an identical `ReceiveRequestAttemptId` to
|
1415
|
+
# retrieve the same set of messages, even if their visibility timeout
|
1416
|
+
# has not yet expired.
|
1352
1417
|
#
|
1353
1418
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
1354
1419
|
# `ReceiveMessage` action.
|
@@ -1360,7 +1425,7 @@ module Aws::SQS
|
|
1360
1425
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1361
1426
|
# `ReceiveRequestAttemptId`.
|
1362
1427
|
#
|
1363
|
-
# *
|
1428
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1364
1429
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1365
1430
|
# modified (deleted or had their visibility changes).
|
1366
1431
|
#
|
@@ -1394,7 +1459,7 @@ module Aws::SQS
|
|
1394
1459
|
# visibility timeout expires. As a result, delays might occur but
|
1395
1460
|
# the messages in the queue remain in a strict order.
|
1396
1461
|
#
|
1397
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1462
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1398
1463
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters
|
1399
1464
|
# (`a-z`, `A-Z`, `0-9`) and punctuation (``
|
1400
1465
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
@@ -1550,7 +1615,7 @@ module Aws::SQS
|
|
1550
1615
|
# An identifier for a message in this batch used to communicate the
|
1551
1616
|
# result.
|
1552
1617
|
#
|
1553
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
1618
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
1554
1619
|
#
|
1555
1620
|
# This identifier can have up to 80 characters. The following
|
1556
1621
|
# characters are accepted: alphanumeric characters, hyphens(-), and
|
@@ -1592,7 +1657,7 @@ module Aws::SQS
|
|
1592
1657
|
#
|
1593
1658
|
# * Currently, the only supported message system attribute is
|
1594
1659
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1595
|
-
# a correctly formatted AWS X-Ray trace string.
|
1660
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1596
1661
|
#
|
1597
1662
|
# * The size of a message system attribute doesn't count towards the
|
1598
1663
|
# total size of a message.
|
@@ -1884,7 +1949,7 @@ module Aws::SQS
|
|
1884
1949
|
#
|
1885
1950
|
# * Currently, the only supported message system attribute is
|
1886
1951
|
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1887
|
-
# a correctly formatted AWS X-Ray trace string.
|
1952
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1888
1953
|
#
|
1889
1954
|
# * The size of a message system attribute doesn't count towards the
|
1890
1955
|
# total size of a message.
|
@@ -1941,7 +2006,7 @@ module Aws::SQS
|
|
1941
2006
|
#
|
1942
2007
|
# </note>
|
1943
2008
|
#
|
1944
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
2009
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1945
2010
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1946
2011
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1947
2012
|
# ``).
|
@@ -2092,40 +2157,40 @@ module Aws::SQS
|
|
2092
2157
|
# special request parameters that the `SetQueueAttributes` action
|
2093
2158
|
# uses:
|
2094
2159
|
#
|
2095
|
-
# * `DelaySeconds`
|
2160
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2096
2161
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2097
2162
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2098
2163
|
#
|
2099
|
-
# * `MaximumMessageSize`
|
2164
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2100
2165
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
2101
2166
|
# from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
|
2102
2167
|
# 262,144 (256 KiB).
|
2103
2168
|
#
|
2104
|
-
# * `MessageRetentionPeriod`
|
2169
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2105
2170
|
# which Amazon SQS retains a message. Valid values: An integer
|
2106
2171
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2107
2172
|
# Default: 345,600 (4 days).
|
2108
2173
|
#
|
2109
|
-
# * `Policy`
|
2174
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2110
2175
|
# information about policy structure, see [Overview of AWS IAM
|
2111
2176
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2112
2177
|
#
|
2113
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2178
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2114
2179
|
# for which a ` ReceiveMessage ` action waits for a message to
|
2115
|
-
# arrive. Valid values:
|
2180
|
+
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2116
2181
|
# 0.
|
2117
2182
|
#
|
2118
|
-
# * `RedrivePolicy`
|
2119
|
-
# dead-letter queue functionality of the source queue
|
2120
|
-
# information about the redrive policy and
|
2121
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
2122
|
-
# Queue Service Developer Guide*.
|
2183
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2184
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2185
|
+
# object. For more information about the redrive policy and
|
2186
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2187
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
2123
2188
|
#
|
2124
|
-
# * `deadLetterTargetArn`
|
2189
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2125
2190
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2126
2191
|
# value of `maxReceiveCount` is exceeded.
|
2127
2192
|
#
|
2128
|
-
# * `maxReceiveCount`
|
2193
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
2129
2194
|
# to the source queue before being moved to the dead-letter queue.
|
2130
2195
|
# When the `ReceiveCount` for a message exceeds the
|
2131
2196
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -2137,22 +2202,22 @@ module Aws::SQS
|
|
2137
2202
|
#
|
2138
2203
|
# </note>
|
2139
2204
|
#
|
2140
|
-
# * `VisibilityTimeout`
|
2141
|
-
# seconds. Valid values:
|
2205
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2206
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2142
2207
|
# Default: 30. For more information about the visibility timeout,
|
2143
2208
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2144
2209
|
# Developer Guide*.
|
2145
2210
|
#
|
2146
2211
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2147
2212
|
#
|
2148
|
-
# * `KmsMasterKeyId`
|
2213
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2149
2214
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
2150
2215
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
2151
2216
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
2152
2217
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
2153
2218
|
# the *AWS Key Management Service API Reference*.
|
2154
2219
|
#
|
2155
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2220
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
2156
2221
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
2157
2222
|
# decrypt messages before calling AWS KMS again. An integer
|
2158
2223
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -2164,7 +2229,7 @@ module Aws::SQS
|
|
2164
2229
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2165
2230
|
# queues][9]\:
|
2166
2231
|
#
|
2167
|
-
# * `ContentBasedDeduplication`
|
2232
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2168
2233
|
# For more information, see [Exactly-Once Processing][10] in the
|
2169
2234
|
# *Amazon Simple Queue Service Developer Guide*.
|
2170
2235
|
#
|