aws-sdk-sqs 1.54.0 → 1.56.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.
@@ -31,7 +31,7 @@ require 'aws-sdk-core/plugins/checksum_algorithm.rb'
31
31
  require 'aws-sdk-core/plugins/defaults_mode.rb'
32
32
  require 'aws-sdk-core/plugins/recursion_detection.rb'
33
33
  require 'aws-sdk-core/plugins/sign.rb'
34
- require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
34
+ require 'aws-sdk-core/plugins/protocols/query.rb'
35
35
  require 'aws-sdk-sqs/plugins/queue_urls.rb'
36
36
  require 'aws-sdk-sqs/plugins/md5s.rb'
37
37
 
@@ -82,7 +82,7 @@ module Aws::SQS
82
82
  add_plugin(Aws::Plugins::DefaultsMode)
83
83
  add_plugin(Aws::Plugins::RecursionDetection)
84
84
  add_plugin(Aws::Plugins::Sign)
85
- add_plugin(Aws::Plugins::Protocols::JsonRpc)
85
+ add_plugin(Aws::Plugins::Protocols::Query)
86
86
  add_plugin(Aws::SQS::Plugins::QueueUrls)
87
87
  add_plugin(Aws::SQS::Plugins::Md5s)
88
88
  add_plugin(Aws::SQS::Plugins::Endpoints)
@@ -279,20 +279,15 @@ module Aws::SQS
279
279
  # in the future.
280
280
  #
281
281
  #
282
+ # @option options [String] :sdk_ua_app_id
283
+ # A unique and opaque application ID that is appended to the
284
+ # User-Agent header as app/<sdk_ua_app_id>. It should have a
285
+ # maximum length of 50.
286
+ #
282
287
  # @option options [String] :secret_access_key
283
288
  #
284
289
  # @option options [String] :session_token
285
290
  #
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
- #
296
291
  # @option options [Boolean] :stub_responses (false)
297
292
  # Causes the client to return stubbed responses. By default
298
293
  # fake responses are generated and returned. You can specify
@@ -402,21 +397,25 @@ module Aws::SQS
402
397
  # see [Using Custom Policies with the Amazon SQS Access Policy
403
398
  # Language][3] in the *Amazon SQS Developer Guide*.
404
399
  #
405
- # * An Amazon SQS policy can have a maximum of seven actions per
406
- # statement.
400
+ # * An Amazon SQS policy can have a maximum of 7 actions.
407
401
  #
408
402
  # * To remove the ability to change queue permissions, you must deny
409
403
  # permission to the `AddPermission`, `RemovePermission`, and
410
404
  # `SetQueueAttributes` actions in your IAM policy.
411
405
  #
412
- # * Amazon SQS `AddPermission` does not support adding a non-account
413
- # principal.
414
- #
415
406
  # </note>
416
407
  #
408
+ # Some actions take lists of parameters. These lists are specified using
409
+ # the `param.n` notation. Values of `n` are integers starting from 1.
410
+ # For example, a parameter list with two elements looks like this:
411
+ #
412
+ # `&AttributeName.1=first`
413
+ #
414
+ # `&AttributeName.2=second`
415
+ #
417
416
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
418
- # information, see [Grant cross-account permissions to a role and a
419
- # username][4] in the *Amazon SQS Developer Guide*.
417
+ # information, see [Grant cross-account permissions to a role and a user
418
+ # name][4] in the *Amazon SQS Developer Guide*.
420
419
  #
421
420
  # </note>
422
421
  #
@@ -493,14 +492,12 @@ module Aws::SQS
493
492
  # information, see [Visibility Timeout][1] in the *Amazon SQS Developer
494
493
  # Guide*.
495
494
  #
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.
495
+ # For example, you have a message with a visibility timeout of 5
496
+ # minutes. After 3 minutes, you call `ChangeMessageVisibility` with a
497
+ # timeout of 10 minutes. You can continue to call
498
+ # `ChangeMessageVisibility` to extend the visibility timeout to the
499
+ # maximum allowed time. If you try to extend the visibility timeout
500
+ # beyond the maximum, your request is rejected.
504
501
  #
