aws-sdk-sqs 1.27.1 → 1.32.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 +4 -2
- data/lib/aws-sdk-sqs/client.rb +188 -111
- 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 +4 -2
- 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 +59 -43
- 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 +208 -93
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 700e1915dc31ea0a9b236df23b5827a443dfe54654f8270c26795f9d83a59f82
|
4
|
+
data.tar.gz: b7daa764974f73e9c60608ed21617c683124925f978e97c9faa6ce9e4bebd206
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1aaadbaee5e8386474c504feace8a742a018a1b42ea9ac03fb8c56f680d0333b2e0dab4c8c5031e2463b54cbaef83e05155024e52484d4ae2a95bd6668054785
|
7
|
+
data.tar.gz: 4ea0132c39036c71e6b2592d92e7fa55af932381ce40de0892c87752fb79356a759824277e0cc90ee7d8982046d89c3aaa98b526a176be8be117160f21f033be
|
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.32.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:
|
@@ -87,13 +89,28 @@ module Aws::SQS
|
|
87
89
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
88
90
|
# credentials.
|
89
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
|
+
#
|
90
106
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
91
107
|
# from an EC2 IMDS on an EC2 instance.
|
92
108
|
#
|
93
|
-
# * `Aws::
|
94
|
-
#
|
109
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
110
|
+
# instances running in ECS.
|
95
111
|
#
|
96
|
-
# * `Aws::
|
112
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
113
|
+
# from the Cognito Identity service.
|
97
114
|
#
|
98
115
|
# When `:credentials` are not configured directly, the following
|
99
116
|
# locations will be searched for credentials:
|
@@ -103,10 +120,10 @@ module Aws::SQS
|
|
103
120
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
104
121
|
# * `~/.aws/credentials`
|
105
122
|
# * `~/.aws/config`
|
106
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
107
|
-
# very aggressive. Construct and pass an instance of
|
108
|
-
# `Aws::InstanceProfileCredentails`
|
109
|
-
# 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.
|
110
127
|
#
|
111
128
|
# @option options [required, String] :region
|
112
129
|
# The AWS region to connect to. The configured `:region` is
|
@@ -346,9 +363,9 @@ module Aws::SQS
|
|
346
363
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
347
364
|
# For example, a parameter list with two elements looks like this:
|
348
365
|
#
|
349
|
-
# `&
|
366
|
+
# `&AttributeName.1=first`
|
350
367
|
#
|
351
|
-
# `&
|
368
|
+
# `&AttributeName.2=second`
|
352
369
|
#
|
353
370
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
354
371
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -500,7 +517,7 @@ module Aws::SQS
|
|
500
517
|
#
|
501
518
|
# @option params [required, Integer] :visibility_timeout
|
502
519
|
# The new value for the message's visibility timeout (in seconds).
|
503
|
-
# Values
|
520
|
+
# Values range: `0` to `43200`. Maximum: 12 hours.
|
504
521
|
#
|
505
522
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
506
523
|
#
|
@@ -535,9 +552,9 @@ module Aws::SQS
|
|
535
552
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
536
553
|
# For example, a parameter list with two elements looks like this:
|
537
554
|
#
|
538
|
-
# `&
|
555
|
+
# `&AttributeName.1=first`
|
539
556
|
#
|
540
|
-
# `&
|
557
|
+
# `&AttributeName.2=second`
|
541
558
|
#
|
542
559
|
# @option params [required, String] :queue_url
|
543
560
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
@@ -587,7 +604,7 @@ module Aws::SQS
|
|
587
604
|
end
|
588
605
|
|
589
606
|
# Creates a new standard or FIFO queue. You can pass one or more
|
590
|
-
# attributes in the request. Keep the following
|
607
|
+
# attributes in the request. Keep the following in mind:
|
591
608
|
#
|
592
609
|
# * If you don't specify the `FifoQueue` attribute, Amazon SQS creates
|
593
610
|
# a standard queue.
|
@@ -611,6 +628,11 @@ module Aws::SQS
|
|
611
628
|
# adheres to the [limits related to queues][2] and is unique within the
|
612
629
|
# scope of your queues.
|
613
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
|
+
#
|
614
636
|
# To get the queue URL, use the ` GetQueueUrl ` action. ` GetQueueUrl `
|
615
637
|
# requires only the `QueueName` parameter. be aware of existing queue
|
616
638
|
# names:
|
@@ -626,9 +648,9 @@ module Aws::SQS
|
|
626
648
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
627
649
|
# For example, a parameter list with two elements looks like this:
|
628
650
|
#
|
629
|
-
# `&
|
651
|
+
# `&AttributeName.1=first`
|
630
652
|
#
|
631
|
-
# `&
|
653
|
+
# `&AttributeName.2=second`
|
632
654
|
#
|
633
655
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
634
656
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -660,39 +682,39 @@ module Aws::SQS
|
|
660
682
|
# The following lists the names, descriptions, and values of the special
|
661
683
|
# request parameters that the `CreateQueue` action uses:
|
662
684
|
#
|
663
|
-
# * `DelaySeconds`
|
685
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
664
686
|
# delivery of all messages in the queue is delayed. Valid values: An
|
665
687
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
666
688
|
#
|
667
|
-
# * `MaximumMessageSize`
|
689
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
668
690
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
669
691
|
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
|
670
692
|
# (256 KiB).
|
671
693
|
#
|
672
|
-
# * `MessageRetentionPeriod`
|
694
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
673
695
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
674
696
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
675
697
|
# (4 days).
|
676
698
|
#
|
677
|
-
# * `Policy`
|
699
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
678
700
|
# information about policy structure, see [Overview of AWS IAM
|
679
701
|
# Policies][1] in the *Amazon IAM User Guide*.
|
680
702
|
#
|
681
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
703
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
682
704
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
683
705
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
684
706
|
#
|
685
|
-
# * `RedrivePolicy`
|
686
|
-
# dead-letter queue functionality of the source queue
|
687
|
-
# information about the redrive policy and
|
688
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
689
|
-
# Service Developer Guide*.
|
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*.
|
690
712
|
#
|
691
|
-
# * `deadLetterTargetArn`
|
713
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
692
714
|
# dead-letter queue to which Amazon SQS moves messages after the
|
693
715
|
# value of `maxReceiveCount` is exceeded.
|
694
716
|
#
|
695
|
-
# * `maxReceiveCount`
|
717
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
696
718
|
# the source queue before being moved to the dead-letter queue. When
|
697
719
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
698
720
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -703,7 +725,7 @@ module Aws::SQS
|
|
703
725
|
#
|
704
726
|
# </note>
|
705
727
|
#
|
706
|
-
# * `VisibilityTimeout`
|
728
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
707
729
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
708
730
|
# Default: 30. For more information about the visibility timeout, see
|
709
731
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -711,14 +733,14 @@ module Aws::SQS
|
|
711
733
|
#
|
712
734
|
# The following attributes apply only to [server-side-encryption][4]\:
|
713
735
|
#
|
714
|
-
# * `KmsMasterKeyId`
|
736
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
715
737
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
716
738
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
717
739
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
718
740
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
719
741
|
# Key Management Service API Reference*.
|
720
742
|
#
|
721
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
743
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
722
744
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
723
745
|
# messages before calling AWS KMS again. An integer representing
|
724
746
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -730,7 +752,7 @@ module Aws::SQS
|
|
730
752
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
731
753
|
# queues][9]\:
|
732
754
|
#
|
733
|
-
# * `FifoQueue`
|
755
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
734
756
|
# `false`. If you don't specify the `FifoQueue` attribute, Amazon SQS
|
735
757
|
# creates a standard queue. You can provide this attribute only during
|
736
758
|
# queue creation. You can't change it for an existing queue. When you
|
@@ -740,7 +762,7 @@ module Aws::SQS
|
|
740
762
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
741
763
|
# Simple Queue Service Developer Guide*.
|
742
764
|
#
|
743
|
-
# * `ContentBasedDeduplication`
|
765
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
744
766
|
# Valid values: `true`, `false`. For more information, see
|
745
767
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
746
768
|
# Developer Guide*.
|
@@ -914,9 +936,9 @@ module Aws::SQS
|
|
914
936
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
915
937
|
# For example, a parameter list with two elements looks like this:
|
916
938
|
#
|
917
|
-
# `&
|
939
|
+
# `&AttributeName.1=first`
|
918
940
|
#
|
919
|
-
# `&
|
941
|
+
# `&AttributeName.2=second`
|
920
942
|
#
|
921
943
|
# @option params [required, String] :queue_url
|
922
944
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
@@ -963,8 +985,7 @@ module Aws::SQS
|
|
963
985
|
end
|
964
986
|
|
965
987
|
# Deletes the queue specified by the `QueueUrl`, regardless of the
|
966
|
-
# queue's contents.
|
967
|
-
# returns a successful response.
|
988
|
+
# queue's contents.
|
968
989
|
#
|
969
990
|
# Be careful with the `DeleteQueue` action: When you delete a queue, any
|
970
991
|
# messages in the queue are no longer available.
|
@@ -1016,14 +1037,6 @@ module Aws::SQS
|
|
1016
1037
|
#
|
1017
1038
|
# </note>
|
1018
1039
|
#
|
1019
|
-
# Some actions take lists of parameters. These lists are specified using
|
1020
|
-
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1021
|
-
# For example, a parameter list with two elements looks like this:
|
1022
|
-
#
|
1023
|
-
# `&Attribute.1=first`
|
1024
|
-
#
|
1025
|
-
# `&Attribute.2=second`
|
1026
|
-
#
|
1027
1040
|
#
|
1028
1041
|
#
|
1029
1042
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
@@ -1045,70 +1058,77 @@ module Aws::SQS
|
|
1045
1058
|
#
|
1046
1059
|
# The following attributes are supported:
|
1047
1060
|
#
|
1048
|
-
#
|
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.
|
1049
1069
|
#
|
1050
|
-
# * `ApproximateNumberOfMessages`
|
1070
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
1051
1071
|
# messages available for retrieval from the queue.
|
1052
1072
|
#
|
1053
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
1073
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
1054
1074
|
# number of messages in the queue that are delayed and not available
|
1055
1075
|
# for reading immediately. This can happen when the queue is
|
1056
1076
|
# configured as a delay queue or when a message has been sent with a
|
1057
1077
|
# delay parameter.
|
1058
1078
|
#
|
1059
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
1079
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
1060
1080
|
# number of messages that are in flight. Messages are considered to be
|
1061
1081
|
# *in flight* if they have been sent to a client but have not yet been
|
1062
1082
|
# deleted or have not yet reached the end of their visibility window.
|
1063
1083
|
#
|
1064
|
-
# * `CreatedTimestamp`
|
1084
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created in
|
1065
1085
|
# seconds ([epoch time][1]).
|
1066
1086
|
#
|
1067
|
-
# * `DelaySeconds`
|
1087
|
+
# * `DelaySeconds` – Returns the default delay on the queue in seconds.
|
1068
1088
|
#
|
1069
|
-
# * `LastModifiedTimestamp`
|
1089
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
1070
1090
|
# changed in seconds ([epoch time][1]).
|
1071
1091
|
#
|
1072
|
-
# * `MaximumMessageSize`
|
1092
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a message
|
1073
1093
|
# can contain before Amazon SQS rejects it.
|
1074
1094
|
#
|
1075
|
-
# * `MessageRetentionPeriod`
|
1095
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1076
1096
|
# for which Amazon SQS retains a message.
|
1077
1097
|
#
|
1078
|
-
# * `Policy`
|
1098
|
+
# * `Policy` – Returns the policy of the queue.
|
1079
1099
|
#
|
1080
|
-
# * `QueueArn`
|
1100
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
1081
1101
|
#
|
1082
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
1102
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
1083
1103
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1084
1104
|
# to arrive.
|
1085
1105
|
#
|
1086
|
-
# * `RedrivePolicy`
|
1087
|
-
#
|
1088
|
-
# information about the redrive policy and
|
1089
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
1090
|
-
# 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*.
|
1091
1111
|
#
|
1092
|
-
# * `deadLetterTargetArn`
|
1112
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1093
1113
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1094
1114
|
# value of `maxReceiveCount` is exceeded.
|
1095
1115
|
#
|
1096
|
-
# * `maxReceiveCount`
|
1116
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
1097
1117
|
# the source queue before being moved to the dead-letter queue. When
|
1098
1118
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
1099
1119
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
1100
1120
|
#
|
1101
|
-
# * `VisibilityTimeout`
|
1121
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1102
1122
|
# For more information about the visibility timeout, see [Visibility
|
1103
1123
|
# Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
|
1104
1124
|
#
|
1105
1125
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1106
1126
|
#
|
1107
|
-
# * `KmsMasterKeyId`
|
1127
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer master
|
1108
1128
|
# key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1109
1129
|
# [Key Terms][5].
|
1110
1130
|
#
|
1111
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
1131
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1112
1132
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1113
1133
|
# decrypt messages before calling AWS KMS again. For more information,
|
1114
1134
|
# see [How Does the Data Key Reuse Period Work?][6].
|
@@ -1116,7 +1136,7 @@ module Aws::SQS
|
|
1116
1136
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1117
1137
|
# queues][7]\:
|
1118
1138
|
#
|
1119
|
-
# * `FifoQueue`
|
1139
|
+
# * `FifoQueue` – Returns whether the queue is FIFO. For more
|
1120
1140
|
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
1121
1141
|
# Service Developer Guide*.
|
1122
1142
|
#
|
@@ -1125,7 +1145,7 @@ module Aws::SQS
|
|
1125
1145
|
#
|
1126
1146
|
# </note>
|
1127
1147
|
#
|
1128
|
-
# * `ContentBasedDeduplication`
|
1148
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
1129
1149
|
# deduplication is enabled for the queue. For more information, see
|
1130
1150
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
1131
1151
|
# Developer Guide*.
|
@@ -1217,6 +1237,15 @@ module Aws::SQS
|
|
1217
1237
|
# Returns a list of your queues that have the `RedrivePolicy` queue
|
1218
1238
|
# attribute configured with a dead-letter queue.
|
1219
1239
|
#
|
1240
|
+
# The `ListDeadLetterSourceQueues` methods supports pagination. Set
|
1241
|
+
# parameter `MaxResults` in the request to specify the maximum number of
|
1242
|
+
# results to be returned in the response. If you do not set
|
1243
|
+
# `MaxResults`, the response includes a maximum of 1,000 results. If you
|
1244
|
+
# set `MaxResults` and there are additional results to display, the
|
1245
|
+
# response includes a value for `NextToken`. Use `NextToken` as a
|
1246
|
+
# parameter in your next request to `ListDeadLetterSourceQueues` to
|
1247
|
+
# receive the next page of results.
|
1248
|
+
#
|
1220
1249
|
# For more information about using dead-letter queues, see [Using Amazon
|
1221
1250
|
# SQS Dead-Letter Queues][1] in the *Amazon Simple Queue Service
|
1222
1251
|
# Developer Guide*.
|
@@ -1230,20 +1259,34 @@ module Aws::SQS
|
|
1230
1259
|
#
|
1231
1260
|
# Queue URLs and names are case-sensitive.
|
1232
1261
|
#
|
1262
|
+
# @option params [String] :next_token
|
1263
|
+
# Pagination token to request the next set of results.
|
1264
|
+
#
|
1265
|
+
# @option params [Integer] :max_results
|
1266
|
+
# Maximum number of results to include in the response. Value range is 1
|
1267
|
+
# to 1000. You must set `MaxResults` to receive a value for `NextToken`
|
1268
|
+
# in the response.
|
1269
|
+
#
|
1233
1270
|
# @return [Types::ListDeadLetterSourceQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1234
1271
|
#
|
1235
1272
|
# * {Types::ListDeadLetterSourceQueuesResult#queue_urls #queue_urls} => Array<String>
|
1273
|
+
# * {Types::ListDeadLetterSourceQueuesResult#next_token #next_token} => String
|
1274
|
+
#
|
1275
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1236
1276
|
#
|
1237
1277
|
# @example Request syntax with placeholder values
|
1238
1278
|
#
|
1239
1279
|
# resp = client.list_dead_letter_source_queues({
|
1240
1280
|
# queue_url: "String", # required
|
1281
|
+
# next_token: "Token",
|
1282
|
+
# max_results: 1,
|
1241
1283
|
# })
|
1242
1284
|
#
|
1243
1285
|
# @example Response structure
|
1244
1286
|
#
|
1245
1287
|
# resp.queue_urls #=> Array
|
1246
1288
|
# resp.queue_urls[0] #=> String
|
1289
|
+
# resp.next_token #=> String
|
1247
1290
|
#
|
1248
1291
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues AWS API Documentation
|
1249
1292
|
#
|
@@ -1296,10 +1339,18 @@ module Aws::SQS
|
|
1296
1339
|
req.send_request(options)
|
1297
1340
|
end
|
1298
1341
|
|
1299
|
-
# Returns a list of your queues
|
1300
|
-
#
|
1301
|
-
# `QueueNamePrefix` parameter, only queues with a name that
|
1302
|
-
# the specified value are returned.
|
1342
|
+
# Returns a list of your queues in the current region. The response
|
1343
|
+
# includes a maximum of 1,000 results. If you specify a value for the
|
1344
|
+
# optional `QueueNamePrefix` parameter, only queues with a name that
|
1345
|
+
# begins with the specified value are returned.
|
1346
|
+
#
|
1347
|
+
# The `listQueues` methods supports pagination. Set parameter
|
1348
|
+
# `MaxResults` in the request to specify the maximum number of results
|
1349
|
+
# to be returned in the response. If you do not set `MaxResults`, the
|
1350
|
+
# response includes a maximum of 1,000 results. If you set `MaxResults`
|
1351
|
+
# and there are additional results to display, the response includes a
|
1352
|
+
# value for `NextToken`. Use `NextToken` as a parameter in your next
|
1353
|
+
# request to `listQueues` to receive the next page of results.
|
1303
1354
|
#
|
1304
1355
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1305
1356
|
# information, see [Grant Cross-Account Permissions to a Role and a User
|
@@ -1317,20 +1368,34 @@ module Aws::SQS
|
|
1317
1368
|
#
|
1318
1369
|
# Queue URLs and names are case-sensitive.
|
1319
1370
|
#
|
1371
|
+
# @option params [String] :next_token
|
1372
|
+
# Pagination token to request the next set of results.
|
1373
|
+
#
|
1374
|
+
# @option params [Integer] :max_results
|
1375
|
+
# Maximum number of results to include in the response. Value range is 1
|
1376
|
+
# to 1000. You must set `MaxResults` to receive a value for `NextToken`
|
1377
|
+
# in the response.
|
1378
|
+
#
|
1320
1379
|
# @return [Types::ListQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
1380
|
#
|
1322
1381
|
# * {Types::ListQueuesResult#queue_urls #queue_urls} => Array<String>
|
1382
|
+
# * {Types::ListQueuesResult#next_token #next_token} => String
|
1383
|
+
#
|
1384
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1323
1385
|
#
|
1324
1386
|
# @example Request syntax with placeholder values
|
1325
1387
|
#
|
1326
1388
|
# resp = client.list_queues({
|
1327
1389
|
# queue_name_prefix: "String",
|
1390
|
+
# next_token: "Token",
|
1391
|
+
# max_results: 1,
|
1328
1392
|
# })
|
1329
1393
|
#
|
1330
1394
|
# @example Response structure
|
1331
1395
|
#
|
1332
1396
|
# resp.queue_urls #=> Array
|
1333
1397
|
# resp.queue_urls[0] #=> String
|
1398
|
+
# resp.next_token #=> String
|
1334
1399
|
#
|
1335
1400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues AWS API Documentation
|
1336
1401
|
#
|
@@ -1445,15 +1510,15 @@ module Aws::SQS
|
|
1445
1510
|
# A list of attributes that need to be returned along with each message.
|
1446
1511
|
# These attributes include:
|
1447
1512
|
#
|
1448
|
-
# * `All`
|
1513
|
+
# * `All` – Returns all values.
|
1449
1514
|
#
|
1450
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1515
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1451
1516
|
# was first received from the queue ([epoch time][1] in milliseconds).
|
1452
1517
|
#
|
1453
|
-
# * `ApproximateReceiveCount`
|
1454
|
-
# has been received
|
1518
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1519
|
+
# has been received across all queues but not deleted.
|
1455
1520
|
#
|
1456
|
-
# * `AWSTraceHeader`
|
1521
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1457
1522
|
#
|
1458
1523
|
# * `SenderId`
|
1459
1524
|
#
|
@@ -1463,17 +1528,17 @@ module Aws::SQS
|
|
1463
1528
|
# * For an IAM role, returns the IAM role ID, for example
|
1464
1529
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1465
1530
|
#
|
1466
|
-
# * `SentTimestamp`
|
1531
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1467
1532
|
# ([epoch time][1] in milliseconds).
|
1468
1533
|
#
|
1469
|
-
# * `MessageDeduplicationId`
|
1534
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1470
1535
|
# producer that calls the ` SendMessage ` action.
|
1471
1536
|
#
|
1472
|
-
# * `MessageGroupId`
|
1537
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1473
1538
|
# calls the ` SendMessage ` action. Messages with the same
|
1474
1539
|
# `MessageGroupId` are returned in sequence.
|
1475
1540
|
#
|
1476
|
-
# * `SequenceNumber`
|
1541
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1477
1542
|
#
|
1478
1543
|
#
|
1479
1544
|
#
|
@@ -1518,14 +1583,25 @@ module Aws::SQS
|
|
1518
1583
|
# available and the wait time expires, the call returns successfully
|
1519
1584
|
# with an empty list of messages.
|
1520
1585
|
#
|
1586
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1587
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1588
|
+
# parameter. For example, with the Java SDK, you can set HTTP transport
|
1589
|
+
# settings using the [ NettyNioAsyncHttpClient][1] for asynchronous
|
1590
|
+
# clients, or the [ ApacheHttpClient][2] for synchronous clients.
|
1591
|
+
#
|
1592
|
+
#
|
1593
|
+
#
|
1594
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1595
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1596
|
+
#
|
1521
1597
|
# @option params [String] :receive_request_attempt_id
|
1522
1598
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1523
1599
|
#
|
1524
1600
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1525
1601
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1526
|
-
# of a response you receive a generic error,
|
1527
|
-
# action with an identical `ReceiveRequestAttemptId` to retrieve
|
1528
|
-
# same set of messages, even if their visibility timeout has not yet
|
1602
|
+
# of a response you receive a generic error, it is possible to retry the
|
1603
|
+
# same action with an identical `ReceiveRequestAttemptId` to retrieve
|
1604
|
+
# the same set of messages, even if their visibility timeout has not yet
|
1529
1605
|
# expired.
|
1530
1606
|
#
|
1531
1607
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
@@ -1538,7 +1614,7 @@ module Aws::SQS
|
|
1538
1614
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1539
1615
|
# `ReceiveRequestAttemptId`.
|
1540
1616
|
#
|
1541
|
-
# *
|
1617
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1542
1618
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
1543
1619
|
# (deleted or had their visibility changes).
|
1544
1620
|
#
|
@@ -1569,7 +1645,7 @@ module Aws::SQS
|
|
1569
1645
|
# visibility timeout expires. As a result, delays might occur but the
|
1570
1646
|
# messages in the queue remain in a strict order.
|
1571
1647
|
#
|
1572
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1648
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1573
1649
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
|
1574
1650
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1575
1651
|
# ``).
|
@@ -1694,7 +1770,8 @@ module Aws::SQS
|
|
1694
1770
|
# Queue URLs and names are case-sensitive.
|
1695
1771
|
#
|
1696
1772
|
# @option params [required, String] :message_body
|
1697
|
-
# The message to send. The
|
1773
|
+
# The message to send. The minimum size is one character. The maximum
|
1774
|
+
# size is 256 KB.
|
1698
1775
|
#
|
1699
1776
|
# A message can include only XML, JSON, and unformatted text. The
|
1700
1777
|
# following Unicode characters are allowed:
|
@@ -1728,7 +1805,7 @@ module Aws::SQS
|
|
1728
1805
|
#
|
1729
1806
|
#
|
1730
1807
|
#
|
1731
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1808
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1732
1809
|
#
|
1733
1810
|
# @option params [Hash<String,Types::MessageSystemAttributeValue>] :message_system_attributes
|
1734
1811
|
# The message system attribute to send. Each message system attribute
|
@@ -1736,7 +1813,7 @@ module Aws::SQS
|
|
1736
1813
|
#
|
1737
1814
|
# * Currently, the only supported message system attribute is
|
1738
1815
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1739
|
-
# correctly formatted AWS X-Ray trace string.
|
1816
|
+
# correctly formatted AWS X-Ray trace header string.
|
1740
1817
|
#
|
1741
1818
|
# * The size of a message system attribute doesn't count towards the
|
1742
1819
|
# total size of a message.
|
@@ -1789,7 +1866,7 @@ module Aws::SQS
|
|
1789
1866
|
#
|
1790
1867
|
# </note>
|
1791
1868
|
#
|
1792
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
1869
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1793
1870
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1794
1871
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1795
1872
|
# ``).
|
@@ -1919,9 +1996,9 @@ module Aws::SQS
|
|
1919
1996
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1920
1997
|
# For example, a parameter list with two elements looks like this:
|
1921
1998
|
#
|
1922
|
-
# `&
|
1999
|
+
# `&AttributeName.1=first`
|
1923
2000
|
#
|
1924
|
-
# `&
|
2001
|
+
# `&AttributeName.2=second`
|
1925
2002
|
#
|
1926
2003
|
#
|
1927
2004
|
#
|
@@ -2032,39 +2109,39 @@ module Aws::SQS
|
|
2032
2109
|
# The following lists the names, descriptions, and values of the special
|
2033
2110
|
# request parameters that the `SetQueueAttributes` action uses:
|
2034
2111
|
#
|
2035
|
-
# * `DelaySeconds`
|
2112
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2036
2113
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2037
2114
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2038
2115
|
#
|
2039
|
-
# * `MaximumMessageSize`
|
2116
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2040
2117
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
2041
2118
|
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
|
2042
2119
|
# (256 KiB).
|
2043
2120
|
#
|
2044
|
-
# * `MessageRetentionPeriod`
|
2121
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2045
2122
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2046
2123
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2047
2124
|
# (4 days).
|
2048
2125
|
#
|
2049
|
-
# * `Policy`
|
2126
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2050
2127
|
# information about policy structure, see [Overview of AWS IAM
|
2051
2128
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2052
2129
|
#
|
2053
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2130
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2054
2131
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2055
|
-
# Valid values:
|
2132
|
+
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2056
2133
|
#
|
2057
|
-
# * `RedrivePolicy`
|
2058
|
-
# dead-letter queue functionality of the source queue
|
2059
|
-
# information about the redrive policy and
|
2060
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
2061
|
-
# Service Developer Guide*.
|
2134
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2135
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2136
|
+
# object. For more information about the redrive policy and
|
2137
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2138
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
2062
2139
|
#
|
2063
|
-
# * `deadLetterTargetArn`
|
2140
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2064
2141
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2065
2142
|
# value of `maxReceiveCount` is exceeded.
|
2066
2143
|
#
|
2067
|
-
# * `maxReceiveCount`
|
2144
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
2068
2145
|
# the source queue before being moved to the dead-letter queue. When
|
2069
2146
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
2070
2147
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -2075,22 +2152,22 @@ module Aws::SQS
|
|
2075
2152
|
#
|
2076
2153
|
# </note>
|
2077
2154
|
#
|
2078
|
-
# * `VisibilityTimeout`
|
2079
|
-
# seconds. Valid values:
|
2155
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2156
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2080
2157
|
# Default: 30. For more information about the visibility timeout, see
|
2081
2158
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2082
2159
|
# Developer Guide*.
|
2083
2160
|
#
|
2084
2161
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2085
2162
|
#
|
2086
|
-
# * `KmsMasterKeyId`
|
2163
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2087
2164
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
2088
2165
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
2089
2166
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
2090
2167
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
2091
2168
|
# Key Management Service API Reference*.
|
2092
2169
|
#
|
2093
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2170
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2094
2171
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2095
2172
|
# messages before calling AWS KMS again. An integer representing
|
2096
2173
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -2102,7 +2179,7 @@ module Aws::SQS
|
|
2102
2179
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2103
2180
|
# queues][9]\:
|
2104
2181
|
#
|
2105
|
-
# * `ContentBasedDeduplication`
|
2182
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2106
2183
|
# For more information, see [Exactly-Once Processing][10] in the
|
2107
2184
|
# *Amazon Simple Queue Service Developer Guide*.
|
2108
2185
|
#
|
@@ -2276,7 +2353,7 @@ module Aws::SQS
|
|
2276
2353
|
params: params,
|
2277
2354
|
config: config)
|
2278
2355
|
context[:gem_name] = 'aws-sdk-sqs'
|
2279
|
-
context[:gem_version] = '1.
|
2356
|
+
context[:gem_version] = '1.32.0'
|
2280
2357
|
Seahorse::Client::Request.new(handlers, context)
|
2281
2358
|
end
|
2282
2359
|
|