aws-sdk-sqs 1.23.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 892151231fd25dc5be9a81d5139631c0892908c1
4
- data.tar.gz: bbf1219ce40ad25bed75ddf5bdf8615f24f11002
2
+ SHA256:
3
+ metadata.gz: d5803fb0f4bbadd6e4c21dadd624fc1b369c3ea9f08dadf356efa073b3e2f275
4
+ data.tar.gz: 7cd8948f69417a05fded15b172e60857154338166dc9807a9e22470ebb3d93fd
5
5
  SHA512:
6
- metadata.gz: cc5ece8cccdbb13fdb6bdd0088ac77491ace420633fd55068d868ae1e3376d56be8d65641e555047d20800020a5aee671f7d516867f25b1e4ee6fc716978b131
7
- data.tar.gz: 38d70024d73db513673c78c1e9df21b6b2126b895f67ed4373eb45126fbedf2729f65a7c7f08c53bbb4f61a250c49490827e6a24750b3f91177ff53760df0e95
6
+ metadata.gz: 8750e14b758edc5d053b27baff6d1802a174faf4209192eb9b9cad55f43b884c6ff370266fc103c3ae6b689e2506266f1661d10b2855fb457d841162b84ade5a
7
+ data.tar.gz: 361190453cf67c29bd8428eaf346c4f4d4f1082ef528e060bf4aee870dd658d0b42eac31d3ea0c57a2e796ed56a0527584a455fc624a3cb57ef7d6de4e5cb671
@@ -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:
@@ -26,17 +28,20 @@ require_relative 'aws-sdk-sqs/customizations'
26
28
  # methods each accept a hash of request parameters and return a response
27
29
  # structure.
28
30
  #
31
+ # sqs = Aws::SQS::Client.new
32
+ # resp = sqs.add_permission(params)
33
+ #
29
34
  # See {Client} for more information.
30
35
  #
31
36
  # # Errors
32
37
  #
33
- # Errors returned from Amazon Simple Queue Service all
34
- # extend {Errors::ServiceError}.
38
+ # Errors returned from Amazon Simple Queue Service are defined in the
39
+ # {Errors} module and all extend {Errors::ServiceError}.
35
40
  #
36
41
  # begin
37
42
  # # do stuff
38
43
  # rescue Aws::SQS::Errors::ServiceError
39
- # # rescues all service API errors
44
+ # # rescues all Amazon Simple Queue Service API errors
40
45
  # end
41
46
  #
42
47
  # See {Errors} for more information.
@@ -44,6 +49,6 @@ require_relative 'aws-sdk-sqs/customizations'
44
49
  # @service
45
50
  module Aws::SQS
46
51
 
47
- GEM_VERSION = '1.23.1'
52
+ GEM_VERSION = '1.28.0'
48
53
 
49
54
  end
@@ -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:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/query.rb'
29
32
  require 'aws-sdk-sqs/plugins/queue_urls.rb'
@@ -32,6 +35,18 @@ require 'aws-sdk-sqs/plugins/md5s.rb'
32
35
  Aws::Plugins::GlobalConfiguration.add_identifier(:sqs)
33
36
 
34
37
  module Aws::SQS
38
+ # An API client for SQS. To construct a client, you need to configure a `:region` and `:credentials`.
39
+ #
40
+ # client = Aws::SQS::Client.new(
41
+ # region: region_name,
42
+ # credentials: credentials,
43
+ # # ...
44
+ # )
45
+ #
46
+ # For details on configuring region and credentials see
47
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
48
+ #
49
+ # See {#initialize} for a full list of supported configuration options.
35
50
  class Client < Seahorse::Client::Base
36
51
 
37
52
  include Aws::ClientStubs
@@ -59,6 +74,7 @@ module Aws::SQS
59
74
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
60
75
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
61
76
  add_plugin(Aws::Plugins::TransferEncoding)
77
+ add_plugin(Aws::Plugins::HttpChecksum)
62
78
  add_plugin(Aws::Plugins::SignatureV4)
63
79
  add_plugin(Aws::Plugins::Protocols::Query)
64
80
  add_plugin(Aws::SQS::Plugins::QueueUrls)
@@ -97,7 +113,7 @@ module Aws::SQS
97
113
  # @option options [required, String] :region
98
114
  # The AWS region to connect to. The configured `:region` is
99
115
  # used to determine the service `:endpoint`. When not passed,
100
- # a default `:region` is search for in the following locations:
116
+ # a default `:region` is searched for in the following locations:
101
117
  #
102
118
  # * `Aws.config[:region]`
103
119
  # * `ENV['AWS_REGION']`