505
502
  # An Amazon SQS message has three basic states:
506
503
  #
@@ -516,13 +513,13 @@ module Aws::SQS
516
513
  # messages. A message is considered to be *in flight* after it is
517
514
  # received from a queue by a consumer, but not yet deleted from the
518
515
  # queue (that is, between states 2 and 3). There is a limit to the
519
- # number of in flight messages.
516
+ # number of inflight messages.
520
517
  #
521
- # Limits that apply to in flight messages are unrelated to the
518
+ # Limits that apply to inflight messages are unrelated to the
522
519
  # *unlimited* number of stored messages.
523
520
  #
524
521
  # For most standard queues (depending on queue traffic and message
525
- # backlog), there can be a maximum of approximately 120,000 in flight
522
+ # backlog), there can be a maximum of approximately 120,000 inflight
526
523
  # messages (received from a queue by a consumer, but not yet deleted
527
524
  # from the queue). If you reach this limit, Amazon SQS returns the
528
525
  # `OverLimit` error message. To avoid reaching the limit, you should
@@ -530,7 +527,7 @@ module Aws::SQS
530
527
  # increase the number of queues you use to process your messages. To
531
528
  # request a limit increase, [file a support request][2].
532
529
  #
533
- # For FIFO queues, there can be a maximum of 20,000 in flight messages
530
+ # For FIFO queues, there can be a maximum of 20,000 inflight messages
534
531
  # (received from a queue by a consumer, but not yet deleted from the
535
532
  # queue). If you reach this limit, Amazon SQS returns no error messages.
536
533
  #
@@ -596,6 +593,14 @@ module Aws::SQS
596
593
  # and unsuccessful actions, you should check for batch errors even when
597
594
  # the call returns an HTTP status code of `200`.
598
595
  #
596
+ # Some actions take lists of parameters. These lists are specified using
597
+ # the `param.n` notation. Values of `n` are integers starting from 1.
598
+ # For example, a parameter list with two elements looks like this:
599
+ #
600
+ # `&AttributeName.1=first`
601
+ #
602
+ # `&AttributeName.2=second`
603
+ #
599
604
  # @option params [required, String] :queue_url
600
605
  # The URL of the Amazon SQS queue whose messages' visibility is
601
606
  # changed.
@@ -684,9 +689,17 @@ module Aws::SQS
684
689
  # * If the queue name, attribute names, or attribute values don't match
685
690
  # an existing queue, `CreateQueue` returns an error.
686
691
  #
692
+ # Some actions take lists of parameters. These lists are specified using
693
+ # the `param.n` notation. Values of `n` are integers starting from 1.
694
+ # For example, a parameter list with two elements looks like this:
695
+ #
696
+ # `&AttributeName.1=first`
697
+ #
698
+ # `&AttributeName.2=second`
699
+ #
687
700
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
688
- # information, see [Grant cross-account permissions to a role and a
689
- # username][3] in the *Amazon SQS Developer Guide*.
701
+ # information, see [Grant cross-account permissions to a role and a user
702
+ # name][3] in the *Amazon SQS Developer Guide*.
690
703
  #
691
704
  # </note>
692
705
  #
@@ -726,75 +739,41 @@ module Aws::SQS
726
739
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
727
740
  # Amazon SQS retains a message. Valid values: An integer from 60
728
741
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
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.
742
+ # (4 days).
736
743
  #
737
744
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
738
745
  # For more information about policy structure, see [Overview of Amazon
739
- # Web Services IAM Policies][1] in the *IAM User Guide*.
746
+ # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
740
747
  #
741
748
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
742
749
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
743
750
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
744
751
  #
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
- #
752
752
  # * `RedrivePolicy` – The string that includes the parameters for the
753
753
  # dead-letter queue functionality of the source queue as a JSON
754
- # object. The parameters are as follows:
754
+ # object. For more information about the redrive policy and
755
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
756
+ # the *Amazon SQS Developer Guide*.
755
757
  #
756
758
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
757
759
  # dead-letter queue to which Amazon SQS moves messages after the
758
760
  # value of `maxReceiveCount` is exceeded.
759
761
  #
