aws-sdk-sqs 1.50.0 → 1.54.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.
@@ -27,10 +27,11 @@ 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'
30
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
31
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
32
- require 'aws-sdk-core/plugins/signature_v4.rb'
33
- require 'aws-sdk-core/plugins/protocols/query.rb'
33
+ require 'aws-sdk-core/plugins/sign.rb'
34
+ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
34
35
  require 'aws-sdk-sqs/plugins/queue_urls.rb'
35
36
  require 'aws-sdk-sqs/plugins/md5s.rb'
36
37
 
@@ -77,12 +78,14 @@ module Aws::SQS
77
78
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
78
79
  add_plugin(Aws::Plugins::TransferEncoding)
79
80
  add_plugin(Aws::Plugins::HttpChecksum)
81
+ add_plugin(Aws::Plugins::ChecksumAlgorithm)
80
82
  add_plugin(Aws::Plugins::DefaultsMode)
81
83
  add_plugin(Aws::Plugins::RecursionDetection)
82
- add_plugin(Aws::Plugins::SignatureV4)
83
- add_plugin(Aws::Plugins::Protocols::Query)
84
+ add_plugin(Aws::Plugins::Sign)
85
+ add_plugin(Aws::Plugins::Protocols::JsonRpc)
84
86
  add_plugin(Aws::SQS::Plugins::QueueUrls)
85
87
  add_plugin(Aws::SQS::Plugins::Md5s)
88
+ add_plugin(Aws::SQS::Plugins::Endpoints)
86
89
 
87
90
  # @overload initialize(options)
88
91
  # @param [Hash] options
@@ -280,6 +283,16 @@ module Aws::SQS
280
283
  #
281
284
  # @option options [String] :session_token
282
285
  #
286
+ # @option options [Boolean] :simple_json (false)
287
+ # Disables request parameter conversion, validation, and formatting.
288
+ # Also disable response data type conversions. This option is useful
289
+ # when you want to ensure the highest level of performance by
290
+ # avoiding overhead of walking request parameters and response data
291
+ # structures.
292
+ #
293
+ # When `:simple_json` is enabled, the request parameters hash must
294
+ # be formatted exactly as the DynamoDB API expects.
295
+ #
283
296
  # @option options [Boolean] :stub_responses (false)
284
297
  # Causes the client to return stubbed responses. By default
285
298
  # fake responses are generated and returned. You can specify
@@ -289,6 +302,19 @@ module Aws::SQS
289
302
  # ** Please note ** When response stubbing is enabled, no HTTP
290
303
  # requests are made, and retries are disabled.
291
304
  #
305
+ # @option options [Aws::TokenProvider] :token_provider
306
+ # A Bearer Token Provider. This can be an instance of any one of the
307
+ # following classes:
308
+ #
309
+ # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
310
+ # tokens.
311
+ #
312
+ # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
313
+ # access token generated from `aws login`.
314
+ #
315
+ # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
316
+ # will be used to search for tokens configured for your profile in shared configuration files.
317
+ #
292
318
  # @option options [Boolean] :use_dualstack_endpoint
293
319
  # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
294
320
  # will be used if available.
@@ -308,6 +334,9 @@ module Aws::SQS
308
334
  # `Aws::Errors::Checksum` errors are raised for cases where checksums do
309
335
  # not match.
310
336
  #
337
+ # @option options [Aws::SQS::EndpointProvider] :endpoint_provider
338
+ # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::SQS::EndpointParameters`
339
+ #
311
340
  # @option options [URI::HTTP,String] :http_proxy A proxy to send
312
341
  # requests through. Formatted like 'http://proxy.com:123'.
313
342
  #
@@ -373,25 +402,21 @@ module Aws::SQS
373
402
  # see [Using Custom Policies with the Amazon SQS Access Policy
374
403
  # Language][3] in the *Amazon SQS Developer Guide*.
375
404
  #
376
- # * An Amazon SQS policy can have a maximum of 7 actions.
405
+ # * An Amazon SQS policy can have a maximum of seven actions per
406
+ # statement.
377
407
  #
378
408
  # * To remove the ability to change queue permissions, you must deny
379
409
  # permission to the `AddPermission`, `RemovePermission`, and
380
410
  # `SetQueueAttributes` actions in your IAM policy.
381
411
  #
382
- # </note>
383
- #
384
- # Some actions take lists of parameters. These lists are specified using
385
- # the `param.n` notation. Values of `n` are integers starting from 1.
386
- # For example, a parameter list with two elements looks like this:
387
- #
388
- # `&AttributeName.1=first`
412
+ # * Amazon SQS `AddPermission` does not support adding a non-account
413
+ # principal.
389
414
  #