@@ -112,6 +128,12 @@ module Aws::SQS
112
128
  # When set to `true`, a thread polling for endpoints will be running in
113
129
  # the background every 60 secs (default). Defaults to `false`.
114
130
  #
131
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
132
+ # Used only in `adaptive` retry mode. When true, the request will sleep
133
+ # until there is sufficent client side capacity to retry the request.
134
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
135
+ # not retry instead of sleeping.
136
+ #
115
137
  # @option options [Boolean] :client_side_monitoring (false)
116
138
  # When `true`, client-side metrics will be collected for all API requests from
117
139
  # this client.
@@ -136,6 +158,10 @@ module Aws::SQS
136
158
  # When `true`, an attempt is made to coerce request parameters into
137
159
  # the required types.
138
160
  #
161
+ # @option options [Boolean] :correct_clock_skew (true)
162
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
163
+ # a clock skew correction and retry requests with skewed client clocks.
164
+ #
139
165
  # @option options [Boolean] :disable_host_prefix_injection (false)
140
166
  # Set to true to disable SDK automatically adding host prefix
141
167
  # to default service endpoint when available.
@@ -143,7 +169,7 @@ module Aws::SQS
143
169
  # @option options [String] :endpoint
144
170
  # The client endpoint is normally constructed from the `:region`
145
171
  # option. You should only configure an `:endpoint` when connecting
146
- # to test endpoints. This should be avalid HTTP(S) URI.
172
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
147
173
  #
148
174
  # @option options [Integer] :endpoint_cache_max_entries (1000)
149
175
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -158,7 +184,7 @@ module Aws::SQS
158
184
  # requests fetching endpoints information. Defaults to 60 sec.
159
185
  #
160
186
  # @option options [Boolean] :endpoint_discovery (false)
161
- # When set to `true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.
187
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
162
188
  #
163
189
  # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
164
190
  # The log formatter.
@@ -170,15 +196,29 @@ module Aws::SQS
170
196
  # The Logger instance to send log messages to. If this option
171
197
  # is not set, logging will be disabled.
172
198
  #
199
+ # @option options [Integer] :max_attempts (3)
200
+ # An integer representing the maximum number attempts that will be made for
201
+ # a single request, including the initial attempt. For example,
202
+ # setting this value to 5 will result in a request being retried up to
203
+ # 4 times. Used in `standard` and `adaptive` retry modes.
204
+ #
173
205
  # @option options [String] :profile ("default")
174
206
  # Used when loading credentials from the shared credentials file
175
207
  # at HOME/.aws/credentials. When not specified, 'default' is used.
176
208
  #
209
+ # @option options [Proc] :retry_backoff
210
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
211
+ # This option is only used in the `legacy` retry mode.
212
+ #
177
213
  # @option options [Float] :retry_base_delay (0.3)
178
- # The base delay in seconds used by the default backoff function.
214
+ # The base delay in seconds used by the default backoff function. This option
215
+ # is only used in the `legacy` retry mode.
179
216
  #
180
217
  # @option options [Symbol] :retry_jitter (:none)
181
- # A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.
218
+ # A delay randomiser function used by the default backoff function.
219
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
220
+ # otherwise a Proc that takes and returns a number. This option is only used
221
+ # in the `legacy` retry mode.
182
222
  #
183
223
  # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
184
224
  #
@@ -186,11 +226,30 @@ module Aws::SQS
186
226
  # The maximum number of times to retry failed requests. Only
187
227
  # ~ 500 level server errors and certain ~ 400 level client errors
188
228
  # are retried. Generally, these are throttling errors, data
189
- # checksum errors, networking errors, timeout errors and auth
190
- # errors from expired credentials.
229
+ # checksum errors, networking errors, timeout errors, auth errors,
230
+ # endpoint discovery, and errors from expired credentials.
231
+ # This option is only used in the `legacy` retry mode.
191
232
  #
192
233
  # @option options [Integer] :retry_max_delay (0)
193
- # The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.
234
+ # The maximum number of seconds to delay between retries (0 for no limit)
235
+ # used by the default backoff function. This option is only used in the
236
+ # `legacy` retry mode.
237
+ #
238
+ # @option options [String] :retry_mode ("legacy")
239
+ # Specifies which retry algorithm to use. Values are:
240
+ #
241
+ # * `legacy` - The pre-existing retry behavior. This is default value if
242
+ # no retry mode is provided.
243
+ #
244
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
245
+ # This includes support for retry quotas, which limit the number of
246
+ # unsuccessful retries a client can make.
247
+ #
248
+ # * `adaptive` - An experimental retry mode that includes all the
249
+ # functionality of `standard` mode along with automatic client side
250
+ # throttling. This is a provisional mode that may change behavior
251
+ # in the future.
252
+ #
194
253
  #
