aws-sdk-sqs 1.54.0 → 1.55.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)
@@ -283,16 +283,6 @@ module Aws::SQS
283
283
  #
284
284
  # @option options [String] :session_token
285
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
- #
296
286
  # @option options [Boolean] :stub_responses (false)
297
287
  # Causes the client to return stubbed responses. By default
298
288
  # fake responses are generated and returned. You can specify
@@ -402,21 +392,25 @@ module Aws::SQS
402
392
  # see [Using Custom Policies with the Amazon SQS Access Policy
403
393
  # Language][3] in the *Amazon SQS Developer Guide*.
404
394
  #
405
- # * An Amazon SQS policy can have a maximum of seven actions per
406
- # statement.
395
+ # * An Amazon SQS policy can have a maximum of 7 actions.
407
396
  #
408
397
  # * To remove the ability to change queue permissions, you must deny
409
398
  # permission to the `AddPermission`, `RemovePermission`, and
410
399
  # `SetQueueAttributes` actions in your IAM policy.
411
400
  #
412
- # * Amazon SQS `AddPermission` does not support adding a non-account
413
- # principal.
414
- #
415
401
  # </note>
416
402
  #
403
+ # Some actions take lists of parameters. These lists are specified using
404
+ # the `param.n` notation. Values of `n` are integers starting from 1.
405
+ # For example, a parameter list with two elements looks like this:
406
+ #
407
+ # `&AttributeName.1=first`
408
+ #
409
+ # `&AttributeName.2=second`
410
+ #
417
411
  # <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*.
412
+ # information, see [Grant cross-account permissions to a role and a user
413
+ # name][4] in the *Amazon SQS Developer Guide*.
420
414
  #
421
415
  # </note>
422
416
  #
@@ -493,14 +487,12 @@ module Aws::SQS
493
487
  # information, see [Visibility Timeout][1] in the *Amazon SQS Developer
494
488
  # Guide*.
495
489
  #
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.
490
+ # For example, you have a message with a visibility timeout of 5
491
+ # minutes. After 3 minutes, you call `ChangeMessageVisibility` with a
492
+ # timeout of 10 minutes. You can continue to call
493
+ # `ChangeMessageVisibility` to extend the visibility timeout to the
494
+ # maximum allowed time. If you try to extend the visibility timeout
495
+ # beyond the maximum, your request is rejected.
504
496
  #
505
497
  # An Amazon SQS message has three basic states:
506
498
  #
@@ -516,13 +508,13 @@ module Aws::SQS
516
508
  # messages. A message is considered to be *in flight* after it is
517
509
  # received from a queue by a consumer, but not yet deleted from the
518
510
  # queue (that is, between states 2 and 3). There is a limit to the
519
- # number of in flight messages.
511
+ # number of inflight messages.
520
512
  #
521
- # Limits that apply to in flight messages are unrelated to the
513
+ # Limits that apply to inflight messages are unrelated to the
522
514
  # *unlimited* number of stored messages.
523
515
  #
524
516
  # For most standard queues (depending on queue traffic and message
525
- # backlog), there can be a maximum of approximately 120,000 in flight
517
+ # backlog), there can be a maximum of approximately 120,000 inflight
526
518
  # messages (received from a queue by a consumer, but not yet deleted
527
519
  # from the queue). If you reach this limit, Amazon SQS returns the
528
520
  # `OverLimit` error message. To avoid reaching the limit, you should
@@ -530,7 +522,7 @@ module Aws::SQS
530
522
  # increase the number of queues you use to process your messages. To
531
523
  # request a limit increase, [file a support request][2].
532
524
  #
533
- # For FIFO queues, there can be a maximum of 20,000 in flight messages
525
+ # For FIFO queues, there can be a maximum of 20,000 inflight messages
534
526
  # (received from a queue by a consumer, but not yet deleted from the
535
527
  # queue). If you reach this limit, Amazon SQS returns no error messages.
536
528
  #
@@ -596,6 +588,14 @@ module Aws::SQS
596
588
  # and unsuccessful actions, you should check for batch errors even when
597
589
  # the call returns an HTTP status code of `200`.
598
590
  #
591
+ # Some actions take lists of parameters. These lists are specified using
592
+ # the `param.n` notation. Values of `n` are integers starting from 1.
593
+ # For example, a parameter list with two elements looks like this:
594
+ #
595
+ # `&AttributeName.1=first`
596
+ #
597
+ # `&AttributeName.2=second`
598
+ #
599
599
  # @option params [required, String] :queue_url
