aws-sdk-sqs 1.26.0 → 1.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sqs.rb +4 -2
- data/lib/aws-sdk-sqs/client.rb +162 -105
- 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 +192 -86
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e31718dd2428ff7124ca8160fa0354849057ca4102ee2751e5b10051a7589ef4
|
4
|
+
data.tar.gz: 34b10379db700f2362c896358cce747449eea6e6a0f5823d3dd44d58912d977c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: def13e93bae613c889527803825ee3035eeb594d8aa221bca73b303e55a103ee18ca3b7021dcfbadaf8d9c7f91665653134079da00d2e0a00ba2ee2a57c866ed
|
7
|
+
data.tar.gz: 2c3b38f6f92ac938ab0270ee6a4f4ce33fe5956b167b56d68714975bd52971b87e86b2f290421a0cd891afbe83a0817cd44cae80837e70d71e6405069adea88e
|
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:
|
@@ -44,9 +46,9 @@ require_relative 'aws-sdk-sqs/customizations'
|
|
44
46
|
#
|
45
47
|
# See {Errors} for more information.
|
46
48
|
#
|
47
|
-
#
|
49
|
+
# @!group service
|
48
50
|
module Aws::SQS
|
49
51
|
|
50
|
-
GEM_VERSION = '1.
|
52
|
+
GEM_VERSION = '1.31.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)
|
@@ -85,13 +89,28 @@ module Aws::SQS
|
|
85
89
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
90
|
# credentials.
|
87
91
|
#
|
92
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
93
|
+
# shared file, such as `~/.aws/config`.
|
94
|
+
#
|
95
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
96
|
+
#
|
97
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
98
|
+
# assume a role after providing credentials via the web.
|
99
|
+
#
|
100
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
101
|
+
# access token generated from `aws login`.
|
102
|
+
#
|
103
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
104
|
+
# process that outputs to stdout.
|
105
|
+
#
|
88
106
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
107
|
# from an EC2 IMDS on an EC2 instance.
|
90
108
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
109
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
110
|
+
# instances running in ECS.
|
93
111
|
#
|
94
|
-
# * `Aws::
|
112
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
113
|
+
# from the Cognito Identity service.
|
95
114
|
#
|
96
115
|
# When `:credentials` are not configured directly, the following
|
97
116
|
# locations will be searched for credentials:
|
@@ -101,10 +120,10 @@ module Aws::SQS
|
|
101
120
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
121
|
# * `~/.aws/credentials`
|
103
122
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
123
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
124
|
+
# are very aggressive. Construct and pass an instance of
|
125
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
126
|
+
# enable retries and extended timeouts.
|
108
127
|
#
|
109
128
|
# @option options [required, String] :region
|
110
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -165,7 +184,7 @@ module Aws::SQS
|
|
165
184
|
# @option options [String] :endpoint
|
166
185
|
# The client endpoint is normally constructed from the `:region`
|
167
186
|
# option. You should only configure an `:endpoint` when connecting
|
168
|
-
# to test endpoints. This should be a valid HTTP(S) URI.
|
187
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
169
188
|
#
|
170
189
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
171
190
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -344,9 +363,9 @@ module Aws::SQS
|
|
344
363
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
345
364
|
# For example, a parameter list with two elements looks like this:
|
346
365
|
#
|
347
|
-
# `&
|
366
|
+
# `&AttributeName.1=first`
|
348
367
|
#
|
349
|
-
# `&
|
368
|
+
# `&AttributeName.2=second`
|
350
369
|
#
|
351
370
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
352
371
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -533,9 +552,9 @@ module Aws::SQS
|
|
533
552
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
534
553
|
# For example, a parameter list with two elements looks like this:
|
535
554
|
#
|
536
|
-
# `&
|
555
|
+
# `&AttributeName.1=first`
|
537
556
|
#
|
538
|
-
# `&
|
557
|
+
# `&AttributeName.2=second`
|
539
558
|
#
|
540
559
|
# @option params [required, String] :queue_url
|
541
560
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
@@ -585,7 +604,7 @@ module Aws::SQS
|
|
585
604
|
end
|
586
605
|
|
587
606
|
# Creates a new standard or FIFO queue. You can pass one or more
|
588
|
-
# attributes in the request. Keep the following
|
607
|
+
# attributes in the request. Keep the following in mind:
|
589
608
|
#
|
590
609
|
# * If you don't specify the `FifoQueue` attribute, Amazon SQS creates
|
591
610
|
# a standard queue.
|
@@ -609,6 +628,11 @@ module Aws::SQS
|
|
609
628
|
# adheres to the [limits related to queues][2] and is unique within the
|
610
629
|
# scope of your queues.
|
611
630
|
#
|
631
|
+
# <note markdown="1"> After you create a queue, you must wait at least one second after the
|
632
|
+
# queue is created to be able to use the queue.
|
633
|
+
#
|
634
|
+
# </note>
|
635
|
+
#
|
612
636
|
# To get the queue URL, use the ` GetQueueUrl ` action. ` GetQueueUrl `
|
613
637
|
# requires only the `QueueName` parameter. be aware of existing queue
|
614
638
|
# names:
|
@@ -624,9 +648,9 @@ module Aws::SQS
|
|
624
648
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
625
649
|
# For example, a parameter list with two elements looks like this:
|
626
650
|
#
|
627
|
-
# `&
|
651
|
+
# `&AttributeName.1=first`
|
628
652
|
#
|
629
|
-
# `&
|
653
|
+
# `&AttributeName.2=second`
|
630
654
|
#
|
631
655
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
632
656
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -658,39 +682,39 @@ module Aws::SQS
|
|
658
682
|
# The following lists the names, descriptions, and values of the special
|
659
683
|
# request parameters that the `CreateQueue` action uses:
|
660
684
|
#
|
661
|
-
# * `DelaySeconds`
|
685
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
662
686
|
# delivery of all messages in the queue is delayed. Valid values: An
|
663
687
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
664
688
|
#
|
665
|
-
# * `MaximumMessageSize`
|
689
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
666
690
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
667
691
|
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
|
668
692
|
# (256 KiB).
|
669
693
|
#
|
670
|
-
# * `MessageRetentionPeriod`
|
694
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
671
695
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
672
696
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
673
697
|
# (4 days).
|
674
698
|
#
|
675
|
-
# * `Policy`
|
699
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
676
700
|
# information about policy structure, see [Overview of AWS IAM
|
677
701
|
# Policies][1] in the *Amazon IAM User Guide*.
|
678
702
|
#
|
679
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
703
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
680
704
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
681
705
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
682
706
|
#
|
683
|
-
# * `RedrivePolicy`
|
684
|
-
# dead-letter queue functionality of the source queue
|
685
|
-
# information about the redrive policy and
|
686
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
687
|
-
# Service Developer Guide*.
|
707
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
708
|
+
# dead-letter queue functionality of the source queue as a JSON
|
709
|
+
# object. For more information about the redrive policy and
|
710
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
711
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
688
712
|
#
|
689
|
-
# * `deadLetterTargetArn`
|
713
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
690
714
|
# dead-letter queue to which Amazon SQS moves messages after the
|
691
715
|
# value of `maxReceiveCount` is exceeded.
|
692
716
|
#
|
693
|
-
# * `maxReceiveCount`
|
717
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
694
718
|
# the source queue before being moved to the dead-letter queue. When
|
695
719
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
696
720
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -701,7 +725,7 @@ module Aws::SQS
|
|
701
725
|
#
|
702
726
|
# </note>
|
703
727
|
#
|
704
|
-
# * `VisibilityTimeout`
|
728
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
705
729
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
706
730
|
# Default: 30. For more information about the visibility timeout, see
|
707
731
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -709,14 +733,14 @@ module Aws::SQS
|
|
709
733
|
#
|
710
734
|
# The following attributes apply only to [server-side-encryption][4]\:
|
711
735
|
#
|
712
|
-
# * `KmsMasterKeyId`
|
736
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
713
737
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
714
738
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
715
739
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
716
740
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
717
741
|
# Key Management Service API Reference*.
|
718
742
|
#
|
719
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
743
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
720
744
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
721
745
|
# messages before calling AWS KMS again. An integer representing
|
722
746
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -728,7 +752,7 @@ module Aws::SQS
|
|
728
752
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
729
753
|
# queues][9]\:
|
730
754
|
#
|
731
|
-
# * `FifoQueue`
|
755
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
732
756
|
# `false`. If you don't specify the `FifoQueue` attribute, Amazon SQS
|
733
757
|
# creates a standard queue. You can provide this attribute only during
|
734
758
|
# queue creation. You can't change it for an existing queue. When you
|
@@ -738,7 +762,7 @@ module Aws::SQS
|
|
738
762
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
739
763
|
# Simple Queue Service Developer Guide*.
|
740
764
|
#
|
741
|
-
# * `ContentBasedDeduplication`
|
765
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
742
766
|
# Valid values: `true`, `false`. For more information, see
|
743
767
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
744
768
|
# Developer Guide*.
|
@@ -912,9 +936,9 @@ module Aws::SQS
|
|
912
936
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
913
937
|
# For example, a parameter list with two elements looks like this:
|
914
938
|
#
|
915
|
-
# `&
|
939
|
+
# `&AttributeName.1=first`
|
916
940
|
#
|
917
|
-
# `&
|
941
|
+
# `&AttributeName.2=second`
|
918
942
|
#
|
919
943
|
# @option params [required, String] :queue_url
|
920
944
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
@@ -961,8 +985,7 @@ module Aws::SQS
|
|
961
985
|
end
|
962
986
|
|
963
987
|
# Deletes the queue specified by the `QueueUrl`, regardless of the
|
964
|
-
# queue's contents.
|
965
|
-
# returns a successful response.
|
988
|
+
# queue's contents.
|
966
989
|
#
|
967
990
|
# Be careful with the `DeleteQueue` action: When you delete a queue, any
|
968
991
|
# messages in the queue are no longer available.
|
@@ -1014,14 +1037,6 @@ module Aws::SQS
|
|
1014
1037
|
#
|
1015
1038
|
# </note>
|
1016
1039
|
#
|
1017
|
-
# Some actions take lists of parameters. These lists are specified using
|
1018
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1019
|
-
# For example, a parameter list with two elements looks like this:
|
1020
|
-
#
|
1021
|
-
# `&Attribute.1=first`
|
1022
|
-
#
|
1023
|
-
# `&Attribute.2=second`
|
1024
|
-
#
|
1025
1040
|
#
|
1026
1041
|
#
|
1027
1042
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
@@ -1043,70 +1058,77 @@ module Aws::SQS
|
|
1043
1058
|
#
|
1044
1059
|
# The following attributes are supported:
|
1045
1060
|
#
|
1046
|
-
#
|
1061
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
1062
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
1063
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
1064
|
+
# consistency until at least 1 minute after the producers stop sending
|
1065
|
+
# messages. This period is required for the queue metadata to reach
|
1066
|
+
# eventual consistency.
|
1067
|
+
#
|
1068
|
+
# * `All` – Returns all values.
|
1047
1069
|
#
|
1048
|
-
# * `ApproximateNumberOfMessages`
|
1070
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
1049
1071
|
# messages available for retrieval from the queue.
|
1050
1072
|
#
|
1051
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
1073
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
1052
1074
|
# number of messages in the queue that are delayed and not available
|
1053
1075
|
# for reading immediately. This can happen when the queue is
|
1054
1076
|
# configured as a delay queue or when a message has been sent with a
|
1055
1077
|
# delay parameter.
|
1056
1078
|
#
|
1057
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
1079
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
1058
1080
|
# number of messages that are in flight. Messages are considered to be
|
1059
1081
|
# *in flight* if they have been sent to a client but have not yet been
|
1060
1082
|
# deleted or have not yet reached the end of their visibility window.
|
1061
1083
|
#
|
1062
|
-
# * `CreatedTimestamp`
|
1084
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created in
|
1063
1085
|
# seconds ([epoch time][1]).
|
1064
1086
|
#
|
1065
|
-
# * `DelaySeconds`
|
1087
|
+
# * `DelaySeconds` – Returns the default delay on the queue in seconds.
|
1066
1088
|
#
|
1067
|
-
# * `LastModifiedTimestamp`
|
1089
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
1068
1090
|
# changed in seconds ([epoch time][1]).
|
1069
1091
|
#
|
1070
|
-
# * `MaximumMessageSize`
|
1092
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a message
|
1071
1093
|
# can contain before Amazon SQS rejects it.
|
1072
1094
|
#
|
1073
|
-
# * `MessageRetentionPeriod`
|
1095
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1074
1096
|
# for which Amazon SQS retains a message.
|
1075
1097
|
#
|
1076
|
-
# * `Policy`
|
1098
|
+
# * `Policy` – Returns the policy of the queue.
|
1077
1099
|
#
|
1078
|
-
# * `QueueArn`
|
1100
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
1079
1101
|
#
|
1080
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
1102
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
1081
1103
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1082
1104
|
# to arrive.
|
1083
1105
|
#
|
1084
|
-
# * `RedrivePolicy`
|
1085
|
-
#
|
1086
|
-
# information about the redrive policy and
|
1087
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
1088
|
-
# Service Developer Guide*.
|
1106
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
1107
|
+
# dead-letter queue functionality of the source queue as a JSON
|
1108
|
+
# object. For more information about the redrive policy and
|
1109
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1110
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
1089
1111
|
#
|
1090
|
-
# * `deadLetterTargetArn`
|
1112
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1091
1113
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1092
1114
|
# value of `maxReceiveCount` is exceeded.
|
1093
1115
|
#
|
1094
|
-
# * `maxReceiveCount`
|
1116
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
1095
1117
|
# the source queue before being moved to the dead-letter queue. When
|
1096
1118
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
1097
1119
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
1098
1120
|
#
|
1099
|
-
# * `VisibilityTimeout`
|
1121
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1100
1122
|
# For more information about the visibility timeout, see [Visibility
|
1101
1123
|
# Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
|
1102
1124
|
#
|
1103
1125
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1104
1126
|
#
|
1105
|
-
# * `KmsMasterKeyId`
|
1127
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer master
|
1106
1128
|
# key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1107
1129
|
# [Key Terms][5].
|
1108
1130
|
#
|
1109
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
1131
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1110
1132
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1111
1133
|
# decrypt messages before calling AWS KMS again. For more information,
|
1112
1134
|
# see [How Does the Data Key Reuse Period Work?][6].
|
@@ -1114,7 +1136,7 @@ module Aws::SQS
|
|
1114
1136
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1115
1137
|
# queues][7]\:
|
1116
1138
|
#
|
1117
|
-
# * `FifoQueue`
|
1139
|
+
# * `FifoQueue` – Returns whether the queue is FIFO. For more
|
1118
1140
|
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
1119
1141
|
# Service Developer Guide*.
|
1120
1142
|
#
|
@@ -1123,7 +1145,7 @@ module Aws::SQS
|
|
1123
1145
|
#
|
1124
1146
|
# </note>
|
1125
1147
|
#
|
1126
|
-
# * `ContentBasedDeduplication`
|
1148
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
1127
1149
|
# deduplication is enabled for the queue. For more information, see
|
1128
1150
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
1129
1151
|
# Developer Guide*.
|
@@ -1228,20 +1250,32 @@ module Aws::SQS
|
|
1228
1250
|
#
|
1229
1251
|
# Queue URLs and names are case-sensitive.
|
1230
1252
|
#
|
1253
|
+
# @option params [String] :next_token
|
1254
|
+
# Pagination token to request the next set of results.
|
1255
|
+
#
|
1256
|
+
# @option params [Integer] :max_results
|
1257
|
+
# Maximum number of results to include in the response.
|
1258
|
+
#
|
1231
1259
|
# @return [Types::ListDeadLetterSourceQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1232
1260
|
#
|
1233
1261
|
# * {Types::ListDeadLetterSourceQueuesResult#queue_urls #queue_urls} => Array<String>
|
1262
|
+
# * {Types::ListDeadLetterSourceQueuesResult#next_token #next_token} => String
|
1263
|
+
#
|
1264
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1234
1265
|
#
|
1235
1266
|
# @example Request syntax with placeholder values
|
1236
1267
|
#
|
1237
1268
|
# resp = client.list_dead_letter_source_queues({
|
1238
1269
|
# queue_url: "String", # required
|
1270
|
+
# next_token: "Token",
|
1271
|
+
# max_results: 1,
|
1239
1272
|
# })
|
1240
1273
|
#
|
1241
1274
|
# @example Response structure
|
1242
1275
|
#
|
1243
1276
|
# resp.queue_urls #=> Array
|
1244
1277
|
# resp.queue_urls[0] #=> String
|
1278
|
+
# resp.next_token #=> String
|
1245
1279
|
#
|
1246
1280
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues AWS API Documentation
|
1247
1281
|
#
|
@@ -1315,20 +1349,32 @@ module Aws::SQS
|
|
1315
1349
|
#
|
1316
1350
|
# Queue URLs and names are case-sensitive.
|
1317
1351
|
#
|
1352
|
+
# @option params [String] :next_token
|
1353
|
+
# Pagination token to request the next set of results.
|
1354
|
+
#
|
1355
|
+
# @option params [Integer] :max_results
|
1356
|
+
# Maximum number of results to include in the response.
|
1357
|
+
#
|
1318
1358
|
# @return [Types::ListQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1319
1359
|
#
|
1320
1360
|
# * {Types::ListQueuesResult#queue_urls #queue_urls} => Array<String>
|
1361
|
+
# * {Types::ListQueuesResult#next_token #next_token} => String
|
1362
|
+
#
|
1363
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1321
1364
|
#
|
1322
1365
|
# @example Request syntax with placeholder values
|
1323
1366
|
#
|
1324
1367
|
# resp = client.list_queues({
|
1325
1368
|
# queue_name_prefix: "String",
|
1369
|
+
# next_token: "Token",
|
1370
|
+
# max_results: 1,
|
1326
1371
|
# })
|
1327
1372
|
#
|
1328
1373
|
# @example Response structure
|
1329
1374
|
#
|
1330
1375
|
# resp.queue_urls #=> Array
|
1331
1376
|
# resp.queue_urls[0] #=> String
|
1377
|
+
# resp.next_token #=> String
|
1332
1378
|
#
|
1333
1379
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues AWS API Documentation
|
1334
1380
|
#
|
@@ -1443,15 +1489,15 @@ module Aws::SQS
|
|
1443
1489
|
# A list of attributes that need to be returned along with each message.
|
1444
1490
|
# These attributes include:
|
1445
1491
|
#
|
1446
|
-
# * `All`
|
1492
|
+
# * `All` – Returns all values.
|
1447
1493
|
#
|
1448
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1494
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1449
1495
|
# was first received from the queue ([epoch time][1] in milliseconds).
|
1450
1496
|
#
|
1451
|
-
# * `ApproximateReceiveCount`
|
1452
|
-
# has been received
|
1497
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1498
|
+
# has been received across all queues but not deleted.
|
1453
1499
|
#
|
1454
|
-
# * `AWSTraceHeader`
|
1500
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1455
1501
|
#
|
1456
1502
|
# * `SenderId`
|
1457
1503
|
#
|
@@ -1461,17 +1507,17 @@ module Aws::SQS
|
|
1461
1507
|
# * For an IAM role, returns the IAM role ID, for example
|
1462
1508
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1463
1509
|
#
|
1464
|
-
# * `SentTimestamp`
|
1510
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1465
1511
|
# ([epoch time][1] in milliseconds).
|
1466
1512
|
#
|
1467
|
-
# * `MessageDeduplicationId`
|
1513
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1468
1514
|
# producer that calls the ` SendMessage ` action.
|
1469
1515
|
#
|
1470
|
-
# * `MessageGroupId`
|
1516
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1471
1517
|
# calls the ` SendMessage ` action. Messages with the same
|
1472
1518
|
# `MessageGroupId` are returned in sequence.
|
1473
1519
|
#
|
1474
|
-
# * `SequenceNumber`
|
1520
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1475
1521
|
#
|
1476
1522
|
#
|
1477
1523
|
#
|
@@ -1516,14 +1562,25 @@ module Aws::SQS
|
|
1516
1562
|
# available and the wait time expires, the call returns successfully
|
1517
1563
|
# with an empty list of messages.
|
1518
1564
|
#
|
1565
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1566
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1567
|
+
# parameter. For example, with the Java SDK, you can set HTTP transport
|
1568
|
+
# settings using the [ NettyNioAsyncHttpClient][1] for asynchronous
|
1569
|
+
# clients, or the [ ApacheHttpClient][2] for synchronous clients.
|
1570
|
+
#
|
1571
|
+
#
|
1572
|
+
#
|
1573
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1574
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1575
|
+
#
|
1519
1576
|
# @option params [String] :receive_request_attempt_id
|
1520
1577
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1521
1578
|
#
|
1522
1579
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1523
1580
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1524
|
-
# of a response you receive a generic error,
|
1525
|
-
# action with an identical `ReceiveRequestAttemptId` to retrieve
|
1526
|
-
# same set of messages, even if their visibility timeout has not yet
|
1581
|
+
# of a response you receive a generic error, it is possible to retry the
|
1582
|
+
# same action with an identical `ReceiveRequestAttemptId` to retrieve
|
1583
|
+
# the same set of messages, even if their visibility timeout has not yet
|
1527
1584
|
# expired.
|
1528
1585
|
#
|
1529
1586
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
@@ -1536,7 +1593,7 @@ module Aws::SQS
|
|
1536
1593
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1537
1594
|
# `ReceiveRequestAttemptId`.
|
1538
1595
|
#
|
1539
|
-
# *
|
1596
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1540
1597
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
1541
1598
|
# (deleted or had their visibility changes).
|
1542
1599
|
#
|
@@ -1567,7 +1624,7 @@ module Aws::SQS
|
|
1567
1624
|
# visibility timeout expires. As a result, delays might occur but the
|
1568
1625
|
# messages in the queue remain in a strict order.
|
1569
1626
|
#
|
1570
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1627
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1571
1628
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
|
1572
1629
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1573
1630
|
# ``).
|
@@ -1734,7 +1791,7 @@ module Aws::SQS
|
|
1734
1791
|
#
|
1735
1792
|
# * Currently, the only supported message system attribute is
|
1736
1793
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1737
|
-
# correctly formatted AWS X-Ray trace string.
|
1794
|
+
# correctly formatted AWS X-Ray trace header string.
|
1738
1795
|
#
|
1739
1796
|
# * The size of a message system attribute doesn't count towards the
|
1740
1797
|
# total size of a message.
|
@@ -1787,7 +1844,7 @@ module Aws::SQS
|
|
1787
1844
|
#
|
1788
1845
|
# </note>
|
1789
1846
|
#
|
1790
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
1847
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1791
1848
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1792
1849
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1793
1850
|
# ``).
|
@@ -1917,9 +1974,9 @@ module Aws::SQS
|
|
1917
1974
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1918
1975
|
# For example, a parameter list with two elements looks like this:
|
1919
1976
|
#
|
1920
|
-
# `&
|
1977
|
+
# `&AttributeName.1=first`
|
1921
1978
|
#
|
1922
|
-
# `&
|
1979
|
+
# `&AttributeName.2=second`
|
1923
1980
|
#
|
1924
1981
|
#
|
1925
1982
|
#
|
@@ -2030,39 +2087,39 @@ module Aws::SQS
|
|
2030
2087
|
# The following lists the names, descriptions, and values of the special
|
2031
2088
|
# request parameters that the `SetQueueAttributes` action uses:
|
2032
2089
|
#
|
2033
|
-
# * `DelaySeconds`
|
2090
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2034
2091
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2035
2092
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2036
2093
|
#
|
2037
|
-
# * `MaximumMessageSize`
|
2094
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2038
2095
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
2039
2096
|
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
|
2040
2097
|
# (256 KiB).
|
2041
2098
|
#
|
2042
|
-
# * `MessageRetentionPeriod`
|
2099
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2043
2100
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2044
2101
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2045
2102
|
# (4 days).
|
2046
2103
|
#
|
2047
|
-
# * `Policy`
|
2104
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2048
2105
|
# information about policy structure, see [Overview of AWS IAM
|
2049
2106
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2050
2107
|
#
|
2051
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2108
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2052
2109
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2053
|
-
# Valid values:
|
2110
|
+
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2054
2111
|
#
|
2055
|
-
# * `RedrivePolicy`
|
2056
|
-
# dead-letter queue functionality of the source queue
|
2057
|
-
# information about the redrive policy and
|
2058
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
2059
|
-
# Service Developer Guide*.
|
2112
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2113
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2114
|
+
# object. For more information about the redrive policy and
|
2115
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2116
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
2060
2117
|
#
|
2061
|
-
# * `deadLetterTargetArn`
|
2118
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2062
2119
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2063
2120
|
# value of `maxReceiveCount` is exceeded.
|
2064
2121
|
#
|
2065
|
-
# * `maxReceiveCount`
|
2122
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
2066
2123
|
# the source queue before being moved to the dead-letter queue. When
|
2067
2124
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
2068
2125
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -2073,22 +2130,22 @@ module Aws::SQS
|
|
2073
2130
|
#
|
2074
2131
|
# </note>
|
2075
2132
|
#
|
2076
|
-
# * `VisibilityTimeout`
|
2077
|
-
# seconds. Valid values:
|
2133
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2134
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2078
2135
|
# Default: 30. For more information about the visibility timeout, see
|
2079
2136
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2080
2137
|
# Developer Guide*.
|
2081
2138
|
#
|
2082
2139
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2083
2140
|
#
|
2084
|
-
# * `KmsMasterKeyId`
|
2141
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2085
2142
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
2086
2143
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
2087
2144
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
2088
2145
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
2089
2146
|
# Key Management Service API Reference*.
|
2090
2147
|
#
|
2091
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2148
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2092
2149
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2093
2150
|
# messages before calling AWS KMS again. An integer representing
|
2094
2151
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -2100,7 +2157,7 @@ module Aws::SQS
|
|
2100
2157
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2101
2158
|
# queues][9]\:
|
2102
2159
|
#
|
2103
|
-
# * `ContentBasedDeduplication`
|
2160
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2104
2161
|
# For more information, see [Exactly-Once Processing][10] in the
|
2105
2162
|
# *Amazon Simple Queue Service Developer Guide*.
|
2106
2163
|
#
|
@@ -2274,7 +2331,7 @@ module Aws::SQS
|
|
2274
2331
|
params: params,
|
2275
2332
|
config: config)
|
2276
2333
|
context[:gem_name] = 'aws-sdk-sqs'
|
2277
|
-
context[:gem_version] = '1.
|
2334
|
+
context[:gem_version] = '1.31.0'
|
2278
2335
|
Seahorse::Client::Request.new(handlers, context)
|
2279
2336
|
end
|
2280
2337
|
|