195
254
  # @option options [String] :secret_access_key
196
255
  #
@@ -219,16 +278,15 @@ module Aws::SQS
219
278
  # requests through. Formatted like 'http://proxy.com:123'.
220
279
  #
221
280
  # @option options [Float] :http_open_timeout (15) The number of
222
- # seconds to wait when opening a HTTP session before rasing a
281
+ # seconds to wait when opening a HTTP session before raising a
223
282
  # `Timeout::Error`.
224
283
  #
225
284
  # @option options [Integer] :http_read_timeout (60) The default
226
285
  # number of seconds to wait for response data. This value can
227
- # safely be set
228
- # per-request on the session yeidled by {#session_for}.
286
+ # safely be set per-request on the session.
229
287
  #
230
288
  # @option options [Float] :http_idle_timeout (5) The number of
231
- # seconds a connection is allowed to sit idble before it is
289
+ # seconds a connection is allowed to sit idle before it is
232
290
  # considered stale. Stale connections are closed and removed
233
291
  # from the pool before making a request.
234
292
  #
@@ -237,7 +295,7 @@ module Aws::SQS
237
295
  # request body. This option has no effect unless the request has
238
296
  # "Expect" header set to "100-continue". Defaults to `nil` which
239
297
  # disables this behaviour. This value can safely be set per
240
- # request on the session yeidled by {#session_for}.
298
+ # request on the session.
241
299
  #
242
300
  # @option options [Boolean] :http_wire_trace (false) When `true`,
243
301
  # HTTP debug output will be sent to the `:logger`.
@@ -290,9 +348,9 @@ module Aws::SQS
290
348
  # the `param.n` notation. Values of `n` are integers starting from 1.
291
349
  # For example, a parameter list with two elements looks like this:
292
350
  #
293
- # `&Attribute.1=first`
351
+ # `&AttributeName.1=first`
294
352
  #
295
- # `&Attribute.2=second`
353
+ # `&AttributeName.2=second`
296
354
  #
297
355
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
298
356
  # information, see [Grant Cross-Account Permissions to a Role and a User
@@ -479,9 +537,9 @@ module Aws::SQS
479
537
  # the `param.n` notation. Values of `n` are integers starting from 1.
480
538
  # For example, a parameter list with two elements looks like this:
481
539
  #
482
- # `&Attribute.1=first`
540
+ # `&AttributeName.1=first`
483
541
  #
484
- # `&Attribute.2=second`
542
+ # `&AttributeName.2=second`
485
543
  #
486
544
  # @option params [required, String] :queue_url
487
545
  # The URL of the Amazon SQS queue whose messages' visibility is
@@ -531,7 +589,7 @@ module Aws::SQS
531
589
  end
532
590
 
533
591
  # Creates a new standard or FIFO queue. You can pass one or more
534
- # attributes in the request. Keep the following caveats in mind:
592
+ # attributes in the request. Keep the following in mind:
535
593
  #
536
594
  # * If you don't specify the `FifoQueue` attribute, Amazon SQS creates
537
595
  # a standard queue.
@@ -555,6 +613,11 @@ module Aws::SQS
555
613
  # adheres to the [limits related to queues][2] and is unique within the
556
614
  # scope of your queues.
557
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
+ #
558
621
  # To get the queue URL, use the ` GetQueueUrl ` action. ` GetQueueUrl `
559
622
  # requires only the `QueueName` parameter. be aware of existing queue
560
623
  # names:
@@ -570,9 +633,9 @@ module Aws::SQS
570
633
  # the `param.n` notation. Values of `n` are integers starting from 1.
571
634
  # For example, a parameter list with two elements looks like this:
572
635
  #
573
- # `&Attribute.1=first`
636
+ # `&AttributeName.1=first`
574
637
  #
575
- # `&Attribute.2=second`
638
+ # `&AttributeName.2=second`
576
639
  #
577
640
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
578
641
  # information, see [Grant Cross-Account Permissions to a Role and a User
@@ -604,39 +667,39 @@ module Aws::SQS
604
667
  # The following lists the names, descriptions, and values of the special
605
668
  # request parameters that the `CreateQueue` action uses:
606
669
  #
607
- # * `DelaySeconds` - The length of time, in seconds, for which the
670
+ # * `DelaySeconds` The length of time, in seconds, for which the
608
671
  # delivery of all messages in the queue is delayed. Valid values: An
609
672
  # integer from 0 to 900 seconds (15 minutes). Default: 0.