760
762
  # * `maxReceiveCount` – The number of times a message is delivered to
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.
763
+ # the source queue before being moved to the dead-letter queue. When
764
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
765
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
796
766
  #
797
- # </note>
767
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
768
+ # Similarly, the dead-letter queue of a standard queue must also be a
769
+ # standard queue.
770
+ #
771
+ # </note>
772
+ #
773
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
774
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
775
+ # Default: 30. For more information about the visibility timeout, see
776
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
798
777
  #
799
778
  # The following attributes apply only to [server-side-encryption][4]:
800
779
  #
@@ -813,11 +792,11 @@ module Aws::SQS
813
792
  # Default: 300 (5 minutes). A shorter time period provides better
814
793
  # security but results in more calls to KMS which might incur charges
815
794
  # after Free Tier. For more information, see [How Does the Data Key
816
- # Reuse Period Work?][8]
795
+ # Reuse Period Work?][8].
817
796
  #
818
797
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
819
798
  # SQS owned encryption keys. Only one server-side encryption option is
820
- # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
799
+ # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
821
800
  #
822
801
  # The following attributes apply only to [FIFO (first-in-first-out)
823
802
  # queues][11]:
@@ -894,8 +873,8 @@ module Aws::SQS
894
873
  #
895
874
  #
896
875
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.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
876
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
877
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
899
878
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
900
879
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
901
880
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -933,8 +912,8 @@ module Aws::SQS
933
912
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
934
913
  #
935
914
  # Cross-account permissions don't apply to this action. For more
936
- # information, see [Grant cross-account permissions to a role and a
937
- # username][3] in the *Amazon SQS Developer Guide*.
915
+ # information, see [Grant cross-account permissions to a role and a user
916
+ # name][3] in the *Amazon SQS Developer Guide*.
938
917
  #
939
918
  # </note>
940
919
  #
@@ -986,7 +965,7 @@ module Aws::SQS
986
965
  # `ReceiptHandle` is different each time you receive a message. When you
987
966
  # use the `DeleteMessage` action, you must provide the most recently
988
967
  # received `ReceiptHandle` for the message (otherwise, the request
989
- # succeeds, but the message will not be deleted).
968
+ # succeeds, but the message might not be deleted).
990
969
  #
991
970
  # For standard queues, it is possible to receive a message even after
992
971
  # you delete it. This might happen on rare occasions if one of the
@@ -1032,6 +1011,14 @@ module Aws::SQS
1032
1011
  # and unsuccessful actions, you should check for batch errors even when
1033
1012
  # the call returns an HTTP status code of `200`.
1034
1013
  #
1014
+ # Some actions take lists of parameters. These lists are specified using
1015
+ # the `param.n` notation. Values of `n` are integers starting from 1.
1016
+ # For example, a parameter list with two elements looks like this:
1017
+ #
1018
+ # `&AttributeName.1=first`
1019
+ #
1020
+ # `&AttributeName.2=second`
1021
+ #
1035
1022
  # @option params [required, String] :queue_url
1036
1023
  # The URL of the Amazon SQS queue from which messages are deleted.
1037
1024
  #
@@ -1091,10 +1078,8 @@ module Aws::SQS
1091
1078
  # creating a queue with the same name.
1092
1079
  #
1093
1080
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
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.
1081
+ # information, see [Grant cross-account permissions to a role and a user
1082
+ # name][1] in the *Amazon SQS Developer Guide*.
1098
1083
  #
1099
1084
  # </note>
1100
1085
  #
@@ -1144,7 +1129,7 @@ module Aws::SQS
1144
1129
  # @option params [Array<String>] :attribute_names
1145
1130
  # A list of attributes for which to retrieve information.
1146
1131
  #
1147
- # The `AttributeNames` parameter is optional, but if you don't specify
1132
+ # The `AttributeName.N` parameter is optional, but if you don't specify
1148
1133
  # values for this parameter, the request returns empty results.
1149
1134
  #
1150
1135
  # <note markdown="1"> In the future, new attributes might be added. If you write code that
@@ -1157,10 +1142,10 @@ module Aws::SQS
1157
1142
  #