390
- # `&AttributeName.2=second`
415
+ # </note>
391
416
  #
392
417
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
393
- # information, see [Grant cross-account permissions to a role and a user
394
- # name][4] in the *Amazon SQS Developer Guide*.
418
+ # information, see [Grant cross-account permissions to a role and a
419
+ # username][4] in the *Amazon SQS Developer Guide*.
395
420
  #
396
421
  # </note>
397
422
  #
@@ -468,12 +493,14 @@ module Aws::SQS
468
493
  # information, see [Visibility Timeout][1] in the *Amazon SQS Developer
469
494
  # Guide*.
470
495
  #
471
- # For example, you have a message with a visibility timeout of 5
472
- # minutes. After 3 minutes, you call `ChangeMessageVisibility` with a
473
- # timeout of 10 minutes. You can continue to call
474
- # `ChangeMessageVisibility` to extend the visibility timeout to the
475
- # maximum allowed time. If you try to extend the visibility timeout
476
- # beyond the maximum, your request is rejected.
496
+ # For example, if the default timeout for a queue is 60 seconds, 15
497
+ # seconds have elapsed since you received the message, and you send a
498
+ # ChangeMessageVisibility call with `VisibilityTimeout` set to 10
499
+ # seconds, the 10 seconds begin to count from the time that you make the
500
+ # `ChangeMessageVisibility` call. Thus, any attempt to change the
501
+ # visibility timeout or to delete that message 10 seconds after you
502
+ # initially change the visibility timeout (a total of 25 seconds) might
503
+ # result in an error.
477
504
  #
478
505
  # An Amazon SQS message has three basic states:
479
506
  #
@@ -489,13 +516,13 @@ module Aws::SQS
489
516
  # messages. A message is considered to be *in flight* after it is
490
517
  # received from a queue by a consumer, but not yet deleted from the
491
518
  # queue (that is, between states 2 and 3). There is a limit to the
492
- # number of inflight messages.
519
+ # number of in flight messages.
493
520
  #
494
- # Limits that apply to inflight messages are unrelated to the
521
+ # Limits that apply to in flight messages are unrelated to the
495
522
  # *unlimited* number of stored messages.
496
523
  #
497
524
  # For most standard queues (depending on queue traffic and message
498
- # backlog), there can be a maximum of approximately 120,000 inflight
525
+ # backlog), there can be a maximum of approximately 120,000 in flight
499
526
  # messages (received from a queue by a consumer, but not yet deleted
500
527
  # from the queue). If you reach this limit, Amazon SQS returns the
501
528
  # `OverLimit` error message. To avoid reaching the limit, you should
@@ -503,7 +530,7 @@ module Aws::SQS
503
530
  # increase the number of queues you use to process your messages. To
504
531
  # request a limit increase, [file a support request][2].
505
532
  #
506
- # For FIFO queues, there can be a maximum of 20,000 inflight messages
533
+ # For FIFO queues, there can be a maximum of 20,000 in flight messages
507
534
  # (received from a queue by a consumer, but not yet deleted from the
508
535
  # queue). If you reach this limit, Amazon SQS returns no error messages.
509
536
  #
@@ -569,14 +596,6 @@ module Aws::SQS
569
596
  # and unsuccessful actions, you should check for batch errors even when
570
597
  # the call returns an HTTP status code of `200`.
571
598
  #
572
- # Some actions take lists of parameters. These lists are specified using
573
- # the `param.n` notation. Values of `n` are integers starting from 1.
574
- # For example, a parameter list with two elements looks like this:
575
- #
576
- # `&AttributeName.1=first`
577
- #
578
- # `&AttributeName.2=second`
579
- #
580
599
  # @option params [required, String] :queue_url
581
600
  # The URL of the Amazon SQS queue whose messages' visibility is
582
601
  # changed.
@@ -665,17 +684,9 @@ module Aws::SQS
665
684
  # * If the queue name, attribute names, or attribute values don't match
666
685
  # an existing queue, `CreateQueue` returns an error.
667
686
  #
668
- # Some actions take lists of parameters. These lists are specified using
669
- # the `param.n` notation. Values of `n` are integers starting from 1.
670
- # For example, a parameter list with two elements looks like this:
671
- #
672
- # `&AttributeName.1=first`
673
- #
674
- # `&AttributeName.2=second`
675
- #
676
687
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
677
- # information, see [Grant cross-account permissions to a role and a user
678
- # name][3] in the *Amazon SQS Developer Guide*.
688
+ # information, see [Grant cross-account permissions to a role and a
689
+ # username][3] in the *Amazon SQS Developer Guide*.
679
690
  #