610
673
  #
611
- # * `MaximumMessageSize` - The limit of how many bytes a message can
674
+ # * `MaximumMessageSize` The limit of how many bytes a message can
612
675
  # contain before Amazon SQS rejects it. Valid values: An integer from
613
676
  # 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
614
677
  # (256 KiB).
615
678
  #
616
- # * `MessageRetentionPeriod` - The length of time, in seconds, for which
679
+ # * `MessageRetentionPeriod` The length of time, in seconds, for which
617
680
  # Amazon SQS retains a message. Valid values: An integer from 60
618
681
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
619
682
  # (4 days).
620
683
  #
621
- # * `Policy` - The queue's policy. A valid AWS policy. For more
684
+ # * `Policy` The queue's policy. A valid AWS policy. For more
622
685
  # information about policy structure, see [Overview of AWS IAM
623
686
  # Policies][1] in the *Amazon IAM User Guide*.
624
687
  #
625
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
688
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
626
689
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
627
690
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
628
691
  #
629
- # * `RedrivePolicy` - The string that includes the parameters for the
630
- # dead-letter queue functionality of the source queue. For more
631
- # information about the redrive policy and dead-letter queues, see
632
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple Queue
633
- # 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*.
634
697
  #
635
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
698
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
636
699
  # dead-letter queue to which Amazon SQS moves messages after the
637
700
  # value of `maxReceiveCount` is exceeded.
638
701
  #
639
- # * `maxReceiveCount` - The number of times a message is delivered to
702
+ # * `maxReceiveCount` The number of times a message is delivered to
640
703
  # the source queue before being moved to the dead-letter queue. When
641
704
  # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
642
705
  # a queue, Amazon SQS moves the message to the dead-letter-queue.
@@ -647,7 +710,7 @@ module Aws::SQS
647
710
  #
648
711
  # </note>
649
712
  #
650
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
713
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
651
714
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
652
715
  # Default: 30. For more information about the visibility timeout, see
653
716
  # [Visibility Timeout][3] in the *Amazon Simple Queue Service
@@ -655,14 +718,14 @@ module Aws::SQS
655
718
  #
656
719
  # The following attributes apply only to [server-side-encryption][4]\:
657
720
  #
658
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
721
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
659
722
  # (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
660
723
  # Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
661
724
  # always `alias/aws/sqs`, the alias of a custom CMK can, for example,
662
725
  # be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
663
726
  # Key Management Service API Reference*.
664
727
  #
665
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
728
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds, for
666
729
  # which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
667
730
  # messages before calling AWS KMS again. An integer representing
668
731
  # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
@@ -674,7 +737,7 @@ module Aws::SQS
674
737
  # The following attributes apply only to [FIFO (first-in-first-out)
675
738
  # queues][9]\:
676
739
  #
677
- # * `FifoQueue` - Designates a queue as FIFO. Valid values: `true`,
740
+ # * `FifoQueue` Designates a queue as FIFO. Valid values: `true`,
678
741
  # `false`. If you don't specify the `FifoQueue` attribute, Amazon SQS
679
742
  # creates a standard queue. You can provide this attribute only during
680
743
  # queue creation. You can't change it for an existing queue. When you
@@ -684,7 +747,7 @@ module Aws::SQS
684
747
  # For more information, see [FIFO Queue Logic][10] in the *Amazon
685
748
  # Simple Queue Service Developer Guide*.
686
749
  #
687
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
750
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
688
751
  # Valid values: `true`, `false`. For more information, see
689
752
  # [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
690
753
  # Developer Guide*.
@@ -858,9 +921,9 @@ module Aws::SQS
858
921
  # the `param.n` notation. Values of `n` are integers starting from 1.
859
922
  # For example, a parameter list with two elements looks like this:
860
923
  #
861
- # `&Attribute.1=first`
924
+ # `&AttributeName.1=first`
862
925
  #
863
- # `&Attribute.2=second`
926
+ # `&AttributeName.2=second`
864
927
  #
865
928
  # @option params [required, String] :queue_url
866
929
  # The URL of the Amazon SQS queue from which messages are deleted.
@@ -907,8 +970,7 @@ module Aws::SQS
907
970
  end
908
971
 
909
972
  # Deletes the queue specified by the `QueueUrl`, regardless of the
910
- # queue's contents. If the specified queue doesn't exist, Amazon SQS
911
- # returns a successful response.
973
+ # queue's contents.
912
974
  #
913
975
  # Be careful with the `DeleteQueue` action: When you delete a queue, any
914
976
  # messages in the queue are no longer available.
