aws-sdk-sqs 1.27.1 → 1.38.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/CHANGELOG.md +283 -0
- data/LICENSE.txt +202 -0
- data/VERSION +1 -0
- data/lib/aws-sdk-sqs.rb +6 -3
- data/lib/aws-sdk-sqs/client.rb +361 -146
- data/lib/aws-sdk-sqs/client_api.rb +23 -1
- data/lib/aws-sdk-sqs/customizations.rb +2 -0
- data/lib/aws-sdk-sqs/errors.rb +3 -1
- data/lib/aws-sdk-sqs/message.rb +5 -3
- 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 +109 -47
- data/lib/aws-sdk-sqs/queue_poller.rb +3 -1
- data/lib/aws-sdk-sqs/resource.rb +85 -35
- data/lib/aws-sdk-sqs/types.rb +371 -120
- metadata +10 -7
data/VERSION
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
1.38.0
|
data/lib/aws-sdk-sqs.rb
CHANGED
@@ -1,10 +1,13 @@
|
|
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:
|
4
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
10
|
+
|
8
11
|
require 'aws-sdk-core'
|
9
12
|
require 'aws-sigv4'
|
10
13
|
|
@@ -44,9 +47,9 @@ require_relative 'aws-sdk-sqs/customizations'
|
|
44
47
|
#
|
45
48
|
# See {Errors} for more information.
|
46
49
|
#
|
47
|
-
#
|
50
|
+
# @!group service
|
48
51
|
module Aws::SQS
|
49
52
|
|
50
|
-
GEM_VERSION = '1.
|
53
|
+
GEM_VERSION = '1.38.0'
|
51
54
|
|
52
55
|
end
|
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -1,7 +1,9 @@
|
|
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:
|
4
|
-
# https://github.com/aws/aws-sdk-ruby/blob/
|
6
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
7
|
#
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
@@ -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,13 +363,13 @@ 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
|
-
# information, see [Grant
|
355
|
-
#
|
371
|
+
# information, see [Grant cross-account permissions to a role and a user
|
372
|
+
# name][4] in the *Amazon Simple Queue Service Developer Guide*.
|
356
373
|
#
|
357
374
|
# </note>
|
358
375
|
#
|
@@ -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,13 +648,13 @@ 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
|
-
# information, see [Grant
|
635
|
-
#
|
656
|
+
# information, see [Grant cross-account permissions to a role and a user
|
657
|
+
# name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
636
658
|
#
|
637
659
|
# </note>
|
638
660
|
#
|
@@ -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,22 +752,22 @@ module Aws::SQS
|
|
730
752
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
731
753
|
# queues][9]\:
|
732
754
|
#
|
733
|
-
# * `FifoQueue`
|
734
|
-
# `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
735
|
-
# creates a standard queue. You can provide this attribute only
|
736
|
-
# queue creation. You can't change it for an existing queue.
|
737
|
-
# set this attribute, you must also provide the
|
738
|
-
# your messages explicitly.
|
755
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
756
|
+
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
757
|
+
# SQS creates a standard queue. You can provide this attribute only
|
758
|
+
# during queue creation. You can't change it for an existing queue.
|
759
|
+
# When you set this attribute, you must also provide the
|
760
|
+
# `MessageGroupId` for your messages explicitly.
|
739
761
|
#
|
740
762
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
741
763
|
# Simple Queue Service Developer Guide*.
|
742
764
|
#
|
743
|
-
# * `ContentBasedDeduplication`
|
744
|
-
# Valid values
|
765
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
766
|
+
# Valid values are `true` and `false`. For more information, see
|
745
767
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
746
|
-
# Developer Guide*.
|
768
|
+
# Developer Guide*. Note the following:
|
747
769
|
#
|
748
|
-
# * Every message must have a unique `MessageDeduplicationId
|
770
|
+
# * Every message must have a unique `MessageDeduplicationId`.
|
749
771
|
#
|
750
772
|
# * You may provide a `MessageDeduplicationId` explicitly.
|
751
773
|
#
|
@@ -773,6 +795,50 @@ module Aws::SQS
|
|
773
795
|
# `MessageDeduplicationId`, the two messages are treated as
|
774
796
|
# duplicates and only one copy of the message is delivered.
|
775
797
|
#
|
798
|
+
# **Preview: High throughput for FIFO queues**
|
799
|
+
#
|
800
|
+
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
801
|
+
# is subject to change.** This feature provides a high number of
|
802
|
+
# transactions per second (TPS) for messages in FIFO queues. For
|
803
|
+
# information on throughput quotas, see [Quotas related to messages][12]
|
804
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
805
|
+
#
|
806
|
+
# This preview includes two new attributes:
|
807
|
+
#
|
808
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
809
|
+
# occurs at the message group or queue level. Valid values are
|
810
|
+
# `messageGroup` and `queue`.
|
811
|
+
#
|
812
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue throughput
|
813
|
+
# quota applies to the entire queue or per message group. Valid values
|
814
|
+
# are `perQueue` and `perMessageGroupId`. The `perMessageGroupId`
|
815
|
+
# value is allowed only when the value for `DeduplicationScope` is
|
816
|
+
# `messageGroup`.
|
817
|
+
#
|
818
|
+
# To enable high throughput for FIFO queues, do the following:
|
819
|
+
#
|
820
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
821
|
+
#
|
822
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
823
|
+
#
|
824
|
+
# If you set these attributes to anything other than the values shown
|
825
|
+
# for enabling high throughput, standard throughput is in effect and
|
826
|
+
# deduplication occurs as specified.
|
827
|
+
#
|
828
|
+
# This preview is available in the following AWS Regions:
|
829
|
+
#
|
830
|
+
# * US East (Ohio); us-east-2
|
831
|
+
#
|
832
|
+
# * US East (N. Virginia); us-east-1
|
833
|
+
#
|
834
|
+
# * US West (Oregon); us-west-2
|
835
|
+
#
|
836
|
+
# * Europe (Ireland); eu-west-1
|
837
|
+
#
|
838
|
+
# For more information about high throughput for FIFO queues, see
|
839
|
+
# [Preview: High throughput for FIFO queues][13] in the *Amazon Simple
|
840
|
+
# Queue Service Developer Guide*.
|
841
|
+
#
|
776
842
|
#
|
777
843
|
#
|
778
844
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -786,6 +852,8 @@ module Aws::SQS
|
|
786
852
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
787
853
|
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
788
854
|
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
855
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
856
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
789
857
|
#
|
790
858
|
# @option params [Hash<String,String>] :tags
|
791
859
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
@@ -811,8 +879,8 @@ module Aws::SQS
|
|
811
879
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
812
880
|
#
|
813
881
|
# Cross-account permissions don't apply to this action. For more
|
814
|
-
# information, see [Grant
|
815
|
-
#
|
882
|
+
# information, see [Grant cross-account permissions to a role and a user
|
883
|
+
# name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
816
884
|
#
|
817
885
|
# </note>
|
818
886
|
#
|
@@ -914,9 +982,9 @@ module Aws::SQS
|
|
914
982
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
915
983
|
# For example, a parameter list with two elements looks like this:
|
916
984
|
#
|
917
|
-
# `&
|
985
|
+
# `&AttributeName.1=first`
|
918
986
|
#
|
919
|
-
# `&
|
987
|
+
# `&AttributeName.2=second`
|
920
988
|
#
|
921
989
|
# @option params [required, String] :queue_url
|
922
990
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
@@ -963,8 +1031,7 @@ module Aws::SQS
|
|
963
1031
|
end
|
964
1032
|
|
965
1033
|
# Deletes the queue specified by the `QueueUrl`, regardless of the
|
966
|
-
# queue's contents.
|
967
|
-
# returns a successful response.
|
1034
|
+
# queue's contents.
|
968
1035
|
#
|
969
1036
|
# Be careful with the `DeleteQueue` action: When you delete a queue, any
|
970
1037
|
# messages in the queue are no longer available.
|
@@ -978,8 +1045,8 @@ module Aws::SQS
|
|
978
1045
|
# creating a queue with the same name.
|
979
1046
|
#
|
980
1047
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
981
|
-
# information, see [Grant
|
982
|
-
#
|
1048
|
+
# information, see [Grant cross-account permissions to a role and a user
|
1049
|
+
# name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
983
1050
|
#
|
984
1051
|
# </note>
|
985
1052
|
#
|
@@ -1016,14 +1083,6 @@ module Aws::SQS
|
|
1016
1083
|
#
|
1017
1084
|
# </note>
|
1018
1085
|
#
|
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
1086
|
#
|
1028
1087
|
#
|
1029
1088
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
@@ -1045,70 +1104,77 @@ module Aws::SQS
|
|
1045
1104
|
#
|
1046
1105
|
# The following attributes are supported:
|
1047
1106
|
#
|
1048
|
-
#
|
1107
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
1108
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
1109
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
1110
|
+
# consistency until at least 1 minute after the producers stop sending
|
1111
|
+
# messages. This period is required for the queue metadata to reach
|
1112
|
+
# eventual consistency.
|
1113
|
+
#
|
1114
|
+
# * `All` – Returns all values.
|
1049
1115
|
#
|
1050
|
-
# * `ApproximateNumberOfMessages`
|
1116
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
1051
1117
|
# messages available for retrieval from the queue.
|
1052
1118
|
#
|
1053
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
1119
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
1054
1120
|
# number of messages in the queue that are delayed and not available
|
1055
1121
|
# for reading immediately. This can happen when the queue is
|
1056
1122
|
# configured as a delay queue or when a message has been sent with a
|
1057
1123
|
# delay parameter.
|
1058
1124
|
#
|
1059
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
1125
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
1060
1126
|
# number of messages that are in flight. Messages are considered to be
|
1061
1127
|
# *in flight* if they have been sent to a client but have not yet been
|
1062
1128
|
# deleted or have not yet reached the end of their visibility window.
|
1063
1129
|
#
|
1064
|
-
# * `CreatedTimestamp`
|
1130
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created in
|
1065
1131
|
# seconds ([epoch time][1]).
|
1066
1132
|
#
|
1067
|
-
# * `DelaySeconds`
|
1133
|
+
# * `DelaySeconds` – Returns the default delay on the queue in seconds.
|
1068
1134
|
#
|
1069
|
-
# * `LastModifiedTimestamp`
|
1135
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
1070
1136
|
# changed in seconds ([epoch time][1]).
|
1071
1137
|
#
|
1072
|
-
# * `MaximumMessageSize`
|
1138
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a message
|
1073
1139
|
# can contain before Amazon SQS rejects it.
|
1074
1140
|
#
|
1075
|
-
# * `MessageRetentionPeriod`
|
1141
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
1076
1142
|
# for which Amazon SQS retains a message.
|
1077
1143
|
#
|
1078
|
-
# * `Policy`
|
1144
|
+
# * `Policy` – Returns the policy of the queue.
|
1079
1145
|
#
|
1080
|
-
# * `QueueArn`
|
1146
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
1081
1147
|
#
|
1082
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
1148
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
1083
1149
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
1084
1150
|
# to arrive.
|
1085
1151
|
#
|
1086
|
-
# * `RedrivePolicy`
|
1087
|
-
#
|
1088
|
-
# information about the redrive policy and
|
1089
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
1090
|
-
# Service Developer Guide*.
|
1152
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
1153
|
+
# dead-letter queue functionality of the source queue as a JSON
|
1154
|
+
# object. For more information about the redrive policy and
|
1155
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1156
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
1091
1157
|
#
|
1092
|
-
# * `deadLetterTargetArn`
|
1158
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1093
1159
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1094
1160
|
# value of `maxReceiveCount` is exceeded.
|
1095
1161
|
#
|
1096
|
-
# * `maxReceiveCount`
|
1162
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
1097
1163
|
# the source queue before being moved to the dead-letter queue. When
|
1098
1164
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
1099
1165
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
1100
1166
|
#
|
1101
|
-
# * `VisibilityTimeout`
|
1167
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1102
1168
|
# For more information about the visibility timeout, see [Visibility
|
1103
1169
|
# Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
|
1104
1170
|
#
|
1105
1171
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1106
1172
|
#
|
1107
|
-
# * `KmsMasterKeyId`
|
1173
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer master
|
1108
1174
|
# key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1109
1175
|
# [Key Terms][5].
|
1110
1176
|
#
|
1111
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
1177
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1112
1178
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1113
1179
|
# decrypt messages before calling AWS KMS again. For more information,
|
1114
1180
|
# see [How Does the Data Key Reuse Period Work?][6].
|
@@ -1116,20 +1182,64 @@ module Aws::SQS
|
|
1116
1182
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1117
1183
|
# queues][7]\:
|
1118
1184
|
#
|
1119
|
-
# * `FifoQueue`
|
1120
|
-
# information, see [FIFO Queue Logic][8] in the *Amazon
|
1121
|
-
# Service Developer Guide*.
|
1185
|
+
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1186
|
+
# For more information, see [FIFO Queue Logic][8] in the *Amazon
|
1187
|
+
# Simple Queue Service Developer Guide*.
|
1122
1188
|
#
|
1123
1189
|
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
1124
1190
|
# `QueueName` ends with the `.fifo` suffix.
|
1125
1191
|
#
|
1126
1192
|
# </note>
|
1127
1193
|
#
|
1128
|
-
# * `ContentBasedDeduplication`
|
1194
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
1129
1195
|
# deduplication is enabled for the queue. For more information, see
|
1130
1196
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
1131
1197
|
# Developer Guide*.
|
1132
1198
|
#
|
1199
|
+
# **Preview: High throughput for FIFO queues**
|
1200
|
+
#
|
1201
|
+
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
1202
|
+
# is subject to change.** This feature provides a high number of
|
1203
|
+
# transactions per second (TPS) for messages in FIFO queues. For
|
1204
|
+
# information on throughput quotas, see [Quotas related to messages][10]
|
1205
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
1206
|
+
#
|
1207
|
+
# This preview includes two new attributes:
|
1208
|
+
#
|
1209
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
1210
|
+
# occurs at the message group or queue level. Valid values are
|
1211
|
+
# `messageGroup` and `queue`.
|
1212
|
+
#
|
1213
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue throughput
|
1214
|
+
# quota applies to the entire queue or per message group. Valid values
|
1215
|
+
# are `perQueue` and `perMessageGroupId`. The `perMessageGroupId`
|
1216
|
+
# value is allowed only when the value for `DeduplicationScope` is
|
1217
|
+
# `messageGroup`.
|
1218
|
+
#
|
1219
|
+
# To enable high throughput for FIFO queues, do the following:
|
1220
|
+
#
|
1221
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
1222
|
+
#
|
1223
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
1224
|
+
#
|
1225
|
+
# If you set these attributes to anything other than the values shown
|
1226
|
+
# for enabling high throughput, standard throughput is in effect and
|
1227
|
+
# deduplication occurs as specified.
|
1228
|
+
#
|
1229
|
+
# This preview is available in the following AWS Regions:
|
1230
|
+
#
|
1231
|
+
# * US East (Ohio); us-east-2
|
1232
|
+
#
|
1233
|
+
# * US East (N. Virginia); us-east-1
|
1234
|
+
#
|
1235
|
+
# * US West (Oregon); us-west-2
|
1236
|
+
#
|
1237
|
+
# * Europe (Ireland); eu-west-1
|
1238
|
+
#
|
1239
|
+
# For more information about high throughput for FIFO queues, see
|
1240
|
+
# [Preview: High throughput for FIFO queues][11] in the *Amazon Simple
|
1241
|
+
# Queue Service Developer Guide*.
|
1242
|
+
#
|
1133
1243
|
#
|
1134
1244
|
#
|
1135
1245
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
@@ -1141,6 +1251,8 @@ module Aws::SQS
|
|
1141
1251
|
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
1142
1252
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
1143
1253
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
1254
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
1255
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
1144
1256
|
#
|
1145
1257
|
# @return [Types::GetQueueAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1146
1258
|
#
|
@@ -1150,7 +1262,7 @@ module Aws::SQS
|
|
1150
1262
|
#
|
1151
1263
|
# resp = client.get_queue_attributes({
|
1152
1264
|
# queue_url: "String", # required
|
1153
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
1265
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
1154
1266
|
# })
|
1155
1267
|
#
|
1156
1268
|
# @example Response structure
|
@@ -1217,6 +1329,15 @@ module Aws::SQS
|
|
1217
1329
|
# Returns a list of your queues that have the `RedrivePolicy` queue
|
1218
1330
|
# attribute configured with a dead-letter queue.
|
1219
1331
|
#
|
1332
|
+
# The `ListDeadLetterSourceQueues` methods supports pagination. Set
|
1333
|
+
# parameter `MaxResults` in the request to specify the maximum number of
|
1334
|
+
# results to be returned in the response. If you do not set
|
1335
|
+
# `MaxResults`, the response includes a maximum of 1,000 results. If you
|
1336
|
+
# set `MaxResults` and there are additional results to display, the
|
1337
|
+
# response includes a value for `NextToken`. Use `NextToken` as a
|
1338
|
+
# parameter in your next request to `ListDeadLetterSourceQueues` to
|
1339
|
+
# receive the next page of results.
|
1340
|
+
#
|
1220
1341
|
# For more information about using dead-letter queues, see [Using Amazon
|
1221
1342
|
# SQS Dead-Letter Queues][1] in the *Amazon Simple Queue Service
|
1222
1343
|
# Developer Guide*.
|
@@ -1230,20 +1351,34 @@ module Aws::SQS
|
|
1230
1351
|
#
|
1231
1352
|
# Queue URLs and names are case-sensitive.
|
1232
1353
|
#
|
1354
|
+
# @option params [String] :next_token
|
1355
|
+
# Pagination token to request the next set of results.
|
1356
|
+
#
|
1357
|
+
# @option params [Integer] :max_results
|
1358
|
+
# Maximum number of results to include in the response. Value range is 1
|
1359
|
+
# to 1000. You must set `MaxResults` to receive a value for `NextToken`
|
1360
|
+
# in the response.
|
1361
|
+
#
|
1233
1362
|
# @return [Types::ListDeadLetterSourceQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1234
1363
|
#
|
1235
1364
|
# * {Types::ListDeadLetterSourceQueuesResult#queue_urls #queue_urls} => Array<String>
|
1365
|
+
# * {Types::ListDeadLetterSourceQueuesResult#next_token #next_token} => String
|
1366
|
+
#
|
1367
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1236
1368
|
#
|
1237
1369
|
# @example Request syntax with placeholder values
|
1238
1370
|
#
|
1239
1371
|
# resp = client.list_dead_letter_source_queues({
|
1240
1372
|
# queue_url: "String", # required
|
1373
|
+
# next_token: "Token",
|
1374
|
+
# max_results: 1,
|
1241
1375
|
# })
|
1242
1376
|
#
|
1243
1377
|
# @example Response structure
|
1244
1378
|
#
|
1245
1379
|
# resp.queue_urls #=> Array
|
1246
1380
|
# resp.queue_urls[0] #=> String
|
1381
|
+
# resp.next_token #=> String
|
1247
1382
|
#
|
1248
1383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueues AWS API Documentation
|
1249
1384
|
#
|
@@ -1259,8 +1394,8 @@ module Aws::SQS
|
|
1259
1394
|
# *Amazon Simple Queue Service Developer Guide*.
|
1260
1395
|
#
|
1261
1396
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1262
|
-
# information, see [Grant
|
1263
|
-
#
|
1397
|
+
# information, see [Grant cross-account permissions to a role and a user
|
1398
|
+
# name][2] in the *Amazon Simple Queue Service Developer Guide*.
|
1264
1399
|
#
|
1265
1400
|
# </note>
|
1266
1401
|
#
|
@@ -1296,14 +1431,22 @@ module Aws::SQS
|
|
1296
1431
|
req.send_request(options)
|
1297
1432
|
end
|
1298
1433
|
|
1299
|
-
# Returns a list of your queues
|
1300
|
-
#
|
1301
|
-
# `QueueNamePrefix` parameter, only queues with a name that
|
1302
|
-
# the specified value are returned.
|
1434
|
+
# Returns a list of your queues in the current region. The response
|
1435
|
+
# includes a maximum of 1,000 results. If you specify a value for the
|
1436
|
+
# optional `QueueNamePrefix` parameter, only queues with a name that
|
1437
|
+
# begins with the specified value are returned.
|
1438
|
+
#
|
1439
|
+
# The `listQueues` methods supports pagination. Set parameter
|
1440
|
+
# `MaxResults` in the request to specify the maximum number of results
|
1441
|
+
# to be returned in the response. If you do not set `MaxResults`, the
|
1442
|
+
# response includes a maximum of 1,000 results. If you set `MaxResults`
|
1443
|
+
# and there are additional results to display, the response includes a
|
1444
|
+
# value for `NextToken`. Use `NextToken` as a parameter in your next
|
1445
|
+
# request to `listQueues` to receive the next page of results.
|
1303
1446
|
#
|
1304
1447
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1305
|
-
# information, see [Grant
|
1306
|
-
#
|
1448
|
+
# information, see [Grant cross-account permissions to a role and a user
|
1449
|
+
# name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
1307
1450
|
#
|
1308
1451
|
# </note>
|
1309
1452
|
#
|
@@ -1317,20 +1460,34 @@ module Aws::SQS
|
|
1317
1460
|
#
|
1318
1461
|
# Queue URLs and names are case-sensitive.
|
1319
1462
|
#
|
1463
|
+
# @option params [String] :next_token
|
1464
|
+
# Pagination token to request the next set of results.
|
1465
|
+
#
|
1466
|
+
# @option params [Integer] :max_results
|
1467
|
+
# Maximum number of results to include in the response. Value range is 1
|
1468
|
+
# to 1000. You must set `MaxResults` to receive a value for `NextToken`
|
1469
|
+
# in the response.
|
1470
|
+
#
|
1320
1471
|
# @return [Types::ListQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1321
1472
|
#
|
1322
1473
|
# * {Types::ListQueuesResult#queue_urls #queue_urls} => Array<String>
|
1474
|
+
# * {Types::ListQueuesResult#next_token #next_token} => String
|
1475
|
+
#
|
1476
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1323
1477
|
#
|
1324
1478
|
# @example Request syntax with placeholder values
|
1325
1479
|
#
|
1326
1480
|
# resp = client.list_queues({
|
1327
1481
|
# queue_name_prefix: "String",
|
1482
|
+
# next_token: "Token",
|
1483
|
+
# max_results: 1,
|
1328
1484
|
# })
|
1329
1485
|
#
|
1330
1486
|
# @example Response structure
|
1331
1487
|
#
|
1332
1488
|
# resp.queue_urls #=> Array
|
1333
1489
|
# resp.queue_urls[0] #=> String
|
1490
|
+
# resp.next_token #=> String
|
1334
1491
|
#
|
1335
1492
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueues AWS API Documentation
|
1336
1493
|
#
|
@@ -1445,15 +1602,15 @@ module Aws::SQS
|
|
1445
1602
|
# A list of attributes that need to be returned along with each message.
|
1446
1603
|
# These attributes include:
|
1447
1604
|
#
|
1448
|
-
# * `All`
|
1605
|
+
# * `All` – Returns all values.
|
1449
1606
|
#
|
1450
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1607
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1451
1608
|
# was first received from the queue ([epoch time][1] in milliseconds).
|
1452
1609
|
#
|
1453
|
-
# * `ApproximateReceiveCount`
|
1454
|
-
# has been received
|
1610
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1611
|
+
# has been received across all queues but not deleted.
|
1455
1612
|
#
|
1456
|
-
# * `AWSTraceHeader`
|
1613
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1457
1614
|
#
|
1458
1615
|
# * `SenderId`
|
1459
1616
|
#
|
@@ -1463,17 +1620,17 @@ module Aws::SQS
|
|
1463
1620
|
# * For an IAM role, returns the IAM role ID, for example
|
1464
1621
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1465
1622
|
#
|
1466
|
-
# * `SentTimestamp`
|
1623
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1467
1624
|
# ([epoch time][1] in milliseconds).
|
1468
1625
|
#
|
1469
|
-
# * `MessageDeduplicationId`
|
1626
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1470
1627
|
# producer that calls the ` SendMessage ` action.
|
1471
1628
|
#
|
1472
|
-
# * `MessageGroupId`
|
1629
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1473
1630
|
# calls the ` SendMessage ` action. Messages with the same
|
1474
1631
|
# `MessageGroupId` are returned in sequence.
|
1475
1632
|
#
|
1476
|
-
# * `SequenceNumber`
|
1633
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1477
1634
|
#
|
1478
1635
|
#
|
1479
1636
|
#
|
@@ -1518,14 +1675,25 @@ module Aws::SQS
|
|
1518
1675
|
# available and the wait time expires, the call returns successfully
|
1519
1676
|
# with an empty list of messages.
|
1520
1677
|
#
|
1678
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1679
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1680
|
+
# parameter. For example, with the Java SDK, you can set HTTP transport
|
1681
|
+
# settings using the [ NettyNioAsyncHttpClient][1] for asynchronous
|
1682
|
+
# clients, or the [ ApacheHttpClient][2] for synchronous clients.
|
1683
|
+
#
|
1684
|
+
#
|
1685
|
+
#
|
1686
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1687
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1688
|
+
#
|
1521
1689
|
# @option params [String] :receive_request_attempt_id
|
1522
1690
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1523
1691
|
#
|
1524
1692
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1525
1693
|
# 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
|
1694
|
+
# of a response you receive a generic error, it is possible to retry the
|
1695
|
+
# same action with an identical `ReceiveRequestAttemptId` to retrieve
|
1696
|
+
# the same set of messages, even if their visibility timeout has not yet
|
1529
1697
|
# expired.
|
1530
1698
|
#
|
1531
1699
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
@@ -1538,7 +1706,7 @@ module Aws::SQS
|
|
1538
1706
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1539
1707
|
# `ReceiveRequestAttemptId`.
|
1540
1708
|
#
|
1541
|
-
# *
|
1709
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1542
1710
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
1543
1711
|
# (deleted or had their visibility changes).
|
1544
1712
|
#
|
@@ -1569,7 +1737,7 @@ module Aws::SQS
|
|
1569
1737
|
# visibility timeout expires. As a result, delays might occur but the
|
1570
1738
|
# messages in the queue remain in a strict order.
|
1571
1739
|
#
|
1572
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1740
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1573
1741
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
|
1574
1742
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1575
1743
|
# ``).
|
@@ -1591,7 +1759,7 @@ module Aws::SQS
|
|
1591
1759
|
#
|
1592
1760
|
# resp = client.receive_message({
|
1593
1761
|
# queue_url: "String", # required
|
1594
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds
|
1762
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
|
1595
1763
|
# message_attribute_names: ["MessageAttributeName"],
|
1596
1764
|
# max_number_of_messages: 1,
|
1597
1765
|
# visibility_timeout: 1,
|
@@ -1633,8 +1801,8 @@ module Aws::SQS
|
|
1633
1801
|
# <note markdown="1"> * Only the owner of a queue can remove permissions from it.
|
1634
1802
|
#
|
1635
1803
|
# * Cross-account permissions don't apply to this action. For more
|
1636
|
-
# information, see [Grant
|
1637
|
-
#
|
1804
|
+
# information, see [Grant cross-account permissions to a role and a
|
1805
|
+
# user name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
1638
1806
|
#
|
1639
1807
|
# * To remove the ability to change queue permissions, you must deny
|
1640
1808
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1694,7 +1862,8 @@ module Aws::SQS
|
|
1694
1862
|
# Queue URLs and names are case-sensitive.
|
1695
1863
|
#
|
1696
1864
|
# @option params [required, String] :message_body
|
1697
|
-
# The message to send. The
|
1865
|
+
# The message to send. The minimum size is one character. The maximum
|
1866
|
+
# size is 256 KB.
|
1698
1867
|
#
|
1699
1868
|
# A message can include only XML, JSON, and unformatted text. The
|
1700
1869
|
# following Unicode characters are allowed:
|
@@ -1728,7 +1897,7 @@ module Aws::SQS
|
|
1728
1897
|
#
|
1729
1898
|
#
|
1730
1899
|
#
|
1731
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-
|
1900
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1732
1901
|
#
|
1733
1902
|
# @option params [Hash<String,Types::MessageSystemAttributeValue>] :message_system_attributes
|
1734
1903
|
# The message system attribute to send. Each message system attribute
|
@@ -1736,7 +1905,7 @@ module Aws::SQS
|
|
1736
1905
|
#
|
1737
1906
|
# * Currently, the only supported message system attribute is
|
1738
1907
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1739
|
-
# correctly formatted AWS X-Ray trace string.
|
1908
|
+
# correctly formatted AWS X-Ray trace header string.
|
1740
1909
|
#
|
1741
1910
|
# * The size of a message system attribute doesn't count towards the
|
1742
1911
|
# total size of a message.
|
@@ -1789,7 +1958,7 @@ module Aws::SQS
|
|
1789
1958
|
#
|
1790
1959
|
# </note>
|
1791
1960
|
#
|
1792
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
1961
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1793
1962
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1794
1963
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1795
1964
|
# ``).
|
@@ -1919,9 +2088,9 @@ module Aws::SQS
|
|
1919
2088
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1920
2089
|
# For example, a parameter list with two elements looks like this:
|
1921
2090
|
#
|
1922
|
-
# `&
|
2091
|
+
# `&AttributeName.1=first`
|
1923
2092
|
#
|
1924
|
-
# `&
|
2093
|
+
# `&AttributeName.2=second`
|
1925
2094
|
#
|
1926
2095
|
#
|
1927
2096
|
#
|
@@ -2008,8 +2177,8 @@ module Aws::SQS
|
|
2008
2177
|
# it can handle new attributes gracefully.
|
2009
2178
|
#
|
2010
2179
|
# * Cross-account permissions don't apply to this action. For more
|
2011
|
-
# information, see [Grant
|
2012
|
-
#
|
2180
|
+
# information, see [Grant cross-account permissions to a role and a
|
2181
|
+
# user name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
2013
2182
|
#
|
2014
2183
|
# * To remove the ability to change queue permissions, you must deny
|
2015
2184
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2032,39 +2201,39 @@ module Aws::SQS
|
|
2032
2201
|
# The following lists the names, descriptions, and values of the special
|
2033
2202
|
# request parameters that the `SetQueueAttributes` action uses:
|
2034
2203
|
#
|
2035
|
-
# * `DelaySeconds`
|
2204
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
2036
2205
|
# delivery of all messages in the queue is delayed. Valid values: An
|
2037
2206
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
2038
2207
|
#
|
2039
|
-
# * `MaximumMessageSize`
|
2208
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
2040
2209
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
2041
2210
|
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
|
2042
2211
|
# (256 KiB).
|
2043
2212
|
#
|
2044
|
-
# * `MessageRetentionPeriod`
|
2213
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
2045
2214
|
# Amazon SQS retains a message. Valid values: An integer representing
|
2046
2215
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2047
2216
|
# (4 days).
|
2048
2217
|
#
|
2049
|
-
# * `Policy`
|
2218
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
2050
2219
|
# information about policy structure, see [Overview of AWS IAM
|
2051
2220
|
# Policies][1] in the *Amazon IAM User Guide*.
|
2052
2221
|
#
|
2053
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2222
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2054
2223
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
2055
|
-
# Valid values:
|
2224
|
+
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
2056
2225
|
#
|
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*.
|
2226
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2227
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2228
|
+
# object. For more information about the redrive policy and
|
2229
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2230
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
2062
2231
|
#
|
2063
|
-
# * `deadLetterTargetArn`
|
2232
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2064
2233
|
# dead-letter queue to which Amazon SQS moves messages after the
|
2065
2234
|
# value of `maxReceiveCount` is exceeded.
|
2066
2235
|
#
|
2067
|
-
# * `maxReceiveCount`
|
2236
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
2068
2237
|
# the source queue before being moved to the dead-letter queue. When
|
2069
2238
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
2070
2239
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -2075,22 +2244,22 @@ module Aws::SQS
|
|
2075
2244
|
#
|
2076
2245
|
# </note>
|
2077
2246
|
#
|
2078
|
-
# * `VisibilityTimeout`
|
2079
|
-
# seconds. Valid values:
|
2247
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2248
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2080
2249
|
# Default: 30. For more information about the visibility timeout, see
|
2081
2250
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
2082
2251
|
# Developer Guide*.
|
2083
2252
|
#
|
2084
2253
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2085
2254
|
#
|
2086
|
-
# * `KmsMasterKeyId`
|
2255
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
2087
2256
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
2088
2257
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
2089
2258
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
2090
2259
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
2091
2260
|
# Key Management Service API Reference*.
|
2092
2261
|
#
|
2093
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2262
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2094
2263
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2095
2264
|
# messages before calling AWS KMS again. An integer representing
|
2096
2265
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -2102,11 +2271,11 @@ module Aws::SQS
|
|
2102
2271
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2103
2272
|
# queues][9]\:
|
2104
2273
|
#
|
2105
|
-
# * `ContentBasedDeduplication`
|
2274
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2106
2275
|
# For more information, see [Exactly-Once Processing][10] in the
|
2107
|
-
# *Amazon Simple Queue Service Developer Guide*.
|
2276
|
+
# *Amazon Simple Queue Service Developer Guide*. Note the following:
|
2108
2277
|
#
|
2109
|
-
# * Every message must have a unique `MessageDeduplicationId
|
2278
|
+
# * Every message must have a unique `MessageDeduplicationId`.
|
2110
2279
|
#
|
2111
2280
|
# * You may provide a `MessageDeduplicationId` explicitly.
|
2112
2281
|
#
|
@@ -2134,6 +2303,50 @@ module Aws::SQS
|
|
2134
2303
|
# `MessageDeduplicationId`, the two messages are treated as
|
2135
2304
|
# duplicates and only one copy of the message is delivered.
|
2136
2305
|
#
|
2306
|
+
# **Preview: High throughput for FIFO queues**
|
2307
|
+
#
|
2308
|
+
# **High throughput for Amazon SQS FIFO queues is in preview release and
|
2309
|
+
# is subject to change.** This feature provides a high number of
|
2310
|
+
# transactions per second (TPS) for messages in FIFO queues. For
|
2311
|
+
# information on throughput quotas, see [Quotas related to messages][11]
|
2312
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
2313
|
+
#
|
2314
|
+
# This preview includes two new attributes:
|
2315
|
+
#
|
2316
|
+
# * `DeduplicationScope` – Specifies whether message deduplication
|
2317
|
+
# occurs at the message group or queue level. Valid values are
|
2318
|
+
# `messageGroup` and `queue`.
|
2319
|
+
#
|
2320
|
+
# * `FifoThroughputLimit` – Specifies whether the FIFO queue throughput
|
2321
|
+
# quota applies to the entire queue or per message group. Valid values
|
2322
|
+
# are `perQueue` and `perMessageGroupId`. The `perMessageGroupId`
|
2323
|
+
# value is allowed only when the value for `DeduplicationScope` is
|
2324
|
+
# `messageGroup`.
|
2325
|
+
#
|
2326
|
+
# To enable high throughput for FIFO queues, do the following:
|
2327
|
+
#
|
2328
|
+
# * Set `DeduplicationScope` to `messageGroup`.
|
2329
|
+
#
|
2330
|
+
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
2331
|
+
#
|
2332
|
+
# If you set these attributes to anything other than the values shown
|
2333
|
+
# for enabling high throughput, standard throughput is in effect and
|
2334
|
+
# deduplication occurs as specified.
|
2335
|
+
#
|
2336
|
+
# This preview is available in the following AWS Regions:
|
2337
|
+
#
|
2338
|
+
# * US East (Ohio); us-east-2
|
2339
|
+
#
|
2340
|
+
# * US East (N. Virginia); us-east-1
|
2341
|
+
#
|
2342
|
+
# * US West (Oregon); us-west-2
|
2343
|
+
#
|
2344
|
+
# * Europe (Ireland); eu-west-1
|
2345
|
+
#
|
2346
|
+
# For more information about high throughput for FIFO queues, see
|
2347
|
+
# [Preview: High throughput for FIFO queues][12] in the *Amazon Simple
|
2348
|
+
# Queue Service Developer Guide*.
|
2349
|
+
#
|
2137
2350
|
#
|
2138
2351
|
#
|
2139
2352
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -2146,6 +2359,8 @@ module Aws::SQS
|
|
2146
2359
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2147
2360
|
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2148
2361
|
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
2362
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2363
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2149
2364
|
#
|
2150
2365
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2151
2366
|
#
|
@@ -2187,8 +2402,8 @@ module Aws::SQS
|
|
2187
2402
|
# in the *Amazon Simple Queue Service Developer Guide*.
|
2188
2403
|
#
|
2189
2404
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2190
|
-
# information, see [Grant
|
2191
|
-
#
|
2405
|
+
# information, see [Grant cross-account permissions to a role and a user
|
2406
|
+
# name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
2192
2407
|
#
|
2193
2408
|
# </note>
|
2194
2409
|
#
|
@@ -2229,8 +2444,8 @@ module Aws::SQS
|
|
2229
2444
|
# Simple Queue Service Developer Guide*.
|
2230
2445
|
#
|
2231
2446
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2232
|
-
# information, see [Grant
|
2233
|
-
#
|
2447
|
+
# information, see [Grant cross-account permissions to a role and a user
|
2448
|
+
# name][2] in the *Amazon Simple Queue Service Developer Guide*.
|
2234
2449
|
#
|
2235
2450
|
# </note>
|
2236
2451
|
#
|
@@ -2276,7 +2491,7 @@ module Aws::SQS
|
|
2276
2491
|
params: params,
|
2277
2492
|
config: config)
|
2278
2493
|
context[:gem_name] = 'aws-sdk-sqs'
|
2279
|
-
context[:gem_version] = '1.
|
2494
|
+
context[:gem_version] = '1.38.0'
|
2280
2495
|
Seahorse::Client::Request.new(handlers, context)
|
2281
2496
|
end
|
2282
2497
|
|