aws-sdk-sqs 1.38.0 → 1.51.1
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 +71 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +195 -200
- data/lib/aws-sdk-sqs/message.rb +4 -3
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +17 -9
- data/lib/aws-sdk-sqs/queue.rb +61 -69
- data/lib/aws-sdk-sqs/resource.rb +46 -57
- data/lib/aws-sdk-sqs/types.rb +162 -189
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +6 -7
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -27,6 +27,9 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
32
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
34
|
require 'aws-sdk-core/plugins/protocols/query.rb'
|
32
35
|
require 'aws-sdk-sqs/plugins/queue_urls.rb'
|
@@ -75,6 +78,9 @@ module Aws::SQS
|
|
75
78
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
79
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
80
|
add_plugin(Aws::Plugins::HttpChecksum)
|
81
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
78
84
|
add_plugin(Aws::Plugins::SignatureV4)
|
79
85
|
add_plugin(Aws::Plugins::Protocols::Query)
|
80
86
|
add_plugin(Aws::SQS::Plugins::QueueUrls)
|
@@ -123,7 +129,9 @@ module Aws::SQS
|
|
123
129
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
124
130
|
# are very aggressive. Construct and pass an instance of
|
125
131
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
126
|
-
# enable retries and extended timeouts.
|
132
|
+
# enable retries and extended timeouts. Instance profile credential
|
133
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
134
|
+
# to true.
|
127
135
|
#
|
128
136
|
# @option options [required, String] :region
|
129
137
|
# The AWS region to connect to. The configured `:region` is
|
@@ -177,6 +185,10 @@ module Aws::SQS
|
|
177
185
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
178
186
|
# a clock skew correction and retry requests with skewed client clocks.
|
179
187
|
#
|
188
|
+
# @option options [String] :defaults_mode ("legacy")
|
189
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
190
|
+
# accepted modes and the configuration defaults that are included.
|
191
|
+
#
|
180
192
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
181
193
|
# Set to true to disable SDK automatically adding host prefix
|
182
194
|
# to default service endpoint when available.
|
@@ -279,6 +291,15 @@ module Aws::SQS
|
|
279
291
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
280
292
|
# requests are made, and retries are disabled.
|
281
293
|
#
|
294
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
295
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
296
|
+
# will be used if available.
|
297
|
+
#
|
298
|
+
# @option options [Boolean] :use_fips_endpoint
|
299
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
300
|
+
# When a `fips` region is used, the region is normalized and this config
|
301
|
+
# is set to `true`.
|
302
|
+
#
|
282
303
|
# @option options [Boolean] :validate_params (true)
|
283
304
|
# When `true`, request parameters are validated before
|
284
305
|
# sending the request.
|
@@ -296,7 +317,7 @@ module Aws::SQS
|
|
296
317
|
# seconds to wait when opening a HTTP session before raising a
|
297
318
|
# `Timeout::Error`.
|
298
319
|
#
|
299
|
-
# @option options [
|
320
|
+
# @option options [Float] :http_read_timeout (60) The default
|
300
321
|
# number of seconds to wait for response data. This value can
|
301
322
|
# safely be set per-request on the session.
|
302
323
|
#
|
@@ -312,6 +333,9 @@ module Aws::SQS
|
|
312
333
|
# disables this behaviour. This value can safely be set per
|
313
334
|
# request on the session.
|
314
335
|
#
|
336
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
337
|
+
# in seconds.
|
338
|
+
#
|
315
339
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
316
340
|
# HTTP debug output will be sent to the `:logger`.
|
317
341
|
#
|
@@ -343,13 +367,13 @@ module Aws::SQS
|
|
343
367
|
# When you create a queue, you have full control access rights for the
|
344
368
|
# queue. Only you, the owner of the queue, can grant or deny permissions
|
345
369
|
# to the queue. For more information about these permissions, see [Allow
|
346
|
-
# Developers to Write Messages to a Shared Queue][2] in the *Amazon
|
347
|
-
#
|
370
|
+
# Developers to Write Messages to a Shared Queue][2] in the *Amazon SQS
|
371
|
+
# Developer Guide*.
|
348
372
|
#
|
349
373
|
# <note markdown="1"> * `AddPermission` generates a policy for you. You can use `
|
350
374
|
# SetQueueAttributes ` to upload your policy. For more information,
|
351
375
|
# see [Using Custom Policies with the Amazon SQS Access Policy
|
352
|
-
# Language][3] in the *Amazon
|
376
|
+
# Language][3] in the *Amazon SQS Developer Guide*.
|
353
377
|
#
|
354
378
|
# * An Amazon SQS policy can have a maximum of 7 actions.
|
355
379
|
#
|
@@ -369,7 +393,7 @@ module Aws::SQS
|
|
369
393
|
#
|
370
394
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
371
395
|
# information, see [Grant cross-account permissions to a role and a user
|
372
|
-
# name][4] in the *Amazon
|
396
|
+
# name][4] in the *Amazon SQS Developer Guide*.
|
373
397
|
#
|
374
398
|
# </note>
|
375
399
|
#
|
@@ -392,11 +416,10 @@ module Aws::SQS
|
|
392
416
|
# underscores (`_`).
|
393
417
|
#
|
394
418
|
# @option params [required, Array<String>] :aws_account_ids
|
395
|
-
# The
|
396
|
-
#
|
397
|
-
#
|
398
|
-
#
|
399
|
-
# Queue Service Developer Guide*.
|
419
|
+
# The Amazon Web Services account numbers of the [principals][1] who are
|
420
|
+
# to receive permission. For information about locating the Amazon Web
|
421
|
+
# Services account identification, see [Your Amazon Web Services
|
422
|
+
# Identifiers][2] in the *Amazon SQS Developer Guide*.
|
400
423
|
#
|
401
424
|
#
|
402
425
|
#
|
@@ -409,7 +432,7 @@ module Aws::SQS
|
|
409
432
|
#
|
410
433
|
# For more information about these actions, see [Overview of Managing
|
411
434
|
# Access Permissions to Your Amazon Simple Queue Service Resource][1] in
|
412
|
-
# the *Amazon
|
435
|
+
# the *Amazon SQS Developer Guide*.
|
413
436
|
#
|
414
437
|
# Specifying `SendMessage`, `DeleteMessage`, or
|
415
438
|
# `ChangeMessageVisibility` for `ActionName.n` also grants permissions
|
@@ -444,8 +467,8 @@ module Aws::SQS
|
|
444
467
|
# Changes the visibility timeout of a specified message in a queue to a
|
445
468
|
# new value. The default visibility timeout for a message is 30 seconds.
|
446
469
|
# The minimum is 0 seconds. The maximum is 12 hours. For more
|
447
|
-
# information, see [Visibility Timeout][1] in the *Amazon
|
448
|
-
#
|
470
|
+
# information, see [Visibility Timeout][1] in the *Amazon SQS Developer
|
471
|
+
# Guide*.
|
449
472
|
#
|
450
473
|
# For example, you have a message with a visibility timeout of 5
|
451
474
|
# minutes. After 3 minutes, you call `ChangeMessageVisibility` with a
|
@@ -614,7 +637,7 @@ module Aws::SQS
|
|
614
637
|
# either create a new FIFO queue for your application or delete your
|
615
638
|
# existing standard queue and recreate it as a FIFO queue. For more
|
616
639
|
# information, see [Moving From a Standard Queue to a FIFO Queue][1]
|
617
|
-
# in the *Amazon
|
640
|
+
# in the *Amazon SQS Developer Guide*.
|
618
641
|
#
|
619
642
|
# </note>
|
620
643
|
#
|
@@ -654,7 +677,7 @@ module Aws::SQS
|
|
654
677
|
#
|
655
678
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
656
679
|
# information, see [Grant cross-account permissions to a role and a user
|
657
|
-
# name][3] in the *Amazon
|
680
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
658
681
|
#
|
659
682
|
# </note>
|
660
683
|
#
|
@@ -696,9 +719,9 @@ module Aws::SQS
|
|
696
719
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
697
720
|
# (4 days).
|
698
721
|
#
|
699
|
-
# * `Policy` – The queue's policy. A valid
|
700
|
-
# information about policy structure, see [Overview of
|
701
|
-
# Policies][1] in the *Amazon IAM User Guide*.
|
722
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
723
|
+
# For more information about policy structure, see [Overview of Amazon
|
724
|
+
# Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
|
702
725
|
#
|
703
726
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
704
727
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -708,7 +731,7 @@ module Aws::SQS
|
|
708
731
|
# dead-letter queue functionality of the source queue as a JSON
|
709
732
|
# object. For more information about the redrive policy and
|
710
733
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
711
|
-
# the *Amazon
|
734
|
+
# the *Amazon SQS Developer Guide*.
|
712
735
|
#
|
713
736
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
714
737
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -728,29 +751,33 @@ module Aws::SQS
|
|
728
751
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
729
752
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
730
753
|
# Default: 30. For more information about the visibility timeout, see
|
731
|
-
# [Visibility Timeout][3] in the *Amazon
|
732
|
-
# Developer Guide*.
|
754
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
733
755
|
#
|
734
756
|
# The following attributes apply only to [server-side-encryption][4]\:
|
735
757
|
#
|
736
|
-
# * `KmsMasterKeyId` – The ID of an
|
737
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
738
|
-
# Terms][5]. While the alias of the
|
739
|
-
# always `alias/aws/sqs`, the
|
740
|
-
#
|
741
|
-
# Key Management Service API
|
758
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
759
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
760
|
+
# information, see [Key Terms][5]. While the alias of the Amazon Web
|
761
|
+
# Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
|
762
|
+
# alias of a custom CMK can, for example, be `alias/MyAlias `. For
|
763
|
+
# more examples, see [KeyId][6] in the *Key Management Service API
|
764
|
+
# Reference*.
|
742
765
|
#
|
743
766
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
744
767
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
745
|
-
# messages before calling
|
746
|
-
#
|
747
|
-
#
|
748
|
-
#
|
749
|
-
#
|
750
|
-
#
|
768
|
+
# messages before calling KMS again. An integer representing seconds,
|
769
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
770
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
771
|
+
# security but results in more calls to KMS which might incur charges
|
772
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
773
|
+
# Reuse Period Work?][8].
|
774
|
+
#
|
775
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
776
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
777
|
+
# supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
|
751
778
|
#
|
752
779
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
753
|
-
# queues][
|
780
|
+
# queues][11]\:
|
754
781
|
#
|
755
782
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
756
783
|
# and `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
@@ -759,13 +786,13 @@ module Aws::SQS
|
|
759
786
|
# When you set this attribute, you must also provide the
|
760
787
|
# `MessageGroupId` for your messages explicitly.
|
761
788
|
#
|
762
|
-
# For more information, see [FIFO
|
763
|
-
#
|
789
|
+
# For more information, see [FIFO queue logic][12] in the *Amazon SQS
|
790
|
+
# Developer Guide*.
|
764
791
|
#
|
765
792
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
766
793
|
# Valid values are `true` and `false`. For more information, see
|
767
|
-
# [Exactly-
|
768
|
-
#
|
794
|
+
# [Exactly-once processing][13] in the *Amazon SQS Developer Guide*.
|
795
|
+
# Note the following:
|
769
796
|
#
|
770
797
|
# * Every message must have a unique `MessageDeduplicationId`.
|
771
798
|
#
|
@@ -795,15 +822,8 @@ module Aws::SQS
|
|
795
822
|
# `MessageDeduplicationId`, the two messages are treated as
|
796
823
|
# duplicates and only one copy of the message is delivered.
|
797
824
|
#
|
798
|
-
#
|
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:
|
825
|
+
# The following attributes apply only to [high throughput for FIFO
|
826
|
+
# queues][14]\:
|
807
827
|
#
|
808
828
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
809
829
|
# occurs at the message group or queue level. Valid values are
|
@@ -822,22 +842,11 @@ module Aws::SQS
|
|
822
842
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
823
843
|
#
|
824
844
|
# If you set these attributes to anything other than the values shown
|
825
|
-
# for enabling high throughput,
|
845
|
+
# for enabling high throughput, normal throughput is in effect and
|
826
846
|
# deduplication occurs as specified.
|
827
847
|
#
|
828
|
-
#
|
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*.
|
848
|
+
# For information on throughput quotas, see [Quotas related to
|
849
|
+
# messages][15] in the *Amazon SQS Developer Guide*.
|
841
850
|
#
|
842
851
|
#
|
843
852
|
#
|
@@ -849,16 +858,18 @@ module Aws::SQS
|
|
849
858
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
850
859
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
851
860
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
852
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
853
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
854
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
855
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
856
|
-
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
861
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
862
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
863
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
864
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
865
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
866
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
867
|
+
# [15]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
857
868
|
#
|
858
869
|
# @option params [Hash<String,String>] :tags
|
859
870
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
860
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
861
|
-
#
|
871
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
872
|
+
# Developer Guide*.
|
862
873
|
#
|
863
874
|
# When you use queue tags, keep the following guidelines in mind:
|
864
875
|
#
|
@@ -872,15 +883,15 @@ module Aws::SQS
|
|
872
883
|
# * A new tag with a key identical to that of an existing tag overwrites
|
873
884
|
# the existing tag.
|
874
885
|
#
|
875
|
-
# For a full list of tag restrictions, see [
|
876
|
-
# in the *Amazon
|
886
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
887
|
+
# in the *Amazon SQS Developer Guide*.
|
877
888
|
#
|
878
889
|
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
879
890
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
880
891
|
#
|
881
892
|
# Cross-account permissions don't apply to this action. For more
|
882
893
|
# information, see [Grant cross-account permissions to a role and a user
|
883
|
-
# name][3] in the *Amazon
|
894
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
884
895
|
#
|
885
896
|
# </note>
|
886
897
|
#
|
@@ -1046,7 +1057,7 @@ module Aws::SQS
|
|
1046
1057
|
#
|
1047
1058
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1048
1059
|
# information, see [Grant cross-account permissions to a role and a user
|
1049
|
-
# name][1] in the *Amazon
|
1060
|
+
# name][1] in the *Amazon SQS Developer Guide*.
|
1050
1061
|
#
|
1051
1062
|
# </note>
|
1052
1063
|
#
|
@@ -1096,6 +1107,9 @@ module Aws::SQS
|
|
1096
1107
|
# @option params [Array<String>] :attribute_names
|
1097
1108
|
# A list of attributes for which to retrieve information.
|
1098
1109
|
#
|
1110
|
+
# The `AttributeName.N` parameter is optional, but if you don't specify
|
1111
|
+
# values for this parameter, the request returns empty results.
|
1112
|
+
#
|
1099
1113
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1100
1114
|
# calls this action, we recommend that you structure your code so that
|
1101
1115
|
# it can handle new attributes gracefully.
|
@@ -1153,7 +1167,7 @@ module Aws::SQS
|
|
1153
1167
|
# dead-letter queue functionality of the source queue as a JSON
|
1154
1168
|
# object. For more information about the redrive policy and
|
1155
1169
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
1156
|
-
# the *Amazon
|
1170
|
+
# the *Amazon SQS Developer Guide*.
|
1157
1171
|
#
|
1158
1172
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1159
1173
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -1166,45 +1180,42 @@ module Aws::SQS
|
|
1166
1180
|
#
|
1167
1181
|
# * `VisibilityTimeout` – Returns the visibility timeout for the queue.
|
1168
1182
|
# For more information about the visibility timeout, see [Visibility
|
1169
|
-
# Timeout][3] in the *Amazon
|
1183
|
+
# Timeout][3] in the *Amazon SQS Developer Guide*.
|
1170
1184
|
#
|
1171
1185
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1172
1186
|
#
|
1173
|
-
# * `KmsMasterKeyId` – Returns the ID of an
|
1174
|
-
# key (CMK) for Amazon SQS or a custom CMK. For more
|
1175
|
-
# [Key Terms][5].
|
1187
|
+
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services managed
|
1188
|
+
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
1189
|
+
# information, see [Key Terms][5].
|
1176
1190
|
#
|
1177
1191
|
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
1178
1192
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
1179
|
-
# decrypt messages before calling
|
1180
|
-
#
|
1193
|
+
# decrypt messages before calling KMS again. For more information, see
|
1194
|
+
# [How Does the Data Key Reuse Period Work?][6].
|
1195
|
+
#
|
1196
|
+
# * `SqsManagedSseEnabled` – Returns information about whether the queue
|
1197
|
+
# is using SSE-SQS encryption using SQS owned encryption keys. Only
|
1198
|
+
# one server-side encryption option is supported per queue (e.g.
|
1199
|
+
# [SSE-KMS][7] or [SSE-SQS][8]).
|
1181
1200
|
#
|
1182
1201
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
1183
|
-
# queues][
|
1202
|
+
# queues][9]\:
|
1184
1203
|
#
|
1185
1204
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
1186
|
-
# For more information, see [FIFO
|
1187
|
-
#
|
1205
|
+
# For more information, see [FIFO queue logic][10] in the *Amazon SQS
|
1206
|
+
# Developer Guide*.
|
1188
1207
|
#
|
1189
|
-
# <note markdown="1"> To determine whether a queue is [FIFO][
|
1208
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][9], you can check whether
|
1190
1209
|
# `QueueName` ends with the `.fifo` suffix.
|
1191
1210
|
#
|
1192
1211
|
# </note>
|
1193
1212
|
#
|
1194
1213
|
# * `ContentBasedDeduplication` – Returns whether content-based
|
1195
1214
|
# deduplication is enabled for the queue. For more information, see
|
1196
|
-
# [Exactly-
|
1197
|
-
# Developer Guide*.
|
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*.
|
1215
|
+
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
1206
1216
|
#
|
1207
|
-
#
|
1217
|
+
# The following attributes apply only to [high throughput for FIFO
|
1218
|
+
# queues][12]\:
|
1208
1219
|
#
|
1209
1220
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
1210
1221
|
# occurs at the message group or queue level. Valid values are
|
@@ -1223,22 +1234,11 @@ module Aws::SQS
|
|
1223
1234
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
1224
1235
|
#
|
1225
1236
|
# If you set these attributes to anything other than the values shown
|
1226
|
-
# for enabling high throughput,
|
1237
|
+
# for enabling high throughput, normal throughput is in effect and
|
1227
1238
|
# deduplication occurs as specified.
|
1228
1239
|
#
|
1229
|
-
#
|
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*.
|
1240
|
+
# For information on throughput quotas, see [Quotas related to
|
1241
|
+
# messages][13] in the *Amazon SQS Developer Guide*.
|
1242
1242
|
#
|
1243
1243
|
#
|
1244
1244
|
#
|
@@ -1248,11 +1248,13 @@ module Aws::SQS
|
|
1248
1248
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
1249
1249
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
1250
1250
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
1251
|
-
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1252
|
-
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1253
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
1254
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1255
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1251
|
+
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1252
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1253
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
1254
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
|
1255
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
1256
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
1257
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
1256
1258
|
#
|
1257
1259
|
# @return [Types::GetQueueAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1258
1260
|
#
|
@@ -1262,7 +1264,7 @@ module Aws::SQS
|
|
1262
1264
|
#
|
1263
1265
|
# resp = client.get_queue_attributes({
|
1264
1266
|
# queue_url: "String", # required
|
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
|
1267
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
1266
1268
|
# })
|
1267
1269
|
#
|
1268
1270
|
# @example Response structure
|
@@ -1286,7 +1288,7 @@ module Aws::SQS
|
|
1286
1288
|
# queue's owner. The queue's owner must grant you permission to access
|
1287
1289
|
# the queue. For more information about shared queue access, see `
|
1288
1290
|
# AddPermission ` or see [Allow Developers to Write Messages to a Shared
|
1289
|
-
# Queue][1] in the *Amazon
|
1291
|
+
# Queue][1] in the *Amazon SQS Developer Guide*.
|
1290
1292
|
#
|
1291
1293
|
#
|
1292
1294
|
#
|
@@ -1300,7 +1302,8 @@ module Aws::SQS
|
|
1300
1302
|
# Queue URLs and names are case-sensitive.
|
1301
1303
|
#
|
1302
1304
|
# @option params [String] :queue_owner_aws_account_id
|
1303
|
-
# The
|
1305
|
+
# The Amazon Web Services account ID of the account that created the
|
1306
|
+
# queue.
|
1304
1307
|
#
|
1305
1308
|
# @return [Types::GetQueueUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1306
1309
|
#
|
@@ -1339,8 +1342,7 @@ module Aws::SQS
|
|
1339
1342
|
# receive the next page of results.
|
1340
1343
|
#
|
1341
1344
|
# For more information about using dead-letter queues, see [Using Amazon
|
1342
|
-
# SQS Dead-Letter Queues][1] in the *Amazon
|
1343
|
-
# Developer Guide*.
|
1345
|
+
# SQS Dead-Letter Queues][1] in the *Amazon SQS Developer Guide*.
|
1344
1346
|
#
|
1345
1347
|
#
|
1346
1348
|
#
|
@@ -1391,11 +1393,11 @@ module Aws::SQS
|
|
1391
1393
|
|
1392
1394
|
# List all cost allocation tags added to the specified Amazon SQS queue.
|
1393
1395
|
# For an overview, see [Tagging Your Amazon SQS Queues][1] in the
|
1394
|
-
# *Amazon
|
1396
|
+
# *Amazon SQS Developer Guide*.
|
1395
1397
|
#
|
1396
1398
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1397
1399
|
# information, see [Grant cross-account permissions to a role and a user
|
1398
|
-
# name][2] in the *Amazon
|
1400
|
+
# name][2] in the *Amazon SQS Developer Guide*.
|
1399
1401
|
#
|
1400
1402
|
# </note>
|
1401
1403
|
#
|
@@ -1446,7 +1448,7 @@ module Aws::SQS
|
|
1446
1448
|
#
|
1447
1449
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1448
1450
|
# information, see [Grant cross-account permissions to a role and a user
|
1449
|
-
# name][1] in the *Amazon
|
1451
|
+
# name][1] in the *Amazon SQS Developer Guide*.
|
1450
1452
|
#
|
1451
1453
|
# </note>
|
1452
1454
|
#
|
@@ -1537,8 +1539,8 @@ module Aws::SQS
|
|
1537
1539
|
|
1538
1540
|
# Retrieves one or more messages (up to 10), from the specified queue.
|
1539
1541
|
# Using the `WaitTimeSeconds` parameter enables long-poll support. For
|
1540
|
-
# more information, see [Amazon SQS Long Polling][1] in the *Amazon
|
1541
|
-
#
|
1542
|
+
# more information, see [Amazon SQS Long Polling][1] in the *Amazon SQS
|
1543
|
+
# Developer Guide*.
|
1542
1544
|
#
|
1543
1545
|
# Short poll is the default behavior where a weighted random set of
|
1544
1546
|
# machines is sampled on a `ReceiveMessage` call. Thus, only the
|
@@ -1566,14 +1568,14 @@ module Aws::SQS
|
|
1566
1568
|
#
|
1567
1569
|
# The receipt handle is the identifier you must provide when deleting
|
1568
1570
|
# the message. For more information, see [Queue and Message
|
1569
|
-
# Identifiers][3] in the *Amazon
|
1571
|
+
# Identifiers][3] in the *Amazon SQS Developer Guide*.
|
1570
1572
|
#
|
1571
1573
|
# You can provide the `VisibilityTimeout` parameter in your request. The
|
1572
1574
|
# parameter is applied to the messages that Amazon SQS returns in the
|
1573
1575
|
# response. If you don't include the parameter, the overall visibility
|
1574
1576
|
# timeout for the queue is used for the returned messages. For more
|
1575
|
-
# information, see [Visibility Timeout][4] in the *Amazon
|
1576
|
-
#
|
1577
|
+
# information, see [Visibility Timeout][4] in the *Amazon SQS Developer
|
1578
|
+
# Guide*.
|
1577
1579
|
#
|
1578
1580
|
# A message that isn't deleted or a message whose visibility isn't
|
1579
1581
|
# extended before the visibility timeout expires counts as a failed
|
@@ -1610,7 +1612,7 @@ module Aws::SQS
|
|
1610
1612
|
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1611
1613
|
# has been received across all queues but not deleted.
|
1612
1614
|
#
|
1613
|
-
# * `AWSTraceHeader` – Returns the
|
1615
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1614
1616
|
#
|
1615
1617
|
# * `SenderId`
|
1616
1618
|
#
|
@@ -1623,6 +1625,10 @@ module Aws::SQS
|
|
1623
1625
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1624
1626
|
# ([epoch time][1] in milliseconds).
|
1625
1627
|
#
|
1628
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
1629
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
1630
|
+
# supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
|
1631
|
+
#
|
1626
1632
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1627
1633
|
# producer that calls the ` SendMessage ` action.
|
1628
1634
|
#
|
@@ -1635,6 +1641,8 @@ module Aws::SQS
|
|
1635
1641
|
#
|
1636
1642
|
#
|
1637
1643
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1644
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1645
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1638
1646
|
#
|
1639
1647
|
# @option params [Array<String>] :message_attribute_names
|
1640
1648
|
# The name of the message attribute, where *N* is the index.
|
@@ -1714,7 +1722,7 @@ module Aws::SQS
|
|
1714
1722
|
# `ReceiveRequestAttemptId` return the same messages and receipt
|
1715
1723
|
# handles. If a retry occurs within the deduplication interval, it
|
1716
1724
|
# resets the visibility timeout. For more information, see [Visibility
|
1717
|
-
# Timeout][1] in the *Amazon
|
1725
|
+
# Timeout][1] in the *Amazon SQS Developer Guide*.
|
1718
1726
|
#
|
1719
1727
|
# If a caller of the `ReceiveMessage` action still processes messages
|
1720
1728
|
# when the visibility timeout expires and messages become visible,
|
@@ -1743,8 +1751,8 @@ module Aws::SQS
|
|
1743
1751
|
# ``).
|
1744
1752
|
#
|
1745
1753
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
1746
|
-
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
|
1747
|
-
#
|
1754
|
+
# ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
|
1755
|
+
# Developer Guide*.
|
1748
1756
|
#
|
1749
1757
|
#
|
1750
1758
|
#
|
@@ -1759,7 +1767,7 @@ module Aws::SQS
|
|
1759
1767
|
#
|
1760
1768
|
# resp = client.receive_message({
|
1761
1769
|
# queue_url: "String", # required
|
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
|
1770
|
+
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
1763
1771
|
# message_attribute_names: ["MessageAttributeName"],
|
1764
1772
|
# max_number_of_messages: 1,
|
1765
1773
|
# visibility_timeout: 1,
|
@@ -1802,7 +1810,7 @@ module Aws::SQS
|
|
1802
1810
|
#
|
1803
1811
|
# * Cross-account permissions don't apply to this action. For more
|
1804
1812
|
# information, see [Grant cross-account permissions to a role and a
|
1805
|
-
# user name][1] in the *Amazon
|
1813
|
+
# user name][1] in the *Amazon SQS Developer Guide*.
|
1806
1814
|
#
|
1807
1815
|
# * To remove the ability to change queue permissions, you must deny
|
1808
1816
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -1892,8 +1900,8 @@ module Aws::SQS
|
|
1892
1900
|
#
|
1893
1901
|
# @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
1894
1902
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
1895
|
-
# more information, see [Amazon SQS
|
1896
|
-
# *Amazon
|
1903
|
+
# more information, see [Amazon SQS message attributes][1] in the
|
1904
|
+
# *Amazon SQS Developer Guide*.
|
1897
1905
|
#
|
1898
1906
|
#
|
1899
1907
|
#
|
@@ -1905,7 +1913,7 @@ module Aws::SQS
|
|
1905
1913
|
#
|
1906
1914
|
# * Currently, the only supported message system attribute is
|
1907
1915
|
# `AWSTraceHeader`. Its type must be `String` and its value must be a
|
1908
|
-
# correctly formatted
|
1916
|
+
# correctly formatted X-Ray trace header string.
|
1909
1917
|
#
|
1910
1918
|
# * The size of a message system attribute doesn't count towards the
|
1911
1919
|
# total size of a message.
|
@@ -1917,8 +1925,8 @@ module Aws::SQS
|
|
1917
1925
|
# particular `MessageDeduplicationId` is sent successfully, any messages
|
1918
1926
|
# sent with the same `MessageDeduplicationId` are accepted successfully
|
1919
1927
|
# but aren't delivered during the 5-minute deduplication interval. For
|
1920
|
-
# more information, see [ Exactly-
|
1921
|
-
#
|
1928
|
+
# more information, see [ Exactly-once processing][1] in the *Amazon SQS
|
1929
|
+
# Developer Guide*.
|
1922
1930
|
#
|
1923
1931
|
# * Every message must have a unique `MessageDeduplicationId`,
|
1924
1932
|
#
|
@@ -1964,12 +1972,12 @@ module Aws::SQS
|
|
1964
1972
|
# ``).
|
1965
1973
|
#
|
1966
1974
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
1967
|
-
# MessageDeduplicationId Property][2] in the *Amazon
|
1968
|
-
#
|
1975
|
+
# MessageDeduplicationId Property][2] in the *Amazon SQS Developer
|
1976
|
+
# Guide*.
|
1969
1977
|
#
|
1970
1978
|
#
|
1971
1979
|
#
|
1972
|
-
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues
|
1980
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
1973
1981
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
1974
1982
|
#
|
1975
1983
|
# @option params [String] :message_group_id
|
@@ -1996,8 +2004,7 @@ module Aws::SQS
|
|
1996
2004
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1997
2005
|
#
|
1998
2006
|
# For best practices of using `MessageGroupId`, see [Using the
|
1999
|
-
# MessageGroupId Property][1] in the *Amazon
|
2000
|
-
# Developer Guide*.
|
2007
|
+
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
2001
2008
|
#
|
2002
2009
|
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
2003
2010
|
# Standard queues.
|
@@ -2178,7 +2185,7 @@ module Aws::SQS
|
|
2178
2185
|
#
|
2179
2186
|
# * Cross-account permissions don't apply to this action. For more
|
2180
2187
|
# information, see [Grant cross-account permissions to a role and a
|
2181
|
-
# user name][1] in the *Amazon
|
2188
|
+
# user name][1] in the *Amazon SQS Developer Guide*.
|
2182
2189
|
#
|
2183
2190
|
# * To remove the ability to change queue permissions, you must deny
|
2184
2191
|
# permission to the `AddPermission`, `RemovePermission`, and
|
@@ -2215,9 +2222,10 @@ module Aws::SQS
|
|
2215
2222
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
2216
2223
|
# (4 days).
|
2217
2224
|
#
|
2218
|
-
# * `Policy` – The queue's policy. A valid
|
2219
|
-
# information about policy structure, see [Overview of
|
2220
|
-
# Policies][1] in the *
|
2225
|
+
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
2226
|
+
# For more information about policy structure, see [Overview of Amazon
|
2227
|
+
# Web Services IAM Policies][1] in the *Identity and Access Management
|
2228
|
+
# User Guide*.
|
2221
2229
|
#
|
2222
2230
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
2223
2231
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
@@ -2227,7 +2235,7 @@ module Aws::SQS
|
|
2227
2235
|
# dead-letter queue functionality of the source queue as a JSON
|
2228
2236
|
# object. For more information about the redrive policy and
|
2229
2237
|
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
2230
|
-
# the *Amazon
|
2238
|
+
# the *Amazon SQS Developer Guide*.
|
2231
2239
|
#
|
2232
2240
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2233
2241
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2247,33 +2255,36 @@ module Aws::SQS
|
|
2247
2255
|
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2248
2256
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2249
2257
|
# Default: 30. For more information about the visibility timeout, see
|
2250
|
-
# [Visibility Timeout][3] in the *Amazon
|
2251
|
-
# Developer Guide*.
|
2258
|
+
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
2252
2259
|
#
|
2253
2260
|
# The following attributes apply only to [server-side-encryption][4]\:
|
2254
2261
|
#
|
2255
|
-
# * `KmsMasterKeyId` – The ID of an
|
2256
|
-
# (CMK) for Amazon SQS or a custom CMK. For more
|
2257
|
-
# Terms][5]. While the alias of the AWS-managed
|
2258
|
-
# always `alias/aws/sqs`, the alias of a custom
|
2259
|
-
# be `alias/MyAlias `. For more examples, see
|
2260
|
-
# Key Management Service API Reference*.
|
2262
|
+
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
|
2263
|
+
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
2264
|
+
# information, see [Key Terms][5]. While the alias of the AWS-managed
|
2265
|
+
# CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom
|
2266
|
+
# CMK can, for example, be `alias/MyAlias `. For more examples, see
|
2267
|
+
# [KeyId][6] in the *Key Management Service API Reference*.
|
2261
2268
|
#
|
2262
2269
|
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
2263
2270
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
2264
|
-
# messages before calling
|
2265
|
-
#
|
2266
|
-
#
|
2267
|
-
#
|
2268
|
-
#
|
2269
|
-
#
|
2271
|
+
# messages before calling KMS again. An integer representing seconds,
|
2272
|
+
# between 60 seconds (1 minute) and 86,400 seconds (24 hours).
|
2273
|
+
# Default: 300 (5 minutes). A shorter time period provides better
|
2274
|
+
# security but results in more calls to KMS which might incur charges
|
2275
|
+
# after Free Tier. For more information, see [How Does the Data Key
|
2276
|
+
# Reuse Period Work?][8].
|
2277
|
+
#
|
2278
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
2279
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
2280
|
+
# supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
|
2270
2281
|
#
|
2271
2282
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2272
|
-
# queues][
|
2283
|
+
# queues][11]\:
|
2273
2284
|
#
|
2274
2285
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2275
|
-
# For more information, see [Exactly-
|
2276
|
-
# *Amazon
|
2286
|
+
# For more information, see [Exactly-once processing][12] in the
|
2287
|
+
# *Amazon SQS Developer Guide*. Note the following:
|
2277
2288
|
#
|
2278
2289
|
# * Every message must have a unique `MessageDeduplicationId`.
|
2279
2290
|
#
|
@@ -2303,15 +2314,8 @@ module Aws::SQS
|
|
2303
2314
|
# `MessageDeduplicationId`, the two messages are treated as
|
2304
2315
|
# duplicates and only one copy of the message is delivered.
|
2305
2316
|
#
|
2306
|
-
#
|
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:
|
2317
|
+
# The following attributes apply only to [high throughput for FIFO
|
2318
|
+
# queues][13]\:
|
2315
2319
|
#
|
2316
2320
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2317
2321
|
# occurs at the message group or queue level. Valid values are
|
@@ -2330,22 +2334,11 @@ module Aws::SQS
|
|
2330
2334
|
# * Set `FifoThroughputLimit` to `perMessageGroupId`.
|
2331
2335
|
#
|
2332
2336
|
# If you set these attributes to anything other than the values shown
|
2333
|
-
# for enabling high throughput,
|
2337
|
+
# for enabling high throughput, normal throughput is in effect and
|
2334
2338
|
# deduplication occurs as specified.
|
2335
2339
|
#
|
2336
|
-
#
|
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*.
|
2340
|
+
# For information on throughput quotas, see [Quotas related to
|
2341
|
+
# messages][14] in the *Amazon SQS Developer Guide*.
|
2349
2342
|
#
|
2350
2343
|
#
|
2351
2344
|
#
|
@@ -2357,10 +2350,12 @@ module Aws::SQS
|
|
2357
2350
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
2358
2351
|
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
2359
2352
|
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2360
|
-
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2361
|
-
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2362
|
-
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2363
|
-
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
2353
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
2354
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
2355
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2356
|
+
# [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
2357
|
+
# [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
|
2358
|
+
# [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
|
2364
2359
|
#
|
2365
2360
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2366
2361
|
#
|
@@ -2383,8 +2378,8 @@ module Aws::SQS
|
|
2383
2378
|
end
|
2384
2379
|
|
2385
2380
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
2386
|
-
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2387
|
-
#
|
2381
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
|
2382
|
+
# Developer Guide*.
|
2388
2383
|
#
|
2389
2384
|
# When you use queue tags, keep the following guidelines in mind:
|
2390
2385
|
#
|
@@ -2398,12 +2393,12 @@ module Aws::SQS
|
|
2398
2393
|
# * A new tag with a key identical to that of an existing tag overwrites
|
2399
2394
|
# the existing tag.
|
2400
2395
|
#
|
2401
|
-
# For a full list of tag restrictions, see [
|
2402
|
-
# in the *Amazon
|
2396
|
+
# For a full list of tag restrictions, see [Quotas related to queues][2]
|
2397
|
+
# in the *Amazon SQS Developer Guide*.
|
2403
2398
|
#
|
2404
2399
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2405
2400
|
# information, see [Grant cross-account permissions to a role and a user
|
2406
|
-
# name][3] in the *Amazon
|
2401
|
+
# name][3] in the *Amazon SQS Developer Guide*.
|
2407
2402
|
#
|
2408
2403
|
# </note>
|
2409
2404
|
#
|
@@ -2441,11 +2436,11 @@ module Aws::SQS
|
|
2441
2436
|
|
2442
2437
|
# Remove cost allocation tags from the specified Amazon SQS queue. For
|
2443
2438
|
# an overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2444
|
-
#
|
2439
|
+
# SQS Developer Guide*.
|
2445
2440
|
#
|
2446
2441
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2447
2442
|
# information, see [Grant cross-account permissions to a role and a user
|
2448
|
-
# name][2] in the *Amazon
|
2443
|
+
# name][2] in the *Amazon SQS Developer Guide*.
|
2449
2444
|
#
|
2450
2445
|
# </note>
|
2451
2446
|
#
|
@@ -2491,7 +2486,7 @@ module Aws::SQS
|
|
2491
2486
|
params: params,
|
2492
2487
|
config: config)
|
2493
2488
|
context[:gem_name] = 'aws-sdk-sqs'
|
2494
|
-
context[:gem_version] = '1.
|
2489
|
+
context[:gem_version] = '1.51.1'
|
2495
2490
|
Seahorse::Client::Request.new(handlers, context)
|
2496
2491
|
end
|
2497
2492
|
|