@@ -960,14 +1022,6 @@ module Aws::SQS
960
1022
  #
961
1023
  # </note>
962
1024
  #
963
- # Some actions take lists of parameters. These lists are specified using
964
- # the `param.n` notation. Values of `n` are integers starting from 1.
965
- # For example, a parameter list with two elements looks like this:
966
- #
967
- # `&Attribute.1=first`
968
- #
969
- # `&Attribute.2=second`
970
- #
971
1025
  #
972
1026
  #
973
1027
  # [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
@@ -989,70 +1043,77 @@ module Aws::SQS
989
1043
  #
990
1044
  # The following attributes are supported:
991
1045
  #
992
- # * `All` - Returns all values.
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.
993
1054
  #
994
- # * `ApproximateNumberOfMessages` - Returns the approximate number of
1055
+ # * `ApproximateNumberOfMessages` Returns the approximate number of
995
1056
  # messages available for retrieval from the queue.
996
1057
  #
997
- # * `ApproximateNumberOfMessagesDelayed` - Returns the approximate
1058
+ # * `ApproximateNumberOfMessagesDelayed` Returns the approximate
998
1059
  # number of messages in the queue that are delayed and not available
999
1060
  # for reading immediately. This can happen when the queue is
1000
1061
  # configured as a delay queue or when a message has been sent with a
1001
1062
  # delay parameter.
1002
1063
  #
1003
- # * `ApproximateNumberOfMessagesNotVisible` - Returns the approximate
1064
+ # * `ApproximateNumberOfMessagesNotVisible` Returns the approximate
1004
1065
  # number of messages that are in flight. Messages are considered to be
1005
1066
  # *in flight* if they have been sent to a client but have not yet been
1006
1067
  # deleted or have not yet reached the end of their visibility window.
1007
1068
  #
1008
- # * `CreatedTimestamp` - Returns the time when the queue was created in
1069
+ # * `CreatedTimestamp` Returns the time when the queue was created in
1009
1070
  # seconds ([epoch time][1]).
1010
1071
  #
1011
- # * `DelaySeconds` - Returns the default delay on the queue in seconds.
1072
+ # * `DelaySeconds` Returns the default delay on the queue in seconds.
1012
1073
  #
1013
- # * `LastModifiedTimestamp` - Returns the time when the queue was last
1074
+ # * `LastModifiedTimestamp` Returns the time when the queue was last
1014
1075
  # changed in seconds ([epoch time][1]).
1015
1076
  #
1016
- # * `MaximumMessageSize` - Returns the limit of how many bytes a message
1077
+ # * `MaximumMessageSize` Returns the limit of how many bytes a message
1017
1078
  # can contain before Amazon SQS rejects it.
1018
1079
  #
1019
- # * `MessageRetentionPeriod` - Returns the length of time, in seconds,
1080
+ # * `MessageRetentionPeriod` Returns the length of time, in seconds,
1020
1081
  # for which Amazon SQS retains a message.
1021
1082
  #
1022
- # * `Policy` - Returns the policy of the queue.
1083
+ # * `Policy` Returns the policy of the queue.
1023
1084
  #
1024
- # * `QueueArn` - Returns the Amazon resource name (ARN) of the queue.
1085
+ # * `QueueArn` Returns the Amazon resource name (ARN) of the queue.
1025
1086
  #
1026
- # * `ReceiveMessageWaitTimeSeconds` - Returns the length of time, in
1087
+ # * `ReceiveMessageWaitTimeSeconds` Returns the length of time, in
1027
1088
  # seconds, for which the `ReceiveMessage` action waits for a message
1028
1089
  # to arrive.
1029
1090
  #
1030
- # * `RedrivePolicy` - Returns the string that includes the parameters
1031
- # for dead-letter queue functionality of the source queue. For more
1032
- # information about the redrive policy and dead-letter queues, see
1033
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple Queue
1034
- # 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*.
1035
1096
  #
1036
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
1097
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
1037
1098
  # dead-letter queue to which Amazon SQS moves messages after the
1038
1099
  # value of `maxReceiveCount` is exceeded.
1039
1100
  #
1040
- # * `maxReceiveCount` - The number of times a message is delivered to
1101
+ # * `maxReceiveCount` The number of times a message is delivered to
1041
1102
  # the source queue before being moved to the dead-letter queue. When
1042
1103
  # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
1043
1104
  # a queue, Amazon SQS moves the message to the dead-letter-queue.
1044
1105
  #
1045
- # * `VisibilityTimeout` - Returns the visibility timeout for the queue.
1106
+ # * `VisibilityTimeout` Returns the visibility timeout for the queue.
1046
1107
  # For more information about the visibility timeout, see [Visibility