1158
1143
  # The `ApproximateNumberOfMessagesDelayed`,
1159
1144
  # `ApproximateNumberOfMessagesNotVisible`, and
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.
1145
+ # `ApproximateNumberOfMessagesVisible` metrics may not achieve
1146
+ # consistency until at least 1 minute after the producers stop sending
1147
+ # messages. This period is required for the queue metadata to reach
1148
+ # eventual consistency.
1164
1149
  #
1165
1150
  # * `All` – Returns all values.
1166
1151
  #
@@ -1190,14 +1175,7 @@ module Aws::SQS
1190
1175
  # can contain before Amazon SQS rejects it.
1191
1176
  #
1192
1177
  # * `MessageRetentionPeriod` – Returns the length of time, in seconds,
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.
1178
+ # for which Amazon SQS retains a message.
1201
1179
  #
1202
1180
  # * `Policy` – Returns the policy of the queue.
1203
1181
  #
@@ -1207,58 +1185,24 @@ module Aws::SQS
1207
1185
  # seconds, for which the `ReceiveMessage` action waits for a message
1208
1186
  # to arrive.
1209
1187
  #
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
- #
1216
1188
  # * `RedrivePolicy` – The string that includes the parameters for the
1217
1189
  # dead-letter queue functionality of the source queue as a JSON
1218
- # object. The parameters are as follows:
1190
+ # object. For more information about the redrive policy and
1191
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
1192
+ # the *Amazon SQS Developer Guide*.
1219
1193
  #
1220
1194
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
1221
1195
  # dead-letter queue to which Amazon SQS moves messages after the
1222
1196
  # value of `maxReceiveCount` is exceeded.
1223
1197
  #
1224
1198
  # * `maxReceiveCount` – The number of times a message is delivered to
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.
1199
+ # the source queue before being moved to the dead-letter queue. When
1200
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
1201
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
1260
1202
  #
1261
- # </note>
1203
+ # * `VisibilityTimeout` – Returns the visibility timeout for the queue.
1204
+ # For more information about the visibility timeout, see [Visibility
1205
+ # Timeout][3] in the *Amazon SQS Developer Guide*.
1262
1206
  #
1263
1207
  # The following attributes apply only to [server-side-encryption][4]:
1264
1208
  #
@@ -1273,8 +1217,8 @@ module Aws::SQS
1273
1217
  #
1274
1218
  # * `SqsManagedSseEnabled` – Returns information about whether the queue
1275
1219
  # is using SSE-SQS encryption using SQS owned encryption keys. Only
1276
- # one server-side encryption option is supported per queue (for
1277
- # example, [SSE-KMS][7] or [SSE-SQS][8]).
1220
+ # one server-side encryption option is supported per queue (e.g.
1221
+ # [SSE-KMS][7] or [SSE-SQS][8]).
1278
1222
  #
1279
1223
  # The following attributes apply only to [FIFO (first-in-first-out)
1280
1224
  # queues][9]:
@@ -1321,8 +1265,8 @@ module Aws::SQS
1321
1265
  #
1322
1266
  #
1323
1267
  # [1]: http://en.wikipedia.org/wiki/Unix_time
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
1268
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
1269
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1326
1270
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
1327
1271
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
1328
1272
  # [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
@@ -1474,8 +1418,8 @@ module Aws::SQS
1474
1418
  # *Amazon SQS Developer Guide*.
1475
1419
  #
1476
1420
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1477
- # information, see [Grant cross-account permissions to a role and a
1478
- # username][2] in the *Amazon SQS Developer Guide*.
1421
+ # information, see [Grant cross-account permissions to a role and a user
1422
+ # name][2] in the *Amazon SQS Developer Guide*.
1479
1423
  #
1480
1424
  # </note>
1481
1425
  #
@@ -1525,8 +1469,8 @@ module Aws::SQS
1525
1469
  # request to `listQueues` to receive the next page of results.
1526
1470
  #
1527
1471
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1528
- # information, see [Grant cross-account permissions to a role and a
1529
- # username][1] in the *Amazon SQS Developer Guide*.
1472
+ # information, see [Grant cross-account permissions to a role and a user
1473
+ # name][1] in the *Amazon SQS Developer Guide*.
1530
1474
  #