600
600
  # The URL of the Amazon SQS queue whose messages' visibility is
601
601
  # changed.
@@ -684,9 +684,17 @@ module Aws::SQS
684
684
  # * If the queue name, attribute names, or attribute values don't match
685
685
  # an existing queue, `CreateQueue` returns an error.
686
686
  #
687
+ # Some actions take lists of parameters. These lists are specified using
688
+ # the `param.n` notation. Values of `n` are integers starting from 1.
689
+ # For example, a parameter list with two elements looks like this:
690
+ #
691
+ # `&AttributeName.1=first`
692
+ #
693
+ # `&AttributeName.2=second`
694
+ #
687
695
  # <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*.
696
+ # information, see [Grant cross-account permissions to a role and a user
697
+ # name][3] in the *Amazon SQS Developer Guide*.
690
698
  #
691
699
  # </note>
692
700
  #
@@ -726,75 +734,41 @@ module Aws::SQS
726
734
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
727
735
  # Amazon SQS retains a message. Valid values: An integer from 60
728
736
  # 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.
737
+ # (4 days).
736
738
  #
737
739
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
738
740
  # For more information about policy structure, see [Overview of Amazon
739
- # Web Services IAM Policies][1] in the *IAM User Guide*.
741
+ # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
740
742
  #
741
743
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
742
744
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
743
745
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
744
746
  #
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
747
  # * `RedrivePolicy` – The string that includes the parameters for the
753
748
  # dead-letter queue functionality of the source queue as a JSON
754
- # object. The parameters are as follows:
749
+ # object. For more information about the redrive policy and
750
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
751
+ # the *Amazon SQS Developer Guide*.
755
752
  #
756
753
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
757
754
  # dead-letter queue to which Amazon SQS moves messages after the
758
755
  # value of `maxReceiveCount` is exceeded.
759
756
  #
760
757
  # * `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.
758
+ # the source queue before being moved to the dead-letter queue. When
759
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
760
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
796
761
  #
797
- # </note>
762
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
763
+ # Similarly, the dead-letter queue of a standard queue must also be a
764
+ # standard queue.
765
+ #
766
+ # </note>
767
+ #
768
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
769
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
770
+ # Default: 30. For more information about the visibility timeout, see
771
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
798
772
  #
799
773
  # The following attributes apply only to [server-side-encryption][4]:
800
774
  #
@@ -813,11 +787,11 @@ module Aws::SQS
813
787
  # Default: 300 (5 minutes). A shorter time period provides better
814
788
  # security but results in more calls to KMS which might incur charges
815
789
  # after Free Tier. For more information, see [How Does the Data Key
816
- # Reuse Period Work?][8]
790
+ # Reuse Period Work?][8].
817
791
  #
818
792
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
819
793
  # SQS owned encryption keys. Only one server-side encryption option is
820
- # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
794
+ # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
821
795
  #
822
796
  # The following attributes apply only to [FIFO (first-in-first-out)
823
797
  # queues][11]:
@@ -894,8 +868,8 @@ module Aws::SQS
894
868
  #
895
869
  #
896
870
  # [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
871
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
872
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
899
873
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
900
874
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
901
875
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -933,8 +907,8 @@ module Aws::SQS
933
907
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
934
908
  #
935
909
  # 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*.
910
+ # information, see [Grant cross-account permissions to a role and a user
911
+ # name][3] in the *Amazon SQS Developer Guide*.
938
912
  #
939
913
  # </note>
940
914
  #
@@ -986,7 +960,7 @@ module Aws::SQS
986
960
  # `ReceiptHandle` is different each time you receive a message. When you
987
961
  # use the `DeleteMessage` action, you must provide the most recently
988
962
  # received `ReceiptHandle` for the message (otherwise, the request
989
- # succeeds, but the message will not be deleted).
963
+ # succeeds, but the message might not be deleted).
990
964
  #
991
965
  # For standard queues, it is possible to receive a message even after
992
966
  # you delete it. This might happen on rare occasions if one of the
@@ -1032,6 +1006,14 @@ module Aws::SQS
1032
1006
  # and unsuccessful actions, you should check for batch errors even when