680
691
  # </note>
681
692
  #
@@ -715,43 +726,77 @@ module Aws::SQS
715
726
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
716
727
  # Amazon SQS retains a message. Valid values: An integer from 60
717
728
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
718
- # (4 days).
729
+ # (4 days). When you change a queue's attributes, the change can take
730
+ # up to 60 seconds for most of the attributes to propagate throughout
731
+ # the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
732
+ # attribute can take up to 15 minutes and will impact existing
733
+ # messages in the queue potentially causing them to be expired and
734
+ # deleted if the `MessageRetentionPeriod` is reduced below the age of
735
+ # existing messages.
719
736
  #
720
737
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
721
738
  # For more information about policy structure, see [Overview of Amazon
722
- # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
739
+ # Web Services IAM Policies][1] in the *IAM User Guide*.
723
740
  #
724
741
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
725
742
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
726
743
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
727
744
  #
745
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
746
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
747
+ # Default: 30. For more information about the visibility timeout, see
748
+ # [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
749
+ #
750
+ # The following attributes apply only to [dead-letter queues:][3]
751
+ #
728
752
  # * `RedrivePolicy` – The string that includes the parameters for the
729
753
  # dead-letter queue functionality of the source queue as a JSON
730
- # object. For more information about the redrive policy and
731
- # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
732
- # the *Amazon SQS Developer Guide*.
754
+ # object. The parameters are as follows:
733
755
  #
734
756
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
735
757
  # dead-letter queue to which Amazon SQS moves messages after the
736
758
  # value of `maxReceiveCount` is exceeded.
737
759
  #
738
760
  # * `maxReceiveCount` – The number of times a message is delivered to
739
- # the source queue before being moved to the dead-letter queue. When
740
- # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
741
- # a queue, Amazon SQS moves the message to the dead-letter-queue.
742
- #
743
- # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
744
- # Similarly, the dead-letter queue of a standard queue must also be a
745
- # standard queue.
746
- #
747
- # </note>
761
+ # the source queue before being moved to the dead-letter queue.
762
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
763
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
764
+ # dead-letter-queue.
765
+ #
766
+ # * `RedriveAllowPolicy` The string that includes the parameters for
767
+ # the permissions for the dead-letter queue redrive permission and
768
+ # which source queues can specify dead-letter queues as a JSON object.
769
+ # The parameters are as follows:
770
+ #
771
+ # * `redrivePermission` – The permission type that defines which
772
+ # source queues can specify the current queue as the dead-letter
773
+ # queue. Valid values are:
774
+ #
775
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
776
+ # Services account in the same Region can specify this queue as
777
+ # the dead-letter queue.
778
+ #
779
+ # * `denyAll` – No source queues can specify this queue as the
780
+ # dead-letter queue.
781
+ #
782
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
783
+ # parameter can specify this queue as the dead-letter queue.
784
+ #
785
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
786
+ # queues that can specify this queue as the dead-letter queue and
787
+ # redrive messages. You can specify this parameter only when the
788
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
789
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
790
+ # specify dead-letter queues, set the `redrivePermission` parameter
791
+ # to `allowAll`.
792
+ #
793
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
794
+ # Similarly, the dead-letter queue of a standard queue must also be a
795
+ # standard queue.
748
796
  #
749
- # * `VisibilityTimeout` – The visibility timeout for the queue, in
750
- # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
751
- # Default: 30. For more information about the visibility timeout, see
752
- # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
797
+ # </note>
753
798
  #
754
- # The following attributes apply only to [server-side-encryption][4]\:
799
+ # The following attributes apply only to [server-side-encryption][4]:
755
800
  #
756
801
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
757
802
  # master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -768,14 +813,14 @@ module Aws::SQS
768
813
  # Default: 300 (5 minutes). A shorter time period provides better
769
814
  # security but results in more calls to KMS which might incur charges
770
815
  # after Free Tier. For more information, see [How Does the Data Key
771
- # Reuse Period Work?][8].
816
+ # Reuse Period Work?][8]
772
817
  #
773
818
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
774
819
  # SQS owned encryption keys. Only one server-side encryption option is
775
- # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
820
+ # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
776
821
  #
777
822
  # The following attributes apply only to [FIFO (first-in-first-out)