1047
1108
  # Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
1048
1109
  #
1049
1110
  # The following attributes apply only to [server-side-encryption][4]\:
1050
1111
  #
1051
- # * `KmsMasterKeyId` - Returns the ID of an AWS-managed customer master
1112
+ # * `KmsMasterKeyId` Returns the ID of an AWS-managed customer master
1052
1113
  # key (CMK) for Amazon SQS or a custom CMK. For more information, see
1053
1114
  # [Key Terms][5].
1054
1115
  #
1055
- # * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
1116
+ # * `KmsDataKeyReusePeriodSeconds` Returns the length of time, in
1056
1117
  # seconds, for which Amazon SQS can reuse a data key to encrypt or
1057
1118
  # decrypt messages before calling AWS KMS again. For more information,
1058
1119
  # see [How Does the Data Key Reuse Period Work?][6].
@@ -1060,7 +1121,7 @@ module Aws::SQS
1060
1121
  # The following attributes apply only to [FIFO (first-in-first-out)
1061
1122
  # queues][7]\:
1062
1123
  #
1063
- # * `FifoQueue` - Returns whether the queue is FIFO. For more
1124
+ # * `FifoQueue` Returns whether the queue is FIFO. For more
1064
1125
  # information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
1065
1126
  # Service Developer Guide*.
1066
1127
  #
@@ -1069,7 +1130,7 @@ module Aws::SQS
1069
1130
  #
1070
1131
  # </note>
1071
1132
  #
1072
- # * `ContentBasedDeduplication` - Returns whether content-based
1133
+ # * `ContentBasedDeduplication` Returns whether content-based
1073
1134
  # deduplication is enabled for the queue. For more information, see
1074
1135
  # [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
1075
1136
  # Developer Guide*.
@@ -1174,20 +1235,32 @@ module Aws::SQS
1174
1235
  #
1175
1236
  # Queue URLs and names are case-sensitive.
1176
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
+ #
1177
1244
  # @return [Types::ListDeadLetterSourceQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1178
1245
  #
1179
1246
  # * {Types::ListDeadLetterSourceQueuesResult#queue_urls #queue_urls} => Array&lt;String&gt;
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}.
1180
1250
  #
1181
1251
  # @example Request syntax with placeholder values
1182
1252
  #
1183
1253
  # resp = client.list_dead_letter_source_queues({
1184
1254
  # queue_url: "String", # required
1255
+ # next_token: "Token",
1256
+ # max_results: 1,
1185
1257
  # })
1186
1258
  #
1187
1259
  # @example Response structure
1188
1260
  #
1189
1261
  # resp.queue_urls #=> Array
1190
1262
  # resp.queue_urls[0] #=> String
1263
+ # resp.next_token #=> String
1191
1264
  #
1192
1265
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues AWS API Documentation
1193
1266
  #
@@ -1261,20 +1334,32 @@ module Aws::SQS
1261
1334
  #
1262
1335
  # Queue URLs and names are case-sensitive.
1263
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
+ #
1264
1343
  # @return [Types::ListQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1265
1344
  #
1266
1345
  # * {Types::ListQueuesResult#queue_urls #queue_urls} => Array&lt;String&gt;
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}.
1267
1349
  #
1268
1350
  # @example Request syntax with placeholder values
1269
1351
  #
1270
1352
  # resp = client.list_queues({
1271
1353
  # queue_name_prefix: "String",
1354
+ # next_token: "Token",
1355
+ # max_results: 1,
1272
1356
  # })
1273
1357
  #
1274
1358
  # @example Response structure
1275
1359
  #
1276
1360
  # resp.queue_urls #=> Array
1277
1361
  # resp.queue_urls[0] #=> String
1362
+ # resp.next_token #=> String
1278
1363
  #
1279
1364
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues AWS API Documentation
1280
1365
  #
@@ -1389,15 +1474,15 @@ module Aws::SQS
1389
1474
  # A list of attributes that need to be returned along with each message.
1390
1475
  # These attributes include:
1391
1476
  #
1392
- # * `All` - Returns all values.
1477
+ # * `All` Returns all values.
1393
1478
  #
1394
- # * `ApproximateFirstReceiveTimestamp` - Returns the time the message
1479
+ # * `ApproximateFirstReceiveTimestamp` Returns the time the message
1395
1480
  # was first received from the queue ([epoch time][1] in milliseconds).
1396
1481
  #
1397
- # * `ApproximateReceiveCount` - Returns the number of times a message
1398
- # has been received from the queue but not deleted.
1482
+ # * `ApproximateReceiveCount` Returns the number of times a message
1483
+ # has been received across all queues but not deleted.
1399
1484
  #