1531
1475
  # </note>
1532
1476
  #
@@ -1694,7 +1638,7 @@ module Aws::SQS
1694
1638
  #
1695
1639
  # * `SenderId`
1696
1640
  #
1697
- # * For a user, returns the user ID, for example
1641
+ # * For an IAM user, returns the IAM user ID, for example
1698
1642
  # `ABCDEFGHI1JKLMNOPQ23R`.
1699
1643
  #
1700
1644
  # * For an IAM role, returns the IAM role ID, for example
@@ -1705,7 +1649,7 @@ module Aws::SQS
1705
1649
  #
1706
1650
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
1707
1651
  # SQS owned encryption keys. Only one server-side encryption option is
1708
- # supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
1652
+ # supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
1709
1653
  #
1710
1654
  # * `MessageDeduplicationId` – Returns the value provided by the
1711
1655
  # producer that calls the ` SendMessage ` action.
@@ -1888,7 +1832,7 @@ module Aws::SQS
1888
1832
  #
1889
1833
  # * Cross-account permissions don't apply to this action. For more
1890
1834
  # information, see [Grant cross-account permissions to a role and a
1891
- # username][1] in the *Amazon SQS Developer Guide*.
1835
+ # user name][1] in the *Amazon SQS Developer Guide*.
1892
1836
  #
1893
1837
  # * To remove the ability to change queue permissions, you must deny
1894
1838
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -1949,7 +1893,7 @@ module Aws::SQS
1949
1893
  #
1950
1894
  # @option params [required, String] :message_body
1951
1895
  # The message to send. The minimum size is one character. The maximum
1952
- # size is 256 KiB.
1896
+ # size is 256 KB.
1953
1897
  #
1954
1898
  # A message can include only XML, JSON, and unformatted text. The
1955
1899
  # following Unicode characters are allowed:
@@ -2144,9 +2088,7 @@ module Aws::SQS
2144
2088
  req.send_request(options)
2145
2089
  end
2146
2090
 
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
2091
+ # Delivers up to ten messages to the specified queue. This is a batch
2150
2092
  # version of ` SendMessage.` For a FIFO queue, multiple messages within
2151
2093
  # a single batch are enqueued in the order they are sent.
2152
2094
  #
@@ -2157,7 +2099,7 @@ module Aws::SQS
2157
2099
  #
2158
2100
  # The maximum allowed individual message size and the maximum total
2159
2101
  # payload size (the sum of the individual lengths of all of the batched
2160
- # messages) are both 256 KiB (262,144 bytes).
2102
+ # messages) are both 256 KB (262,144 bytes).
2161
2103
  #
2162
2104
  # A message can include only XML, JSON, and unformatted text. The
2163
2105
  # following Unicode characters are allowed:
@@ -2171,6 +2113,14 @@ module Aws::SQS
2171
2113
  # If you don't specify the `DelaySeconds` parameter for an entry,
2172
2114
  # Amazon SQS uses the default value for the queue.
2173
2115
  #
2116
+ # Some actions take lists of parameters. These lists are specified using
2117
+ # the `param.n` notation. Values of `n` are integers starting from 1.
2118
+ # For example, a parameter list with two elements looks like this:
2119
+ #
2120
+ # `&AttributeName.1=first`
2121
+ #
2122
+ # `&AttributeName.2=second`
2123
+ #
2174
2124
  #
2175
2125
  #
2176
2126
  # [1]: http://www.w3.org/TR/REC-xml/#charsets
@@ -2249,9 +2199,7 @@ module Aws::SQS
2249
2199
  # queue's attributes, the change can take up to 60 seconds for most of
2250
2200
  # the attributes to propagate throughout the Amazon SQS system. Changes
2251
2201
  # made to the `MessageRetentionPeriod` attribute can take up to 15
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.
2202
+ # minutes.
2255
2203
  #
2256
2204
  # <note markdown="1"> * In the future, new attributes might be added. If you write code that
2257
2205
  # calls this action, we recommend that you structure your code so that