778
- # queues][11]\:
823
+ # queues][11]:
779
824
  #
780
825
  # * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
781
826
  # and `false`. If you don't specify the `FifoQueue` attribute, Amazon
@@ -821,7 +866,7 @@ module Aws::SQS
821
866
  # duplicates and only one copy of the message is delivered.
822
867
  #
823
868
  # The following attributes apply only to [high throughput for FIFO
824
- # queues][14]\:
869
+ # queues][14]:
825
870
  #
826
871
  # * `DeduplicationScope` – Specifies whether message deduplication
827
872
  # occurs at the message group or queue level. Valid values are
@@ -849,8 +894,8 @@ module Aws::SQS
849
894
  #
850
895
  #
851
896
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
852
- # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
853
- # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
897
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
898
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
854
899
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
855
900
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
856
901
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -888,8 +933,8 @@ module Aws::SQS
888
933
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
889
934
  #
890
935
  # Cross-account permissions don't apply to this action. For more
891
- # information, see [Grant cross-account permissions to a role and a user
892
- # name][3] in the *Amazon SQS Developer Guide*.
936
+ # information, see [Grant cross-account permissions to a role and a
937
+ # username][3] in the *Amazon SQS Developer Guide*.
893
938
  #
894
939
  # </note>
895
940
  #
@@ -941,7 +986,7 @@ module Aws::SQS
941
986
  # `ReceiptHandle` is different each time you receive a message. When you
942
987
  # use the `DeleteMessage` action, you must provide the most recently
943
988
  # received `ReceiptHandle` for the message (otherwise, the request
944
- # succeeds, but the message might not be deleted).
989
+ # succeeds, but the message will not be deleted).
945
990
  #
946
991
  # For standard queues, it is possible to receive a message even after
947
992
  # you delete it. This might happen on rare occasions if one of the
@@ -987,14 +1032,6 @@ module Aws::SQS
987
1032
  # and unsuccessful actions, you should check for batch errors even when
988
1033
  # the call returns an HTTP status code of `200`.
989
1034
  #
990
- # Some actions take lists of parameters. These lists are specified using
991
- # the `param.n` notation. Values of `n` are integers starting from 1.
992
- # For example, a parameter list with two elements looks like this:
993
- #
994
- # `&AttributeName.1=first`
995
- #
996
- # `&AttributeName.2=second`
997
- #
998
1035
  # @option params [required, String] :queue_url
999
1036
  # The URL of the Amazon SQS queue from which messages are deleted.
1000
1037
  #
@@ -1054,8 +1091,10 @@ module Aws::SQS
1054
1091
  # creating a queue with the same name.
1055
1092
  #
1056
1093
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1057
- # information, see [Grant cross-account permissions to a role and a user
1058
- # name][1] in the *Amazon SQS Developer Guide*.
1094
+ # information, see [Grant cross-account permissions to a role and a
1095
+ # username][1] in the *Amazon SQS Developer Guide*.
1096
+ #
1097
+ # The delete operation uses the HTTP `GET` verb.
1059
1098
  #
1060
1099
  # </note>
1061
1100
  #
@@ -1105,7 +1144,7 @@ module Aws::SQS
1105
1144
  # @option params [Array<String>] :attribute_names
1106
1145
  # A list of attributes for which to retrieve information.
1107
1146
  #
1108
- # The `AttributeName.N` parameter is optional, but if you don't specify
1147
+ # The `AttributeNames` parameter is optional, but if you don't specify
1109
1148
  # values for this parameter, the request returns empty results.
1110
1149
  #
1111
1150
  # <note markdown="1"> In the future, new attributes might be added. If you write code that
@@ -1118,10 +1157,10 @@ module Aws::SQS
1118
1157
  #
1119
1158
  # The `ApproximateNumberOfMessagesDelayed`,
1120
1159
  # `ApproximateNumberOfMessagesNotVisible`, and
1121
- # `ApproximateNumberOfMessagesVisible` metrics may not achieve
1122
- # consistency until at least 1 minute after the producers stop sending
1123
- # messages. This period is required for the queue metadata to reach
1124
- # eventual consistency.
1160
+ # `ApproximateNumberOfMessages` metrics may not achieve consistency
1161
+ # until at least 1 minute after the producers stop sending messages.
1162
+ # This period is required for the queue metadata to reach eventual
1163
+ # consistency.
1125
1164
  #
1126
1165
  # * `All` – Returns all values.
1127
1166
  #