1033
1007
  # the call returns an HTTP status code of `200`.
1034
1008
  #
1009
+ # Some actions take lists of parameters. These lists are specified using
1010
+ # the `param.n` notation. Values of `n` are integers starting from 1.
1011
+ # For example, a parameter list with two elements looks like this:
1012
+ #
1013
+ # `&AttributeName.1=first`
1014
+ #
1015
+ # `&AttributeName.2=second`
1016
+ #
1035
1017
  # @option params [required, String] :queue_url
1036
1018
  # The URL of the Amazon SQS queue from which messages are deleted.
1037
1019
  #
@@ -1091,10 +1073,8 @@ module Aws::SQS
1091
1073
  # creating a queue with the same name.
1092
1074
  #
1093
1075
  # <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.
1076
+ # information, see [Grant cross-account permissions to a role and a user
1077
+ # name][1] in the *Amazon SQS Developer Guide*.
1098
1078
  #
1099
1079
  # </note>
1100
1080
  #
@@ -1144,7 +1124,7 @@ module Aws::SQS
1144
1124
  # @option params [Array<String>] :attribute_names
1145
1125
  # A list of attributes for which to retrieve information.
1146
1126
  #
1147
- # The `AttributeNames` parameter is optional, but if you don't specify
1127
+ # The `AttributeName.N` parameter is optional, but if you don't specify
1148
1128
  # values for this parameter, the request returns empty results.
1149
1129
  #
1150
1130
  # <note markdown="1"> In the future, new attributes might be added. If you write code that
@@ -1157,10 +1137,10 @@ module Aws::SQS
1157
1137
  #
1158
1138
  # The `ApproximateNumberOfMessagesDelayed`,
1159
1139
  # `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.
1140
+ # `ApproximateNumberOfMessagesVisible` metrics may not achieve
1141
+ # consistency until at least 1 minute after the producers stop sending
1142
+ # messages. This period is required for the queue metadata to reach
1143
+ # eventual consistency.
1164
1144
  #
1165
1145
  # * `All` – Returns all values.
1166
1146
  #
@@ -1190,14 +1170,7 @@ module Aws::SQS
1190
1170
  # can contain before Amazon SQS rejects it.
1191
1171
  #
1192
1172
  # * `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.
1173
+ # for which Amazon SQS retains a message.
1201
1174
  #
1202
1175
  # * `Policy` – Returns the policy of the queue.
1203
1176
  #
@@ -1207,58 +1180,24 @@ module Aws::SQS
1207
1180
  # seconds, for which the `ReceiveMessage` action waits for a message
1208
1181
  # to arrive.
1209
1182
  #
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
1183
  # * `RedrivePolicy` – The string that includes the parameters for the
1217
1184
  # dead-letter queue functionality of the source queue as a JSON
1218
- # object. The parameters are as follows:
1185
+ # object. For more information about the redrive policy and
1186
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
1187
+ # the *Amazon SQS Developer Guide*.
1219
1188
  #
1220
1189
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
1221
1190
  # dead-letter queue to which Amazon SQS moves messages after the
1222
1191
  # value of `maxReceiveCount` is exceeded.
1223
1192
  #
1224
1193
  # * `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.
1194
+ # the source queue before being moved to the dead-letter queue. When
1195
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
1196
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
1260
1197
  #
1261
- # </note>
1198
+ # * `VisibilityTimeout` – Returns the visibility timeout for the queue.
1199
+ # For more information about the visibility timeout, see [Visibility
1200
+ # Timeout][3] in the *Amazon SQS Developer Guide*.
1262
1201
  #
1263
1202
  # The following attributes apply only to [server-side-encryption][4]:
1264
1203
  #
@@ -1273,8 +1212,8 @@ module Aws::SQS
1273
1212
  #
1274
1213
  # * `SqsManagedSseEnabled` – Returns information about whether the queue
1275
1214
  # 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]).
1215
+ # one server-side encryption option is supported per queue (e.g.
1216
+ # [SSE-KMS][7] or [SSE-SQS][8]).
1278
1217
  #
1279
1218
  # The following attributes apply only to [FIFO (first-in-first-out)
1280
1219
  # queues][9]:
@@ -1321,8 +1260,8 @@ module Aws::SQS
1321
1260
  #
1322
1261
  #
1323
1262
  # [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
