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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d5803fb0f4bbadd6e4c21dadd624fc1b369c3ea9f08dadf356efa073b3e2f275
|
4
|
+
data.tar.gz: 7cd8948f69417a05fded15b172e60857154338166dc9807a9e22470ebb3d93fd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8750e14b758edc5d053b27baff6d1802a174faf4209192eb9b9cad55f43b884c6ff370266fc103c3ae6b689e2506266f1661d10b2855fb457d841162b84ade5a
|
7
|
+
data.tar.gz: 361190453cf67c29bd8428eaf346c4f4d4f1082ef528e060bf4aee870dd658d0b42eac31d3ea0c57a2e796ed56a0527584a455fc624a3cb57ef7d6de4e5cb671
|
data/lib/aws-sdk-sqs.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:
|
@@ -47,6 +49,6 @@ require_relative 'aws-sdk-sqs/customizations'
|
|
47
49
|
# @service
|
48
50
|
module Aws::SQS
|
49
51
|
|
50
|
-
GEM_VERSION = '1.
|
52
|
+
GEM_VERSION = '1.28.0'
|
51
53
|
|
52
54
|
end
|
data/lib/aws-sdk-sqs/client.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:
|
@@ -346,9 +348,9 @@ module Aws::SQS
|
|
346
348
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
347
349
|
# For example, a parameter list with two elements looks like this:
|
348
350
|
#
|
349
|
-
# `&
|
351
|
+
# `&AttributeName.1=first`
|
350
352
|
#
|
351
|
-
# `&
|
353
|
+
# `&AttributeName.2=second`
|
352
354
|
#
|
353
355
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
354
356
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -535,9 +537,9 @@ module Aws::SQS
|
|
535
537
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
536
538
|
# For example, a parameter list with two elements looks like this:
|
537
539
|
#
|
538
|
-
# `&
|
540
|
+
# `&AttributeName.1=first`
|
539
541
|
#
|
540
|
-
# `&
|
542
|
+
# `&AttributeName.2=second`
|
541
543
|
#
|
542
544
|
# @option params [required, String] :queue_url
|
543
545
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
@@ -587,7 +589,7 @@ module Aws::SQS
|
|
587
589
|
end
|
588
590
|
|
589
591
|
# Creates a new standard or FIFO queue. You can pass one or more
|
590
|
-
# attributes in the request. Keep the following
|
592
|
+
# attributes in the request. Keep the following in mind:
|
591
593
|
#
|
592
594
|
# * If you don't specify the `FifoQueue` attribute, Amazon SQS creates
|
593
595
|
# a standard queue.
|
@@ -611,6 +613,11 @@ module Aws::SQS
|
|
611
613
|
# adheres to the [limits related to queues][2] and is unique within the
|
612
614
|
# scope of your queues.
|
613
615
|
#
|
616
|
+
# <note markdown="1"> After you create a queue, you must wait at least one second after the
|
617
|
+
# queue is created to be able to use the queue.
|
618
|
+
#
|
619
|
+
# </note>
|
620
|
+
#
|
614
621
|
# To get the queue URL, use the ` GetQueueUrl ` action. ` GetQueueUrl `
|
615
622
|
# requires only the `QueueName` parameter. be aware of existing queue
|
616
623
|
# names:
|
@@ -626,9 +633,9 @@ module Aws::SQS
|
|
626
633
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
627
634
|
# For example, a parameter list with two elements looks like this:
|
628
635
|
#
|
629
|
-
# `&
|
636
|
+
# `&AttributeName.1=first`
|
630
637
|
#
|
631
|
-
# `&
|
638
|
+
# `&AttributeName.2=second`
|
632
639
|
#
|
633
640
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
634
641
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -660,39 +667,39 @@ module Aws::SQS
|
|
660
667
|
# The following lists the names, descriptions, and values of the special
|
661
668
|
# request parameters that the `CreateQueue` action uses:
|
662
669
|
#
|
663
|
-
# * `DelaySeconds`
|
670
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
664
671
|
# delivery of all messages in the queue is delayed. Valid values: An
|
665
672
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
666
673
|
#
|
667
|
-
# * `MaximumMessageSize`
|
674
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
668
675
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
669
676
|
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
|
670
677
|
# (256 KiB).
|
671
678
|
#
|
672
|
-
# * `MessageRetentionPeriod`
|
679
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
673
680
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
674
681
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
675
682
|
# (4 days).
|
676
683
|
#
|
677
|
-
# * `Policy`
|
684
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
678
685
|
# information about policy structure, see [Overview of AWS IAM
|
679
686
|
# Policies][1] in the *Amazon IAM User Guide*.
|
680
687
|
#
|
681
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
688
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
682
689
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
683
690
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
684
691
|
#
|
685
|
-
# * `RedrivePolicy`
|
686
|
-
# dead-letter queue functionality of the source queue
|
687
|
-
# information about the redrive policy and
|
688
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
689
|
-
# Service Developer Guide*.
|
692
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
693
|
+
# dead-letter queue functionality of the source queue as a JSON
|
694
|
+
# object. For more information about the redrive policy and
|
695
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
696
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
690
697
|
#
|
691
|
-
# * `deadLetterTargetArn`
|
698
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
692
699
|
# dead-letter queue to which Amazon SQS moves messages after the
|
693
700
|
# value of `maxReceiveCount` is exceeded.
|
694
701
|
#
|
695
|
-
# * `maxReceiveCount`
|
702
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
696
703
|
# the source queue before being moved to the dead-letter queue. When
|
697
704
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
698
705
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -703,7 +710,7 @@ module Aws::SQS
|
|
703
710
|
#
|
704
711
|
# </note>
|
705
712
|
#
|
706
|
-
# * `VisibilityTimeout`
|
713
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
707
714
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
708
715
|
# Default: 30. For more information about the visibility timeout, see
|
709
716
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -711,14 +718,14 @@ module Aws::SQS
|
|
711
718
|
#
|
712
719
|
# The following attributes apply only to [server-side-encryption][4]\:
|
713
720
|
#
|
714
|
-
# * `KmsMasterKeyId`
|
721
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
715
722
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
716
723
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
717
724
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
718
725
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
719
726
|
# Key Management Service API Reference*.
|
720
727
|
#
|
721
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
728
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
722
729
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
723
730
|
# messages before calling AWS KMS again. An integer representing
|
724
731
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -730,7 +737,7 @@ module Aws::SQS
|
|
730
737
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
731
738
|
# queues][9]\:
|
732
739
|
#
|
733
|
-
# * `FifoQueue`
|
740
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
734
741
|
# `false`. If you don't specify the `FifoQueue` attribute, Amazon SQS
|
735
742
|
# creates a standard queue. You can provide this attribute only during
|
736
743
|
# queue creation. You can't change it for an existing queue. When you
|
@@ -740,7 +747,7 @@ module Aws::SQS
|
|
740
747
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
741
748
|
# Simple Queue Service Developer Guide*.
|
742
749
|
#
|
743
|
-
# * `ContentBasedDeduplication`
|
750
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
744
751
|
# Valid values: `true`, `false`. For more information, see
|
745
752
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
746
753
|
# Developer Guide*.
|
@@ -914,9 +921,9 @@ module Aws::SQS
|
|
914
921
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
915
922
|
# For example, a parameter list with two elements looks like this:
|
916
923
|
#
|
917
|
-
# `&
|
924
|
+
# `&AttributeName.1=first`
|
918
925
|
#
|
919
|
-
# `&
|
926
|
+
# `&AttributeName.2=second`
|
920
927
|
#
|
921
928
|
# @option params [required, String] :queue_url
|
922
929
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
@@ -963,8 +970,7 @@ module Aws::SQS
|
|
963
970
|
end
|
964
971
|
|
965
972
|
# Deletes the queue specified by the `QueueUrl`, regardless of the
|
966
|
-
# queue's contents.
|
967
|
-
# returns a successful response.
|
973
|
+
# queue's contents.
|
968
974
|
#
|
969
975
|
# Be careful with the `DeleteQueue` action: When you delete a queue, any
|
970
976
|
# messages in the queue are no longer available.
|
@@ -1016,14 +1022,6 @@ module Aws::SQS
|
|
1016
1022
|
#
|
1017
1023
|
# </note>
|
1018
1024
|
#
|
1019
|
-
# Some actions take lists of parameters. These lists are specified using
|
1020
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1021
|
-
# For example, a parameter list with two elements looks like this:
|
1022
|
-
#
|
1023
|
-
# `&Attribute.1=first`
|
1024
|
-
#
|
1025
|
-
# `&Attribute.2=second`
|
1026
|
-
#
|
1027
1025
|
#
|
1028
1026
|
#
|
1029
1027
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
@@ -1045,70 +1043,77 @@ module Aws::SQS
|
|
1045
1043
|
#
|
1046
1044
|
# The following attributes are supported:
|
1047
1045
|
#
|
1048
|
-
#
|
1046
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
1047
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
1048
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
1049
|
+
# consistency until at least 1 minute after the producers stop sending
|
1050
|
+
# messages. This period is required for the queue metadata to reach
|
1051
|
+
# eventual consistency.
|
1052
|
+
#
|
1053
|
+
# * `All` – Returns all values.
|
1049
1054
|
#
|
1050
|
-
# * `ApproximateNumberOfMessages`
|
1055
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
1051
1056
|
# messages available for retrieval from the queue.
|
1052
1057
|
#
|
1053
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
1058
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
1054
1059
|
# number of messages in the queue that are delayed and not available
|
1055
1060
|
# for reading immediately. This can happen when the queue is
|
1056
1061
|
# configured as a delay queue or when a message has been sent with a
|
1057
1062
|
# delay parameter.
|
1058
1063
|
#
|
1059
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
1064
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
1060
1065
|
# number of messages that are in flight. Messages are considered to be
|
1061
1066
|
# *in flight* if they have been sent to a client but have not yet been
|
1062
1067
|
# deleted or have not yet reached the end of their visibility window.
|
1063
1068
|
#
|
1064
|
-
# * `CreatedTimestamp`
|
1069
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created in
|
1065
1070
|
# seconds ([epoch time][1]).
|
1066
1071
|
#
|
1067
|
-
# * `DelaySeconds`
|
1072
|
+
# * `DelaySeconds` – Returns the default delay on the queue in seconds.
|
1068
1073
|
#
|
1069
|
-
# * `LastModifiedTimestamp`
|
1074
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
1070
1075
|
# changed in seconds ([epoch time][1]).
|
1071
1076
|
#
|
1072
|
-
# * `MaximumMessageSize`
|
1077
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a message
|
1073
1078
|
# can contain before Amazon SQS rejects it.
|
1074
1079
|
#
|
1075
|
-
# * `MessageRetentionPeriod`
|
1080
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1076
1081
|
# for which Amazon SQS retains a message.
|
1077
1082
|
#
|
1078
|
-
# * `Policy`
|
1083
|
+
# * `Policy` – Returns the policy of the queue.
|
1079
1084
|
#
|
1080
|
-
# * `QueueArn`
|
1085
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
1081
1086
|
#
|
1082
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
1087
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
1083
1088
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1084
1089
|
# to arrive.
|
1085
1090
|
#
|
1086
|
-
# * `RedrivePolicy`
|
1087
|
-
#
|
1088
|
-
# information about the redrive policy and
|
1089
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
1090
|
-
# Service Developer Guide*.
|
1091
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
1092
|
+
# dead-letter queue functionality of the source queue as a JSON
|
1093
|
+
# object. For more information about the redrive policy and
|
1094
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1095
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
1091
1096
|
#
|
1092
|
-
# * `deadLetterTargetArn`
|
1097
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1093
1098
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1094
1099
|
# value of `maxReceiveCount` is exceeded.
|
1095
1100
|
#
|
1096
|
-
# * `maxReceiveCount`
|
1101
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
1097
1102
|
# the source queue before being moved to the dead-letter queue. When
|
1098
1103
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
1099
1104
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
1100
1105
|
#
|
1101
|
-
# * `VisibilityTimeout`
|
1106
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1102
1107
|
# For more information about the visibility timeout, see [Visibility
|
1103
1108
|
# Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
|
1104
1109
|
#
|
1105
1110
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1106
1111
|
#
|
1107
|
-
# * `KmsMasterKeyId`
|
1112
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer master
|
1108
1113
|
# key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1109
1114
|
# [Key Terms][5].
|
1110
1115
|
#
|
1111
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
1116
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1112
1117
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1113
1118
|
# decrypt messages before calling AWS KMS again. For more information,
|
1114
1119
|
# see [How Does the Data Key Reuse Period Work?][6].
|
@@ -1116,7 +1121,7 @@ module Aws::SQS
|
|
1116
1121
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1117
1122
|
# queues][7]\:
|
1118
1123
|
#
|
1119
|
-
# * `FifoQueue`
|
1124
|
+
# * `FifoQueue` – Returns whether the queue is FIFO. For more
|
1120
1125
|
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
1121
1126
|
# Service Developer Guide*.
|
1122
1127
|
#
|
@@ -1125,7 +1130,7 @@ module Aws::SQS
|
|
1125
1130
|
#
|
1126
1131
|
# </note>
|
1127
1132
|
#
|
1128
|
-
# * `ContentBasedDeduplication`
|
1133
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
1129
1134
|
# deduplication is enabled for the queue. For more information, see
|
1130
1135
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
1131
1136
|
# Developer Guide*.
|
@@ -1230,20 +1235,32 @@ module Aws::SQS
|
|
1230
1235
|
#
|
1231
1236
|
# Queue URLs and names are case-sensitive.
|
1232
1237
|
#
|
1238
|
+
# @option params [String] :next_token
|
1239
|
+
# Pagination token to request the next set of results.
|
1240
|
+
#
|
1241
|
+
# @option params [Integer] :max_results
|
1242
|
+
# Maximum number of results to include in the response.
|
1243
|
+
#
|
1233
1244
|
# @return [Types::ListDeadLetterSourceQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1234
1245
|
#
|
1235
1246
|
# * {Types::ListDeadLetterSourceQueuesResult#queue_urls #queue_urls} => Array<String>
|
1247
|
+
# * {Types::ListDeadLetterSourceQueuesResult#next_token #next_token} => String
|
1248
|
+
#
|
1249
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1236
1250
|
#
|
1237
1251
|
# @example Request syntax with placeholder values
|
1238
1252
|
#
|
1239
1253
|
# resp = client.list_dead_letter_source_queues({
|
1240
1254
|
# queue_url: "String", # required
|
1255
|
+
# next_token: "Token",
|
1256
|
+
# max_results: 1,
|
1241
1257
|
# })
|
1242
1258
|
#
|
1243
1259
|
# @example Response structure
|
1244
1260
|
#
|
1245
1261
|
# resp.queue_urls #=> Array
|
1246
1262
|
# resp.queue_urls[0] #=> String
|
1263
|
+
# resp.next_token #=> String
|
1247
1264
|
#
|
1248
1265
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues AWS API Documentation
|
1249
1266
|
#
|
@@ -1317,20 +1334,32 @@ module Aws::SQS
|
|
1317
1334
|
#
|
1318
1335
|
# Queue URLs and names are case-sensitive.
|
1319
1336
|
#
|
1337
|
+
# @option params [String] :next_token
|
1338
|
+
# Pagination token to request the next set of results.
|
1339
|
+
#
|
1340
|
+
# @option params [Integer] :max_results
|
1341
|
+
# Maximum number of results to include in the response.
|
1342
|
+
#
|
1320
1343
|
# @return [Types::ListQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
1344
|
#
|
1322
1345
|
# * {Types::ListQueuesResult#queue_urls #queue_urls} => Array<String>
|
1346
|
+
# * {Types::ListQueuesResult#next_token #next_token} => String
|
1347
|
+
#
|
1348
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1323
1349
|
#
|
1324
1350
|
# @example Request syntax with placeholder values
|
1325
1351
|
#
|
1326
1352
|
# resp = client.list_queues({
|
1327
1353
|
# queue_name_prefix: "String",
|
1354
|
+
# next_token: "Token",
|
1355
|
+
# max_results: 1,
|
1328
1356
|
# })
|
1329
1357
|
#
|
1330
1358
|
# @example Response structure
|
1331
1359
|
#
|
1332
1360
|
# resp.queue_urls #=> Array
|
1333
1361
|
# resp.queue_urls[0] #=> String
|
1362
|
+
# resp.next_token #=> String
|
1334
1363
|
#
|
1335
1364
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues AWS API Documentation
|
1336
1365
|
#
|
@@ -1445,15 +1474,15 @@ module Aws::SQS
|
|
1445
1474
|
# A list of attributes that need to be returned along with each message.
|
1446
1475
|
# These attributes include:
|
1447
1476
|
#
|
1448
|
-
# * `All`
|
1477
|
+
# * `All` – Returns all values.
|
1449
1478
|
#
|
1450
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1479
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1451
1480
|
# was first received from the queue ([epoch time][1] in milliseconds).
|
1452
1481
|
#
|
1453
|
-
# * `ApproximateReceiveCount`
|
1454
|
-
# has been received
|
1482
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1483
|
+
# has been received across all queues but not deleted.
|
1455
1484
|
#
|
1456
|
-
# * `AWSTraceHeader`
|
1485
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1457
1486
|
#
|
1458
1487
|
# * `SenderId`
|
1459
1488
|
#
|
@@ -1463,17 +1492,17 @@ module Aws::SQS
|
|
1463
1492
|
# * For an IAM role, returns the IAM role ID, for example
|
1464
1493
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1465
1494
|
#
|
1466
|
-
# * `SentTimestamp`
|
1495
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1467
1496
|
# ([epoch time][1] in milliseconds).
|
1468
1497
|
#
|
1469
|
-
# * `MessageDeduplicationId`
|
1498
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1470
1499
|
# producer that calls the ` SendMessage ` action.
|
1471
1500
|
#
|
1472
|
-
# * `MessageGroupId`
|
1501
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1473
1502
|
# calls the ` SendMessage ` action. Messages with the same
|
1474
1503
|
# `MessageGroupId` are returned in sequence.
|
1475
1504
|
#
|
1476
|
-
# * `SequenceNumber`
|
1505
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1477
1506
|
#
|
1478
1507
|
#
|
1479
1508
|
#
|
@@ -1518,14 +1547,25 @@ module Aws::SQS
|
|
1518
1547
|
# available and the wait time expires, the call returns successfully
|
1519
1548
|
# with an empty list of messages.
|
1520
1549
|
#
|
1550
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1551
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1552
|
+
# parameter. For example, with the Java SDK, you can set HTTP transport
|
1553
|
+
# settings using the [ NettyNioAsyncHttpClient][1] for asynchronous
|
1554
|
+
# clients, or the [ ApacheHttpClient][2] for synchronous clients.
|
1555
|
+
#
|
1556
|
+
#
|
1557
|
+
#
|
1558
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1559
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1560
|
+
#
|
1521
1561
|
# @option params [String] :receive_request_attempt_id
|
1522
1562
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1523
1563
|
#
|
1524
1564
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1525
1565
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1526
|
-
# of a response you receive a generic error,
|
1527
|
-
# action with an identical `ReceiveRequestAttemptId` to retrieve
|
1528
|
-
# same set of messages, even if their visibility timeout has not yet
|
1566
|
+
# of a response you receive a generic error, it is possible to retry the
|
1567
|
+
# same action with an identical `ReceiveRequestAttemptId` to retrieve
|
1568
|
+
# the same set of messages, even if their visibility timeout has not yet
|
1529
1569
|
# expired.
|
1530
1570
|
#
|
1531
1571
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
@@ -1538,7 +1578,7 @@ module Aws::SQS
|
|
1538
1578
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1539
1579
|
# `ReceiveRequestAttemptId`.
|
1540
1580
|
#
|
1541
|
-
# *
|
1581
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1542
1582
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
1543
1583
|
# (deleted or had their visibility changes).
|
1544
1584
|
#
|
@@ -1569,7 +1609,7 @@ module Aws::SQS
|
|
1569
1609
|
# visibility timeout expires. As a result, delays might occur but the
|
1570
1610
|
# messages in the queue remain in a strict order.
|
1571
1611
|
#
|
1572
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1612
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1573
1613
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
|
1574
1614
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1575
1615
|
# ``).
|
@@ -1736,7 +1776,7 @@ module Aws::SQS
|
|
1736
1776
|
#
|
1737
1777
|
# * Currently, the only supported message system attribute is
|
1738
1778
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1739
|
-
# correctly formatted AWS X-Ray trace string.
|
1779
|
+
# correctly formatted AWS X-Ray trace header string.
|
1740
1780
|
#
|
1741
1781
|
# * The size of a message system attribute doesn't count towards the
|
1742
1782
|
# total size of a message.
|
@@ -1789,7 +1829,7 @@ module Aws::SQS
|
|
1789
1829
|
#
|
1790
1830
|
# </note>
|
1791
1831
|
#
|
1792
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
1832
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1793
1833
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1794
1834
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1795
1835
|
# ``).
|
@@ -1919,9 +1959,9 @@ module Aws::SQS
|
|
1919
1959
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1920
1960
|
# For example, a parameter list with two elements looks like this:
|
1921
1961
|
#
|
1922
|
-
# `&
|
1962
|
+
# `&AttributeName.1=first`
|
1923
1963
|
#
|
1924
|
-
# `&
|
1964
|
+
# `&AttributeName.2=second`
|
1925
1965
|
#
|
1926
1966
|
#
|
1927
1967
|
#
|
@@ -2032,39 +2072,39 @@ module Aws::SQS
|
|
2032
2072
|
# The following lists the names, descriptions, and values of the special
|
2033
2073
|
# request parameters that the `SetQueueAttributes` action uses:
|
2034
2074
|
#
|
2035
|
-
# * `DelaySeconds`
|
2075
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2036
2076
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2037
2077
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2038
2078
|
#
|
2039
|
-
# * `MaximumMessageSize`
|
2079
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2040
2080
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
2041
2081
|
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
|
2042
2082
|
# (256 KiB).
|
2043
2083
|
#
|
2044
|
-
# * `MessageRetentionPeriod`
|
2084
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2045
2085
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2046
2086
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2047
2087
|
# (4 days).
|
2048
2088
|
#
|
2049
|
-
# * `Policy`
|
2089
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2050
2090
|
# information about policy structure, see [Overview of AWS IAM
|
2051
2091
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2052
2092
|
#
|
2053
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2093
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2054
2094
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2055
|
-
# Valid values:
|
2095
|
+
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2056
2096
|
#
|
2057
|
-
# * `RedrivePolicy`
|
2058
|
-
# dead-letter queue functionality of the source queue
|
2059
|
-
# information about the redrive policy and
|
2060
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
2061
|
-
# Service Developer Guide*.
|
2097
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2098
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2099
|
+
# object. For more information about the redrive policy and
|
2100
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2101
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
2062
2102
|
#
|
2063
|
-
# * `deadLetterTargetArn`
|
2103
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2064
2104
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2065
2105
|
# value of `maxReceiveCount` is exceeded.
|
2066
2106
|
#
|
2067
|
-
# * `maxReceiveCount`
|
2107
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
2068
2108
|
# the source queue before being moved to the dead-letter queue. When
|
2069
2109
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
2070
2110
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -2075,22 +2115,22 @@ module Aws::SQS
|
|
2075
2115
|
#
|
2076
2116
|
# </note>
|
2077
2117
|
#
|
2078
|
-
# * `VisibilityTimeout`
|
2079
|
-
# seconds. Valid values:
|
2118
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2119
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2080
2120
|
# Default: 30. For more information about the visibility timeout, see
|
2081
2121
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2082
2122
|
# Developer Guide*.
|
2083
2123
|
#
|
2084
2124
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2085
2125
|
#
|
2086
|
-
# * `KmsMasterKeyId`
|
2126
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2087
2127
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
2088
2128
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
2089
2129
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
2090
2130
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
2091
2131
|
# Key Management Service API Reference*.
|
2092
2132
|
#
|
2093
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2133
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2094
2134
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2095
2135
|
# messages before calling AWS KMS again. An integer representing
|
2096
2136
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -2102,7 +2142,7 @@ module Aws::SQS
|
|
2102
2142
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2103
2143
|
# queues][9]\:
|
2104
2144
|
#
|
2105
|
-
# * `ContentBasedDeduplication`
|
2145
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2106
2146
|
# For more information, see [Exactly-Once Processing][10] in the
|
2107
2147
|
# *Amazon Simple Queue Service Developer Guide*.
|
2108
2148
|
#
|
@@ -2276,7 +2316,7 @@ module Aws::SQS
|
|
2276
2316
|
params: params,
|
2277
2317
|
config: config)
|
2278
2318
|
context[:gem_name] = 'aws-sdk-sqs'
|
2279
|
-
context[:gem_version] = '1.
|
2319
|
+
context[:gem_version] = '1.28.0'
|
2280
2320
|
Seahorse::Client::Request.new(handlers, context)
|
2281
2321
|
end
|
2282
2322
|
|