@@ -1151,7 +1190,14 @@ module Aws::SQS
1151
1190
  # can contain before Amazon SQS rejects it.
1152
1191
  #
1153
1192
  # * `MessageRetentionPeriod` – Returns the length of time, in seconds,
1154
- # for which Amazon SQS retains a message.
1193
+ # for which Amazon SQS retains a message. When you change a queue's
1194
+ # attributes, the change can take up to 60 seconds for most of the
1195
+ # attributes to propagate throughout the Amazon SQS system. Changes
1196
+ # made to the `MessageRetentionPeriod` attribute can take up to 15
1197
+ # minutes and will impact existing messages in the queue potentially
1198
+ # causing them to be expired and deleted if the
1199
+ # `MessageRetentionPeriod` is reduced below the age of existing
1200
+ # messages.
1155
1201
  #
1156
1202
  # * `Policy` – Returns the policy of the queue.
1157
1203
  #
@@ -1161,26 +1207,60 @@ module Aws::SQS
1161
1207
  # seconds, for which the `ReceiveMessage` action waits for a message
1162
1208
  # to arrive.
1163
1209
  #
1210
+ # * `VisibilityTimeout` – Returns the visibility timeout for the queue.
1211
+ # For more information about the visibility timeout, see [Visibility
1212
+ # Timeout][2] in the *Amazon SQS Developer Guide*.
1213
+ #
1214
+ # The following attributes apply only to [dead-letter queues:][3]
1215
+ #
1164
1216
  # * `RedrivePolicy` – The string that includes the parameters for the
1165
1217
  # dead-letter queue functionality of the source queue as a JSON
1166
- # object. For more information about the redrive policy and
1167
- # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
1168
- # the *Amazon SQS Developer Guide*.
1218
+ # object. The parameters are as follows:
1169
1219
  #
1170
1220
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
1171
1221
  # dead-letter queue to which Amazon SQS moves messages after the
1172
1222
  # value of `maxReceiveCount` is exceeded.
1173
1223
  #
1174
1224
  # * `maxReceiveCount` – The number of times a message is delivered to
1175
- # the source queue before being moved to the dead-letter queue. When
1176
- # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
1177
- # a queue, Amazon SQS moves the message to the dead-letter-queue.
1225
+ # the source queue before being moved to the dead-letter queue.
1226
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
1227
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
1228
+ # dead-letter-queue.
1229
+ #
1230
+ # * `RedriveAllowPolicy` – The string that includes the parameters for
1231
+ # the permissions for the dead-letter queue redrive permission and
1232
+ # which source queues can specify dead-letter queues as a JSON object.
1233
+ # The parameters are as follows:
1234
+ #
1235
+ # * `redrivePermission` – The permission type that defines which
1236
+ # source queues can specify the current queue as the dead-letter
1237
+ # queue. Valid values are:
1238
+ #
1239
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
1240
+ # Services account in the same Region can specify this queue as
1241
+ # the dead-letter queue.
1242
+ #
1243
+ # * `denyAll` – No source queues can specify this queue as the
1244
+ # dead-letter queue.
1245
+ #
1246
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
1247
+ # parameter can specify this queue as the dead-letter queue.
1248
+ #
1249
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
1250
+ # queues that can specify this queue as the dead-letter queue and
1251
+ # redrive messages. You can specify this parameter only when the
1252
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
1253
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
1254
+ # specify dead-letter queues, set the `redrivePermission` parameter
1255
+ # to `allowAll`.
1256
+ #
1257
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
1258
+ # Similarly, the dead-letter queue of a standard queue must also be a
1259
+ # standard queue.
1178
1260
  #
1179
- # * `VisibilityTimeout` – Returns the visibility timeout for the queue.
1180
- # For more information about the visibility timeout, see [Visibility
1181
- # Timeout][3] in the *Amazon SQS Developer Guide*.
1261
+ # </note>
1182
1262
  #
1183
- # The following attributes apply only to [server-side-encryption][4]\:
1263
+ # The following attributes apply only to [server-side-encryption][4]:
1184
1264
  #
1185
1265
  # * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services managed
1186
1266
  # customer master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -1193,11 +1273,11 @@ module Aws::SQS
1193
1273
  #
1194
1274
  # * `SqsManagedSseEnabled` – Returns information about whether the queue
1195
1275
  # is using SSE-SQS encryption using SQS owned encryption keys. Only
1196
- # one server-side encryption option is supported per queue (e.g.
1197
- # [SSE-KMS][7] or [SSE-SQS][8]).
1276
+ # one server-side encryption option is supported per queue (for
1277
+ # example, [SSE-KMS][7] or [SSE-SQS][8]).
1198
1278
  #
