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