1263
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
1264
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1326
1265
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
1327
1266
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
1328
1267
  # [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 +1413,8 @@ module Aws::SQS
1474
1413
  # *Amazon SQS Developer Guide*.
1475
1414
  #
1476
1415
  # <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*.
1416
+ # information, see [Grant cross-account permissions to a role and a user
1417
+ # name][2] in the *Amazon SQS Developer Guide*.
1479
1418
  #
1480
1419
  # </note>
1481
1420
  #
@@ -1525,8 +1464,8 @@ module Aws::SQS
1525
1464
  # request to `listQueues` to receive the next page of results.
1526
1465
  #
1527
1466
  # <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*.
1467
+ # information, see [Grant cross-account permissions to a role and a user
1468
+ # name][1] in the *Amazon SQS Developer Guide*.
1530
1469
  #
1531
1470
  # </note>
1532
1471
  #
@@ -1694,7 +1633,7 @@ module Aws::SQS
1694
1633
  #
1695
1634
  # * `SenderId`
1696
1635
  #
1697
- # * For a user, returns the user ID, for example
1636
+ # * For an IAM user, returns the IAM user ID, for example
1698
1637
  # `ABCDEFGHI1JKLMNOPQ23R`.
1699
1638
  #
1700
1639
  # * For an IAM role, returns the IAM role ID, for example
@@ -1705,7 +1644,7 @@ module Aws::SQS
1705
1644
  #
1706
1645
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
1707
1646
  # SQS owned encryption keys. Only one server-side encryption option is
1708
- # supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
1647
+ # supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
1709
1648
  #
1710
1649
  # * `MessageDeduplicationId` – Returns the value provided by the
1711
1650
  # producer that calls the ` SendMessage ` action.
@@ -1888,7 +1827,7 @@ module Aws::SQS
1888
1827
  #
1889
1828
  # * Cross-account permissions don't apply to this action. For more
1890
1829
  # information, see [Grant cross-account permissions to a role and a
1891
- # username][1] in the *Amazon SQS Developer Guide*.
1830
+ # user name][1] in the *Amazon SQS Developer Guide*.
1892
1831
  #
1893
1832
  # * To remove the ability to change queue permissions, you must deny
1894
1833
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -1949,7 +1888,7 @@ module Aws::SQS
1949
1888
  #
1950
1889
  # @option params [required, String] :message_body
1951
1890
  # The message to send. The minimum size is one character. The maximum
1952
- # size is 256 KiB.
1891
+ # size is 256 KB.
1953
1892
  #
1954
1893
  # A message can include only XML, JSON, and unformatted text. The
1955
1894
  # following Unicode characters are allowed:
@@ -2144,9 +2083,7 @@ module Aws::SQS
2144
2083
  req.send_request(options)
2145
2084
  end
2146
2085
 
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
2086
+ # Delivers up to ten messages to the specified queue. This is a batch
2150
2087
  # version of ` SendMessage.` For a FIFO queue, multiple messages within
2151
2088
  # a single batch are enqueued in the order they are sent.
2152
2089
  #
@@ -2157,7 +2094,7 @@ module Aws::SQS
2157
2094
  #
2158
2095
  # The maximum allowed individual message size and the maximum total
2159
2096
  # payload size (the sum of the individual lengths of all of the batched
2160
- # messages) are both 256 KiB (262,144 bytes).
2097
+ # messages) are both 256 KB (262,144 bytes).
2161
2098
  #
2162
2099
  # A message can include only XML, JSON, and unformatted text. The
2163
2100
  # following Unicode characters are allowed:
@@ -2171,6 +2108,14 @@ module Aws::SQS
2171
2108
  # If you don't specify the `DelaySeconds` parameter for an entry,
2172
2109
  # Amazon SQS uses the default value for the queue.
2173
2110
  #
2111
+ # Some actions take lists of parameters. These lists are specified using
2112
+ # the `param.n` notation. Values of `n` are integers starting from 1.
2113
+ # For example, a parameter list with two elements looks like this:
2114
+ #
2115
+ # `&AttributeName.1=first`
2116
+ #
2117
+ # `&AttributeName.2=second`
2118
+ #
2174
2119
  #
2175
2120
  #
2176
2121
  # [1]: http://www.w3.org/TR/REC-xml/#charsets