1400
- # * `AWSTraceHeader` - Returns the AWS X-Ray trace header string.
1485
+ # * `AWSTraceHeader` Returns the AWS X-Ray trace header string.
1401
1486
  #
1402
1487
  # * `SenderId`
1403
1488
  #
@@ -1407,17 +1492,17 @@ module Aws::SQS
1407
1492
  # * For an IAM role, returns the IAM role ID, for example
1408
1493
  # `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
1409
1494
  #
1410
- # * `SentTimestamp` - Returns the time the message was sent to the queue
1495
+ # * `SentTimestamp` Returns the time the message was sent to the queue
1411
1496
  # ([epoch time][1] in milliseconds).
1412
1497
  #
1413
- # * `MessageDeduplicationId` - Returns the value provided by the
1498
+ # * `MessageDeduplicationId` Returns the value provided by the
1414
1499
  # producer that calls the ` SendMessage ` action.
1415
1500
  #
1416
- # * `MessageGroupId` - Returns the value provided by the producer that
1501
+ # * `MessageGroupId` Returns the value provided by the producer that
1417
1502
  # calls the ` SendMessage ` action. Messages with the same
1418
1503
  # `MessageGroupId` are returned in sequence.
1419
1504
  #
1420
- # * `SequenceNumber` - Returns the value provided by Amazon SQS.
1505
+ # * `SequenceNumber` Returns the value provided by Amazon SQS.
1421
1506
  #
1422
1507
  #
1423
1508
  #
@@ -1462,14 +1547,25 @@ module Aws::SQS
1462
1547
  # available and the wait time expires, the call returns successfully
1463
1548
  # with an empty list of messages.
1464
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
+ #
1465
1561
  # @option params [String] :receive_request_attempt_id
1466
1562
  # This parameter applies only to FIFO (first-in-first-out) queues.
1467
1563
  #
1468
1564
  # The token used for deduplication of `ReceiveMessage` calls. If a
1469
1565
  # networking issue occurs after a `ReceiveMessage` action, and instead
1470
- # of a response you receive a generic error, you can retry the same
1471
- # action with an identical `ReceiveRequestAttemptId` to retrieve the
1472
- # 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
1473
1569
  # expired.
1474
1570
  #
1475
1571
  # * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
@@ -1482,7 +1578,7 @@ module Aws::SQS
1482
1578
  # `ReceiveRequestAttemptId`, Amazon SQS generates a
1483
1579
  # `ReceiveRequestAttemptId`.
1484
1580
  #
1485
- # * You can retry the `ReceiveMessage` action with the same
1581
+ # * It is possible to retry the `ReceiveMessage` action with the same
1486
1582
  # `ReceiveRequestAttemptId` if none of the messages have been modified
1487
1583
  # (deleted or had their visibility changes).
1488
1584
  #
@@ -1513,7 +1609,7 @@ module Aws::SQS
1513
1609
  # visibility timeout expires. As a result, delays might occur but the
1514
1610
  # messages in the queue remain in a strict order.
1515
1611
  #
1516
- # The length of `ReceiveRequestAttemptId` is 128 characters.
1612
+ # The maximum length of `ReceiveRequestAttemptId` is 128 characters.
1517
1613
  # `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
1518
1614
  # `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
1519
1615
  # ``).
@@ -1680,7 +1776,7 @@ module Aws::SQS
1680
1776
  #
1681
1777
  # * Currently, the only supported message system attribute is
1682
1778
  # `AWSTraceHeader`. Its type must be `String` and its value must be a
1683
- # correctly formatted AWS X-Ray trace string.
1779
+ # correctly formatted AWS X-Ray trace header string.
1684
1780
  #
1685
1781
  # * The size of a message system attribute doesn't count towards the
1686
1782
  # total size of a message.
@@ -1733,7 +1829,7 @@ module Aws::SQS
1733
1829
  #
1734
1830
  # </note>
1735
1831
  #
1736
- # The length of `MessageDeduplicationId` is 128 characters.
1832
+ # The maximum length of `MessageDeduplicationId` is 128 characters.
1737
1833
  # `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
1738
1834
  # `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
1739
1835
  # ``).
@@ -1863,9 +1959,9 @@ module Aws::SQS
1863
1959
  # the `param.n` notation. Values of `n` are integers starting from 1.
1864
1960
  # For example, a parameter list with two elements looks like this:
1865
1961
  #
1866
- # `&Attribute.1=first`
1962
+ # `&AttributeName.1=first`
1867
1963
  #