1199
1279
  # The following attributes apply only to [FIFO (first-in-first-out)
1200
- # queues][9]\:
1280
+ # queues][9]:
1201
1281
  #
1202
1282
  # * `FifoQueue` – Returns information about whether the queue is FIFO.
1203
1283
  # For more information, see [FIFO queue logic][10] in the *Amazon SQS
@@ -1213,7 +1293,7 @@ module Aws::SQS
1213
1293
  # [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
1214
1294
  #
1215
1295
  # The following attributes apply only to [high throughput for FIFO
1216
- # queues][12]\:
1296
+ # queues][12]:
1217
1297
  #
1218
1298
  # * `DeduplicationScope` – Specifies whether message deduplication
1219
1299
  # occurs at the message group or queue level. Valid values are
@@ -1241,8 +1321,8 @@ module Aws::SQS
1241
1321
  #
1242
1322
  #
1243
1323
  # [1]: http://en.wikipedia.org/wiki/Unix_time
1244
- # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
1245
- # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1324
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1325
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
1246
1326
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
1247
1327
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
1248
1328
  # [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
@@ -1394,8 +1474,8 @@ module Aws::SQS
1394
1474
  # *Amazon SQS Developer Guide*.
1395
1475
  #
1396
1476
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1397
- # information, see [Grant cross-account permissions to a role and a user
1398
- # name][2] in the *Amazon SQS Developer Guide*.
1477
+ # information, see [Grant cross-account permissions to a role and a
1478
+ # username][2] in the *Amazon SQS Developer Guide*.
1399
1479
  #
1400
1480
  # </note>
1401
1481
  #
@@ -1445,8 +1525,8 @@ module Aws::SQS
1445
1525
  # request to `listQueues` to receive the next page of results.
1446
1526
  #
1447
1527
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1448
- # information, see [Grant cross-account permissions to a role and a user
1449
- # name][1] in the *Amazon SQS Developer Guide*.
1528
+ # information, see [Grant cross-account permissions to a role and a
1529
+ # username][1] in the *Amazon SQS Developer Guide*.
1450
1530
  #
1451
1531
  # </note>
1452
1532
  #
@@ -1614,7 +1694,7 @@ module Aws::SQS
1614
1694
  #
1615
1695
  # * `SenderId`
1616
1696
  #
1617
- # * For an IAM user, returns the IAM user ID, for example
1697
+ # * For a user, returns the user ID, for example
1618
1698
  # `ABCDEFGHI1JKLMNOPQ23R`.
1619
1699
  #
1620
1700
  # * For an IAM role, returns the IAM role ID, for example
@@ -1625,7 +1705,7 @@ module Aws::SQS
1625
1705
  #
1626
1706
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
1627
1707
  # SQS owned encryption keys. Only one server-side encryption option is
1628
- # supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
1708
+ # supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
1629
1709
  #
1630
1710
  # * `MessageDeduplicationId` – Returns the value provided by the
1631
1711
  # producer that calls the ` SendMessage ` action.
@@ -1808,7 +1888,7 @@ module Aws::SQS
1808
1888
  #
1809
1889
  # * Cross-account permissions don't apply to this action. For more
1810
1890
  # information, see [Grant cross-account permissions to a role and a
1811
- # user name][1] in the *Amazon SQS Developer Guide*.
1891
+ # username][1] in the *Amazon SQS Developer Guide*.
1812
1892
  #
1813
1893
  # * To remove the ability to change queue permissions, you must deny
1814
1894
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -1869,7 +1949,7 @@ module Aws::SQS
1869
1949
  #
1870
1950
  # @option params [required, String] :message_body
1871
1951
  # The message to send. The minimum size is one character. The maximum
1872
- # size is 256 KB.
1952
+ # size is 256 KiB.
1873
1953
  #
1874
1954
  # A message can include only XML, JSON, and unformatted text. The
1875
1955
  # following Unicode characters are allowed:
@@ -2064,7 +2144,9 @@ module Aws::SQS
2064
2144
  req.send_request(options)
2065
2145
  end
2066
2146
 
2067
- # Delivers up to ten messages to the specified queue. This is a batch
2147
+ # You can use `SendMessageBatch` to send up to 10 messages to the
2148
+ # specified queue by assigning either identical or different values to
2149
+ # each message (or by not assigning values at all). This is a batch
2068
2150
  # version of ` SendMessage.` For a FIFO queue, multiple messages within