@@ -2249,9 +2194,7 @@ module Aws::SQS
2249
2194
  # queue's attributes, the change can take up to 60 seconds for most of
2250
2195
  # the attributes to propagate throughout the Amazon SQS system. Changes
2251
2196
  # 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.
2197
+ # minutes.
2255
2198
  #
2256
2199
  # <note markdown="1"> * In the future, new attributes might be added. If you write code that
2257
2200
  # calls this action, we recommend that you structure your code so that
@@ -2259,7 +2202,7 @@ module Aws::SQS
2259
2202
  #
2260
2203
  # * Cross-account permissions don't apply to this action. For more
2261
2204
  # information, see [Grant cross-account permissions to a role and a
2262
- # username][1] in the *Amazon SQS Developer Guide*.
2205
+ # user name][1] in the *Amazon SQS Developer Guide*.
2263
2206
  #
2264
2207
  # * To remove the ability to change queue permissions, you must deny
2265
2208
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -2294,13 +2237,7 @@ module Aws::SQS
2294
2237
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
2295
2238
  # Amazon SQS retains a message. Valid values: An integer representing
2296
2239
  # 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.
2240
+ # (4 days).
2304
2241
  #
2305
2242
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
2306
2243
  # For more information about policy structure, see [Overview of Amazon
@@ -2311,59 +2248,31 @@ module Aws::SQS
2311
2248
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
2312
2249
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
2313
2250
  #
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
2251
  # * `RedrivePolicy` – The string that includes the parameters for the
2322
2252
  # dead-letter queue functionality of the source queue as a JSON
2323
- # object. The parameters are as follows:
2253
+ # object. For more information about the redrive policy and
2254
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
2255
+ # the *Amazon SQS Developer Guide*.
2324
2256
  #
2325
2257
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2326
2258
  # dead-letter queue to which Amazon SQS moves messages after the
2327
2259
  # value of `maxReceiveCount` is exceeded.
2328
2260
  #
2329
2261
  # * `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.
2262
+ # the source queue before being moved to the dead-letter queue. When
2263
+ # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
2264
+ # a queue, Amazon SQS moves the message to the dead-letter-queue.
2365
2265
  #
2366
- # </note>
2266
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
2267
+ # Similarly, the dead-letter queue of a standard queue must also be a
2268
+ # standard queue.
2269
+ #
2270
+ # </note>
2271
+ #
2272
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
2273
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2274
+ # Default: 30. For more information about the visibility timeout, see
2275
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
2367
2276
  #
2368
2277
  # The following attributes apply only to [server-side-encryption][4]:
2369
2278
  #
@@ -2385,7 +2294,7 @@ module Aws::SQS
2385
2294
  #
2386
2295
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
2387
2296
  # SQS owned encryption keys. Only one server-side encryption option is
2388
- # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
2297
+ # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
2389
2298
  #
2390
2299
  # The following attribute applies only to [FIFO (first-in-first-out)
2391
2300
  # queues][11]:
@@ -2451,8 +2360,8 @@ module Aws::SQS
2451
2360
  #
2452
2361
  #
2453
2362
  # [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
2363
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
2364
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
2456
2365
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
2457
2366
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
2458
2367
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -2505,8 +2414,8 @@ module Aws::SQS
2505
2414
  # in the *Amazon SQS Developer Guide*.
2506
2415
  #
2507
2416
  # <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*.
2417
+ # information, see [Grant cross-account permissions to a role and a user
2418
+ # name][3] in the *Amazon SQS Developer Guide*.
2510
2419
  #
2511
2420
  # </note>
2512
2421
  #
@@ -2547,8 +2456,8 @@ module Aws::SQS
2547
2456
  # SQS Developer Guide*.
2548
2457
  #
2549
2458
  # <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*.
2459
+ # information, see [Grant cross-account permissions to a role and a user
2460
+ # name][2] in the *Amazon SQS Developer Guide*.
2552
2461
  #
2553
2462
  # </note>
2554
2463
  #
@@ -2594,7 +2503,7 @@ module Aws::SQS
2594
2503
  params: params,
2595
2504
  config: config)
2596
2505
  context[:gem_name] = 'aws-sdk-sqs'
2597
- context[:gem_version] = '1.54.0'
2506
+ context[:gem_version] = '1.55.0'
2598
2507
  Seahorse::Client::Request.new(handlers, context)
2599
2508
  end
2600
2509