1868
- # `&Attribute.2=second`
1964
+ # `&AttributeName.2=second`
1869
1965
  #
1870
1966
  #
1871
1967
  #
@@ -1976,39 +2072,39 @@ module Aws::SQS
1976
2072
  # The following lists the names, descriptions, and values of the special
1977
2073
  # request parameters that the `SetQueueAttributes` action uses:
1978
2074
  #
1979
- # * `DelaySeconds` - The length of time, in seconds, for which the
2075
+ # * `DelaySeconds` The length of time, in seconds, for which the
1980
2076
  # delivery of all messages in the queue is delayed. Valid values: An
1981
2077
  # integer from 0 to 900 (15 minutes). Default: 0.
1982
2078
  #
1983
- # * `MaximumMessageSize` - The limit of how many bytes a message can
2079
+ # * `MaximumMessageSize` The limit of how many bytes a message can
1984
2080
  # contain before Amazon SQS rejects it. Valid values: An integer from
1985
2081
  # 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
1986
2082
  # (256 KiB).
1987
2083
  #
1988
- # * `MessageRetentionPeriod` - The length of time, in seconds, for which
2084
+ # * `MessageRetentionPeriod` The length of time, in seconds, for which
1989
2085
  # Amazon SQS retains a message. Valid values: An integer representing
1990
2086
  # seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
1991
2087
  # (4 days).
1992
2088
  #
1993
- # * `Policy` - The queue's policy. A valid AWS policy. For more
2089
+ # * `Policy` The queue's policy. A valid AWS policy. For more
1994
2090
  # information about policy structure, see [Overview of AWS IAM
1995
2091
  # Policies][1] in the *Amazon IAM User Guide*.
1996
2092
  #
1997
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
2093
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
1998
2094
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
1999
- # Valid values: an integer from 0 to 20 (seconds). Default: 0.
2095
+ # Valid values: An integer from 0 to 20 (seconds). Default: 0.
2000
2096
  #
2001
- # * `RedrivePolicy` - The string that includes the parameters for the
2002
- # dead-letter queue functionality of the source queue. For more
2003
- # information about the redrive policy and dead-letter queues, see
2004
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple Queue
2005
- # 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*.
2006
2102
  #
2007
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
2103
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
2008
2104
  # dead-letter queue to which Amazon SQS moves messages after the
2009
2105
  # value of `maxReceiveCount` is exceeded.
2010
2106
  #
2011
- # * `maxReceiveCount` - The number of times a message is delivered to
2107
+ # * `maxReceiveCount` The number of times a message is delivered to
2012
2108
  # the source queue before being moved to the dead-letter queue. When
2013
2109
  # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
2014
2110
  # a queue, Amazon SQS moves the message to the dead-letter-queue.
@@ -2019,22 +2115,22 @@ module Aws::SQS
2019
2115
  #
2020
2116
  # </note>
2021
2117
  #
2022
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
2023
- # seconds. Valid values: an integer from 0 to 43,200 (12 hours).
2118
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
2119
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2024
2120
  # Default: 30. For more information about the visibility timeout, see
2025
2121
  # [Visibility Timeout][3] in the *Amazon Simple Queue Service
2026
2122
  # Developer Guide*.
2027
2123
  #
2028
2124
  # The following attributes apply only to [server-side-encryption][4]\:
2029
2125
  #
2030
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
2126
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
2031
2127
  # (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
2032
2128
  # Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
2033
2129
  # always `alias/aws/sqs`, the alias of a custom CMK can, for example,
2034
2130
  # be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
2035
2131
  # Key Management Service API Reference*.
2036
2132
  #
2037
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
2133
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds, for
2038
2134
  # which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
2039
2135
  # messages before calling AWS KMS again. An integer representing
2040
2136
  # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
@@ -2046,7 +2142,7 @@ module Aws::SQS
2046
2142
  # The following attribute applies only to [FIFO (first-in-first-out)
2047
2143
  # queues][9]\:
2048
2144
  #
2049
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
2145
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
2050
2146
  # For more information, see [Exactly-Once Processing][10] in the
2051
2147
  # *Amazon Simple Queue Service Developer Guide*.
2052
2148
  #
@@ -2220,7 +2316,7 @@ module Aws::SQS
2220
2316
  params: params,
2221
2317
  config: config)
2222
2318
  context[:gem_name] = 'aws-sdk-sqs'
2223
- context[:gem_version] = '1.23.1'
2319
+ context[:gem_version] = '1.28.0'
2224
2320
  Seahorse::Client::Request.new(handlers, context)
2225
2321
  end
2226
2322