2069
2151
  # a single batch are enqueued in the order they are sent.
2070
2152
  #
@@ -2075,7 +2157,7 @@ module Aws::SQS
2075
2157
  #
2076
2158
  # The maximum allowed individual message size and the maximum total
2077
2159
  # payload size (the sum of the individual lengths of all of the batched
2078
- # messages) are both 256 KB (262,144 bytes).
2160
+ # messages) are both 256 KiB (262,144 bytes).
2079
2161
  #
2080
2162
  # A message can include only XML, JSON, and unformatted text. The
2081
2163
  # following Unicode characters are allowed:
@@ -2089,14 +2171,6 @@ module Aws::SQS
2089
2171
  # If you don't specify the `DelaySeconds` parameter for an entry,
2090
2172
  # Amazon SQS uses the default value for the queue.
2091
2173
  #
2092
- # Some actions take lists of parameters. These lists are specified using
2093
- # the `param.n` notation. Values of `n` are integers starting from 1.
2094
- # For example, a parameter list with two elements looks like this:
2095
- #
2096
- # `&AttributeName.1=first`
2097
- #
2098
- # `&AttributeName.2=second`
2099
- #
2100
2174
  #
2101
2175
  #
2102
2176
  # [1]: http://www.w3.org/TR/REC-xml/#charsets
@@ -2175,7 +2249,9 @@ module Aws::SQS
2175
2249
  # queue's attributes, the change can take up to 60 seconds for most of
2176
2250
  # the attributes to propagate throughout the Amazon SQS system. Changes
2177
2251
  # made to the `MessageRetentionPeriod` attribute can take up to 15
2178
- # minutes.
2252
+ # minutes and will impact existing messages in the queue potentially
2253
+ # causing them to be expired and deleted if the `MessageRetentionPeriod`
2254
+ # is reduced below the age of existing messages.
2179
2255
  #
2180
2256
  # <note markdown="1"> * In the future, new attributes might be added. If you write code that
2181
2257
  # calls this action, we recommend that you structure your code so that
@@ -2183,7 +2259,7 @@ module Aws::SQS
2183
2259
  #
2184
2260
  # * Cross-account permissions don't apply to this action. For more
2185
2261
  # information, see [Grant cross-account permissions to a role and a
2186
- # user name][1] in the *Amazon SQS Developer Guide*.
2262
+ # username][1] in the *Amazon SQS Developer Guide*.
2187
2263
  #
2188
2264
  # * To remove the ability to change queue permissions, you must deny
2189
2265
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -2218,7 +2294,13 @@ module Aws::SQS
2218
2294
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
2219
2295
  # Amazon SQS retains a message. Valid values: An integer representing
2220
2296
  # seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
2221
- # (4 days).
2297
+ # (4 days). When you change a queue's attributes, the change can take
2298
+ # up to 60 seconds for most of the attributes to propagate throughout
2299
+ # the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
2300
+ # attribute can take up to 15 minutes and will impact existing
2301
+ # messages in the queue potentially causing them to be expired and
2302
+ # deleted if the `MessageRetentionPeriod` is reduced below the age of
2303
+ # existing messages.
2222
2304
  #
2223
2305
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
2224
2306
  # For more information about policy structure, see [Overview of Amazon
@@ -2229,33 +2311,61 @@ module Aws::SQS
2229
2311
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
2230
2312
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
2231
2313
  #
2314
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
2315
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2316
+ # Default: 30. For more information about the visibility timeout, see
2317
+ # [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
2318
+ #
2319
+ # The following attributes apply only to [dead-letter queues:][3]
2320
+ #
2232
2321
  # * `RedrivePolicy` – The string that includes the parameters for the
2233
2322
  # dead-letter queue functionality of the source queue as a JSON
2234
- # object. For more information about the redrive policy and
2235
- # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
2236
- # the *Amazon SQS Developer Guide*.
2323
+ # object. The parameters are as follows:
2237
2324
  #
2238
2325
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2239
2326
  # dead-letter queue to which Amazon SQS moves messages after the
2240
2327
  # value of `maxReceiveCount` is exceeded.
2241
2328
  #
2242
2329
  # * `maxReceiveCount` – The number of times a message is delivered to