@@ -2259,7 +2207,7 @@ module Aws::SQS
2259
2207
  #
2260
2208
  # * Cross-account permissions don't apply to this action. For more
2261
2209
  # information, see [Grant cross-account permissions to a role and a
2262
- # username][1] in the *Amazon SQS Developer Guide*.
2210
+ # user name][1] in the *Amazon SQS Developer Guide*.
2263
2211
  #
2264
2212
  # * To remove the ability to change queue permissions, you must deny
2265
2213
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -2294,13 +2242,7 @@ module Aws::SQS
2294
2242
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
2295
2243
  # Amazon SQS retains a message. Valid values: An integer representing
2296
2244
  # seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
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.
2245
+ # (4 days).
2304
2246
  #
2305
2247
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
2306
2248
  # For more information about policy structure, see [Overview of Amazon
@@ -2311,59 +2253,31 @@ module Aws::SQS
2311
2253
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
2312
2254
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
2313
2255
  #
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
- #
2321
2256
  # * `RedrivePolicy` – The string that includes the parameters for the
2322
2257
  # dead-letter queue functionality of the source queue as a JSON
2323
- # object. The parameters are as follows:
2258
+ # object. For more information about the redrive policy and
2259
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
2260
+ # the *Amazon SQS Developer Guide*.
2324
2261
  #
2325
2262
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2326
2263
  # dead-letter queue to which Amazon SQS moves messages after the
2327
2264
  # value of `maxReceiveCount` is exceeded.
2328
2265
  #
2329
2266
  # * `maxReceiveCount` – The number of times a message is delivered to
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.
2267
+ # the source queue before being moved to the dead-letter queue. When
2268
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
2269
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
2365
2270
  #
2366
- # </note>
2271
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
2272
+ # Similarly, the dead-letter queue of a standard queue must also be a
2273
+ # standard queue.
2274
+ #
2275
+ # </note>
2276
+ #
2277
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
2278
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2279
+ # Default: 30. For more information about the visibility timeout, see
2280
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
2367
2281
  #
2368
2282
  # The following attributes apply only to [server-side-encryption][4]:
2369
2283
  #
@@ -2385,7 +2299,7 @@ module Aws::SQS
2385
2299
  #
2386
2300
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
2387
2301
  # SQS owned encryption keys. Only one server-side encryption option is
2388
- # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
2302
+ # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
2389
2303
  #
2390
2304
  # The following attribute applies only to [FIFO (first-in-first-out)
2391
2305
  # queues][11]:
@@ -2451,8 +2365,8 @@ module Aws::SQS
2451
2365
  #
2452
2366
  #
2453
2367
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.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
2368
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
2369
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
2456
2370
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
2457
2371
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
2458
2372
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -2505,8 +2419,8 @@ module Aws::SQS
2505
2419
  # in the *Amazon SQS Developer Guide*.
2506
2420
  #
2507
2421
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
2508
- # information, see [Grant cross-account permissions to a role and a
2509
- # username][3] in the *Amazon SQS Developer Guide*.
2422
+ # information, see [Grant cross-account permissions to a role and a user
2423
+ # name][3] in the *Amazon SQS Developer Guide*.
2510
2424
  #
2511
2425
  # </note>
2512
2426
  #
@@ -2547,8 +2461,8 @@ module Aws::SQS
2547
2461
  # SQS Developer Guide*.
2548
2462
  #
2549
2463
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
2550
- # information, see [Grant cross-account permissions to a role and a
2551
- # username][2] in the *Amazon SQS Developer Guide*.
2464
+ # information, see [Grant cross-account permissions to a role and a user
2465
+ # name][2] in the *Amazon SQS Developer Guide*.
2552
2466
  #
2553
2467
  # </note>
2554
2468
  #
@@ -2594,7 +2508,7 @@ module Aws::SQS
2594
2508
  params: params,
2595
2509
  config: config)
2596
2510
  context[:gem_name] = 'aws-sdk-sqs'
2597
- context[:gem_version] = '1.54.0'
2511
+ context[:gem_version] = '1.56.0'
2598
2512
  Seahorse::Client::Request.new(handlers, context)
2599
2513
  end
2600
2514