2243
- # the source queue before being moved to the dead-letter queue. When
2244
- # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
2245
- # a queue, Amazon SQS moves the message to the dead-letter-queue.
2330
+ # the source queue before being moved to the dead-letter queue.
2331
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
2332
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
2333
+ # dead-letter-queue.
2334
+ #
2335
+ # * `RedriveAllowPolicy` – The string that includes the parameters for
2336
+ # the permissions for the dead-letter queue redrive permission and
2337
+ # which source queues can specify dead-letter queues as a JSON object.
2338
+ # The parameters are as follows:
2339
+ #
2340
+ # * `redrivePermission` – The permission type that defines which
2341
+ # source queues can specify the current queue as the dead-letter
2342
+ # queue. Valid values are:
2343
+ #
2344
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
2345
+ # Services account in the same Region can specify this queue as
2346
+ # the dead-letter queue.
2347
+ #
2348
+ # * `denyAll` – No source queues can specify this queue as the
2349
+ # dead-letter queue.
2350
+ #
2351
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
2352
+ # parameter can specify this queue as the dead-letter queue.
2353
+ #
2354
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
2355
+ # queues that can specify this queue as the dead-letter queue and
2356
+ # redrive messages. You can specify this parameter only when the
2357
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
2358
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
2359
+ # specify dead-letter queues, set the `redrivePermission` parameter
2360
+ # to `allowAll`.
2361
+ #
2362
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
2363
+ # Similarly, the dead-letter queue of a standard queue must also be a
2364
+ # standard queue.
2246
2365
  #
2247
- # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
2248
- # Similarly, the dead-letter queue of a standard queue must also be a
2249
- # standard queue.
2250
- #
2251
- # </note>
2252
- #
2253
- # * `VisibilityTimeout` – The visibility timeout for the queue, in
2254
- # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2255
- # Default: 30. For more information about the visibility timeout, see
2256
- # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
2366
+ # </note>
2257
2367
  #
2258
- # The following attributes apply only to [server-side-encryption][4]\:
2368
+ # The following attributes apply only to [server-side-encryption][4]:
2259
2369
  #
2260
2370
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
2261
2371
  # master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -2275,10 +2385,10 @@ module Aws::SQS
2275
2385
  #
2276
2386
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
2277
2387
  # SQS owned encryption keys. Only one server-side encryption option is
2278
- # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
2388
+ # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
2279
2389
  #
2280
2390
  # The following attribute applies only to [FIFO (first-in-first-out)
2281
- # queues][11]\:
2391
+ # queues][11]:
2282
2392
  #
2283
2393
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
2284
2394
  # For more information, see [Exactly-once processing][12] in the
@@ -2313,7 +2423,7 @@ module Aws::SQS
2313
2423
  # duplicates and only one copy of the message is delivered.
2314
2424
  #
2315
2425
  # The following attributes apply only to [high throughput for FIFO
2316
- # queues][13]\:
2426
+ # queues][13]:
2317
2427
  #
2318
2428
  # * `DeduplicationScope` – Specifies whether message deduplication
2319
2429
  # occurs at the message group or queue level. Valid values are
@@ -2341,8 +2451,8 @@ module Aws::SQS
2341
2451
  #
2342
2452
  #
2343
2453
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
2344
- # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
2345
- # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
2454
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
2455
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
2346
2456
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
2347
2457
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
2348
2458
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -2395,8 +2505,8 @@ module Aws::SQS
2395
2505
  # in the *Amazon SQS Developer Guide*.
2396
2506
  #
2397
2507
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
2398
- # information, see [Grant cross-account permissions to a role and a user
2399
- # name][3] in the *Amazon SQS Developer Guide*.
2508
+ # information, see [Grant cross-account permissions to a role and a
2509
+ # username][3] in the *Amazon SQS Developer Guide*.
2400
2510
  #
2401
2511
  # </note>
2402
2512
  #
@@ -2437,8 +2547,8 @@ module Aws::SQS
2437
2547
  # SQS Developer Guide*.
2438
2548
  #
2439
2549
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
2440
- # information, see [Grant cross-account permissions to a role and a user
2441
- # name][2] in the *Amazon SQS Developer Guide*.
2550
+ # information, see [Grant cross-account permissions to a role and a
2551
+ # username][2] in the *Amazon SQS Developer Guide*.
2442
2552
  #
2443
2553
  # </note>
2444
2554
  #
@@ -2484,7 +2594,7 @@ module Aws::SQS
2484
2594
  params: params,
2485
2595
  config: config)
2486
2596
  context[:gem_name] = 'aws-sdk-sqs'
2487
- context[:gem_version] = '1.50.0'
2597
+ context[:gem_version] = '1.54.0'
2488
2598
  Seahorse::Client::Request.new(handlers, context)
2489
2599
  end
2490
2600