aws-sdk-sqs 1.55.0 → 1.57.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -279,6 +279,11 @@ 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
@@ -392,25 +397,21 @@ module Aws::SQS
392
397
  # see [Using Custom Policies with the Amazon SQS Access Policy
393
398
  # Language][3] in the *Amazon SQS Developer Guide*.
394
399
  #
395
- # * An Amazon SQS policy can have a maximum of 7 actions.
400
+ # * An Amazon SQS policy can have a maximum of seven actions per
401
+ # statement.
396
402
  #
397
403
  # * To remove the ability to change queue permissions, you must deny
398
404
  # permission to the `AddPermission`, `RemovePermission`, and
399
405
  # `SetQueueAttributes` actions in your IAM policy.
400
406
  #
401
- # </note>
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`
407
+ # * Amazon SQS `AddPermission` does not support adding a non-account
408
+ # principal.
408
409
  #
409
- # `&AttributeName.2=second`
410
+ # </note>
410
411
  #
411
412
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
412
- # information, see [Grant cross-account permissions to a role and a user
413
- # name][4] in the *Amazon SQS Developer Guide*.
413
+ # information, see [Grant cross-account permissions to a role and a
414
+ # username][4] in the *Amazon SQS Developer Guide*.
414
415
  #
415
416
  # </note>
416
417
  #
@@ -481,18 +482,57 @@ module Aws::SQS
481
482
  req.send_request(options)
482
483
  end
483
484
 
485
+ # Cancels a specified message movement task.
486
+ #
487
+ # <note markdown="1"> * A message movement can only be cancelled when the current status is
488
+ # RUNNING.
489
+ #
490
+ # * Cancelling a message movement task does not revert the messages that
491
+ # have already been moved. It can only stop the messages that have not
492
+ # been moved yet.
493
+ #
494
+ # </note>
495
+ #
496
+ # @option params [required, String] :task_handle
497
+ # An identifier associated with a message movement task.
498
+ #
499
+ # @return [Types::CancelMessageMoveTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
500
+ #
501
+ # * {Types::CancelMessageMoveTaskResult#approximate_number_of_messages_moved #approximate_number_of_messages_moved} => Integer
502
+ #
503
+ # @example Request syntax with placeholder values
504
+ #
505
+ # resp = client.cancel_message_move_task({
506
+ # task_handle: "String", # required
507
+ # })
508
+ #
509
+ # @example Response structure
510
+ #
511
+ # resp.approximate_number_of_messages_moved #=> Integer
512
+ #
513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTask AWS API Documentation
514
+ #
515
+ # @overload cancel_message_move_task(params = {})
516
+ # @param [Hash] params ({})
517
+ def cancel_message_move_task(params = {}, options = {})
518
+ req = build_request(:cancel_message_move_task, params)
519
+ req.send_request(options)
520
+ end
521
+
484
522
  # Changes the visibility timeout of a specified message in a queue to a
485
523
  # new value. The default visibility timeout for a message is 30 seconds.
486
524
  # The minimum is 0 seconds. The maximum is 12 hours. For more
487
525
  # information, see [Visibility Timeout][1] in the *Amazon SQS Developer
488
526
  # Guide*.
489
527
  #
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.
528
+ # For example, if the default timeout for a queue is 60 seconds, 15
529
+ # seconds have elapsed since you received the message, and you send a
530
+ # ChangeMessageVisibility call with `VisibilityTimeout` set to 10
531
+ # seconds, the 10 seconds begin to count from the time that you make the
532
+ # `ChangeMessageVisibility` call. Thus, any attempt to change the
533
+ # visibility timeout or to delete that message 10 seconds after you
534
+ # initially change the visibility timeout (a total of 25 seconds) might
535
+ # result in an error.
496
536
  #
497
537
  # An Amazon SQS message has three basic states:
498
538
  #
@@ -508,13 +548,13 @@ module Aws::SQS
508
548
  # messages. A message is considered to be *in flight* after it is
509
549
  # received from a queue by a consumer, but not yet deleted from the
510
550
  # queue (that is, between states 2 and 3). There is a limit to the
511
- # number of inflight messages.
551
+ # number of in flight messages.
512
552
  #
513
- # Limits that apply to inflight messages are unrelated to the
553
+ # Limits that apply to in flight messages are unrelated to the
514
554
  # *unlimited* number of stored messages.
515
555
  #
516
556
  # For most standard queues (depending on queue traffic and message
517
- # backlog), there can be a maximum of approximately 120,000 inflight
557
+ # backlog), there can be a maximum of approximately 120,000 in flight
518
558
  # messages (received from a queue by a consumer, but not yet deleted
519
559
  # from the queue). If you reach this limit, Amazon SQS returns the
520
560
  # `OverLimit` error message. To avoid reaching the limit, you should
@@ -522,7 +562,7 @@ module Aws::SQS
522
562
  # increase the number of queues you use to process your messages. To
523
563
  # request a limit increase, [file a support request][2].
524
564
  #
525
- # For FIFO queues, there can be a maximum of 20,000 inflight messages
565
+ # For FIFO queues, there can be a maximum of 20,000 in flight messages
526
566
  # (received from a queue by a consumer, but not yet deleted from the
527
567
  # queue). If you reach this limit, Amazon SQS returns no error messages.
528
568
  #
@@ -551,7 +591,7 @@ module Aws::SQS
551
591
  # Queue URLs and names are case-sensitive.
552
592
  #
553
593
  # @option params [required, String] :receipt_handle
554
- # The receipt handle associated with the message whose visibility
594
+ # The receipt handle associated with the message, whose visibility
555
595
  # timeout is changed. This parameter is returned by the ` ReceiveMessage
556
596
  # ` action.
557
597
  #
@@ -588,14 +628,6 @@ module Aws::SQS
588
628
  # and unsuccessful actions, you should check for batch errors even when
589
629
  # the call returns an HTTP status code of `200`.
590
630
  #
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
631
  # @option params [required, String] :queue_url
600
632
  # The URL of the Amazon SQS queue whose messages' visibility is
601
633
  # changed.
@@ -603,7 +635,7 @@ module Aws::SQS
603
635
  # Queue URLs and names are case-sensitive.
604
636
  #
605
637
  # @option params [required, Array<Types::ChangeMessageVisibilityBatchRequestEntry>] :entries
606
- # A list of receipt handles of the messages for which the visibility
638
+ # Lists the receipt handles of the messages for which the visibility
607
639
  # timeout must be changed.
608
640
  #
609
641
  # @return [Types::ChangeMessageVisibilityBatchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -684,17 +716,9 @@ module Aws::SQS
684
716
  # * If the queue name, attribute names, or attribute values don't match
685
717
  # an existing queue, `CreateQueue` returns an error.
686
718
  #
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
- #
695
719
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
696
- # information, see [Grant cross-account permissions to a role and a user
697
- # name][3] in the *Amazon SQS Developer Guide*.
720
+ # information, see [Grant cross-account permissions to a role and a
721
+ # username][3] in the *Amazon SQS Developer Guide*.
698
722
  #
699
723
  # </note>
700
724
  #
@@ -734,41 +758,75 @@ module Aws::SQS
734
758
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
735
759
  # Amazon SQS retains a message. Valid values: An integer from 60
736
760
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
737
- # (4 days).
761
+ # (4 days). When you change a queue's attributes, the change can take
762
+ # up to 60 seconds for most of the attributes to propagate throughout
763
+ # the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
764
+ # attribute can take up to 15 minutes and will impact existing
765
+ # messages in the queue potentially causing them to be expired and
766
+ # deleted if the `MessageRetentionPeriod` is reduced below the age of
767
+ # existing messages.
738
768
  #
739
769
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
740
770
  # For more information about policy structure, see [Overview of Amazon
741
- # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
771
+ # Web Services IAM Policies][1] in the *IAM User Guide*.
742
772
  #
743
773
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
744
774
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
745
775
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
746
776
  #
777
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
778
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
779
+ # Default: 30. For more information about the visibility timeout, see
780
+ # [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
781
+ #
782
+ # The following attributes apply only to [dead-letter queues:][3]
783
+ #
747
784
  # * `RedrivePolicy` – The string that includes the parameters for the
748
785
  # dead-letter queue functionality of the source queue as a JSON
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*.
786
+ # object. The parameters are as follows:
752
787
  #
753
788
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
754
789
  # dead-letter queue to which Amazon SQS moves messages after the
755
790
  # value of `maxReceiveCount` is exceeded.
756
791
  #
757
792
  # * `maxReceiveCount` – The number of times a message is delivered to
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.
793
+ # the source queue before being moved to the dead-letter queue.
794
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
795
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
796
+ # dead-letter-queue.
797
+ #
798
+ # * `RedriveAllowPolicy` – The string that includes the parameters for
799
+ # the permissions for the dead-letter queue redrive permission and
800
+ # which source queues can specify dead-letter queues as a JSON object.
801
+ # The parameters are as follows:
802
+ #
803
+ # * `redrivePermission` – The permission type that defines which
804
+ # source queues can specify the current queue as the dead-letter
805
+ # queue. Valid values are:
806
+ #
807
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
808
+ # Services account in the same Region can specify this queue as
809
+ # the dead-letter queue.
810
+ #
811
+ # * `denyAll` – No source queues can specify this queue as the
812
+ # dead-letter queue.
813
+ #
814
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
815
+ # parameter can specify this queue as the dead-letter queue.
816
+ #
817
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
818
+ # queues that can specify this queue as the dead-letter queue and
819
+ # redrive messages. You can specify this parameter only when the
820
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
821
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
822
+ # specify dead-letter queues, set the `redrivePermission` parameter
823
+ # to `allowAll`.
824
+ #
825
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
826
+ # Similarly, the dead-letter queue of a standard queue must also be a
827
+ # standard queue.
761
828
  #
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*.
829
+ # </note>
772
830
  #
773
831
  # The following attributes apply only to [server-side-encryption][4]:
774
832
  #
@@ -787,11 +845,11 @@ module Aws::SQS
787
845
  # Default: 300 (5 minutes). A shorter time period provides better
788
846
  # security but results in more calls to KMS which might incur charges
789
847
  # after Free Tier. For more information, see [How Does the Data Key
790
- # Reuse Period Work?][8].
848
+ # Reuse Period Work?][8]
791
849
  #
792
850
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
793
851
  # SQS owned encryption keys. Only one server-side encryption option is
794
- # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
852
+ # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
795
853
  #
796
854
  # The following attributes apply only to [FIFO (first-in-first-out)
797
855
  # queues][11]:
@@ -868,8 +926,8 @@ module Aws::SQS
868
926
  #
869
927
  #
870
928
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.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
929
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
930
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
873
931
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
874
932
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
875
933
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -907,8 +965,8 @@ module Aws::SQS
907
965
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
908
966
  #
909
967
  # Cross-account permissions don't apply to this action. For more
910
- # information, see [Grant cross-account permissions to a role and a user
911
- # name][3] in the *Amazon SQS Developer Guide*.
968
+ # information, see [Grant cross-account permissions to a role and a
969
+ # username][3] in the *Amazon SQS Developer Guide*.
912
970
  #
913
971
  # </note>
914
972
  #
@@ -960,7 +1018,7 @@ module Aws::SQS
960
1018
  # `ReceiptHandle` is different each time you receive a message. When you
961
1019
  # use the `DeleteMessage` action, you must provide the most recently
962
1020
  # received `ReceiptHandle` for the message (otherwise, the request
963
- # succeeds, but the message might not be deleted).
1021
+ # succeeds, but the message will not be deleted).
964
1022
  #
965
1023
  # For standard queues, it is possible to receive a message even after
966
1024
  # you delete it. This might happen on rare occasions if one of the
@@ -1006,21 +1064,13 @@ module Aws::SQS
1006
1064
  # and unsuccessful actions, you should check for batch errors even when
1007
1065
  # the call returns an HTTP status code of `200`.
1008
1066
  #
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
- #
1017
1067
  # @option params [required, String] :queue_url
1018
1068
  # The URL of the Amazon SQS queue from which messages are deleted.
1019
1069
  #
1020
1070
  # Queue URLs and names are case-sensitive.
1021
1071
  #
1022
1072
  # @option params [required, Array<Types::DeleteMessageBatchRequestEntry>] :entries
1023
- # A list of receipt handles for the messages to be deleted.
1073
+ # Lists the receipt handles for the messages to be deleted.
1024
1074
  #
1025
1075
  # @return [Types::DeleteMessageBatchResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1026
1076
  #
@@ -1073,8 +1123,10 @@ module Aws::SQS
1073
1123
  # creating a queue with the same name.
1074
1124
  #
1075
1125
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1076
- # information, see [Grant cross-account permissions to a role and a user
1077
- # name][1] in the *Amazon SQS Developer Guide*.
1126
+ # information, see [Grant cross-account permissions to a role and a
1127
+ # username][1] in the *Amazon SQS Developer Guide*.
1128
+ #
1129
+ # The delete operation uses the HTTP `GET` verb.
1078
1130
  #
1079
1131
  # </note>
1080
1132
  #
@@ -1124,7 +1176,7 @@ module Aws::SQS
1124
1176
  # @option params [Array<String>] :attribute_names
1125
1177
  # A list of attributes for which to retrieve information.
1126
1178
  #
1127
- # The `AttributeName.N` parameter is optional, but if you don't specify
1179
+ # The `AttributeNames` parameter is optional, but if you don't specify
1128
1180
  # values for this parameter, the request returns empty results.
1129
1181
  #
1130
1182
  # <note markdown="1"> In the future, new attributes might be added. If you write code that
@@ -1137,10 +1189,10 @@ module Aws::SQS
1137
1189
  #
1138
1190
  # The `ApproximateNumberOfMessagesDelayed`,
1139
1191
  # `ApproximateNumberOfMessagesNotVisible`, and
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.
1192
+ # `ApproximateNumberOfMessages` metrics may not achieve consistency
1193
+ # until at least 1 minute after the producers stop sending messages.
1194
+ # This period is required for the queue metadata to reach eventual
1195
+ # consistency.
1144
1196
  #
1145
1197
  # * `All` – Returns all values.
1146
1198
  #
@@ -1170,7 +1222,14 @@ module Aws::SQS
1170
1222
  # can contain before Amazon SQS rejects it.
1171
1223
  #
1172
1224
  # * `MessageRetentionPeriod` – Returns the length of time, in seconds,
1173
- # for which Amazon SQS retains a message.
1225
+ # for which Amazon SQS retains a message. When you change a queue's
1226
+ # attributes, the change can take up to 60 seconds for most of the
1227
+ # attributes to propagate throughout the Amazon SQS system. Changes
1228
+ # made to the `MessageRetentionPeriod` attribute can take up to 15
1229
+ # minutes and will impact existing messages in the queue potentially
1230
+ # causing them to be expired and deleted if the
1231
+ # `MessageRetentionPeriod` is reduced below the age of existing
1232
+ # messages.
1174
1233
  #
1175
1234
  # * `Policy` – Returns the policy of the queue.
1176
1235
  #
@@ -1180,24 +1239,58 @@ module Aws::SQS
1180
1239
  # seconds, for which the `ReceiveMessage` action waits for a message
1181
1240
  # to arrive.
1182
1241
  #
1242
+ # * `VisibilityTimeout` – Returns the visibility timeout for the queue.
1243
+ # For more information about the visibility timeout, see [Visibility
1244
+ # Timeout][2] in the *Amazon SQS Developer Guide*.
1245
+ #
1246
+ # The following attributes apply only to [dead-letter queues:][3]
1247
+ #
1183
1248
  # * `RedrivePolicy` – The string that includes the parameters for the
1184
1249
  # dead-letter queue functionality of the source queue as a JSON
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*.
1250
+ # object. The parameters are as follows:
1188
1251
  #
1189
1252
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
1190
1253
  # dead-letter queue to which Amazon SQS moves messages after the
1191
1254
  # value of `maxReceiveCount` is exceeded.
1192
1255
  #
1193
1256
  # * `maxReceiveCount` – The number of times a message is delivered to
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.
1257
+ # the source queue before being moved to the dead-letter queue.
1258
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
1259
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
1260
+ # dead-letter-queue.
1261
+ #
1262
+ # * `RedriveAllowPolicy` – The string that includes the parameters for
1263
+ # the permissions for the dead-letter queue redrive permission and
1264
+ # which source queues can specify dead-letter queues as a JSON object.
1265
+ # The parameters are as follows:
1266
+ #
1267
+ # * `redrivePermission` – The permission type that defines which
1268
+ # source queues can specify the current queue as the dead-letter
1269
+ # queue. Valid values are:
1270
+ #
1271
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
1272
+ # Services account in the same Region can specify this queue as
1273
+ # the dead-letter queue.
1274
+ #
1275
+ # * `denyAll` – No source queues can specify this queue as the
1276
+ # dead-letter queue.
1277
+ #
1278
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
1279
+ # parameter can specify this queue as the dead-letter queue.
1280
+ #
1281
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
1282
+ # queues that can specify this queue as the dead-letter queue and
1283
+ # redrive messages. You can specify this parameter only when the
1284
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
1285
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
1286
+ # specify dead-letter queues, set the `redrivePermission` parameter
1287
+ # to `allowAll`.
1288
+ #
1289
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
1290
+ # Similarly, the dead-letter queue of a standard queue must also be a
1291
+ # standard queue.
1197
1292
  #
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*.
1293
+ # </note>
1201
1294
  #
1202
1295
  # The following attributes apply only to [server-side-encryption][4]:
1203
1296
  #
@@ -1212,8 +1305,8 @@ module Aws::SQS
1212
1305
  #
1213
1306
  # * `SqsManagedSseEnabled` – Returns information about whether the queue
1214
1307
  # is using SSE-SQS encryption using SQS owned encryption keys. Only
1215
- # one server-side encryption option is supported per queue (e.g.
1216
- # [SSE-KMS][7] or [SSE-SQS][8]).
1308
+ # one server-side encryption option is supported per queue (for
1309
+ # example, [SSE-KMS][7] or [SSE-SQS][8]).
1217
1310
  #
1218
1311
  # The following attributes apply only to [FIFO (first-in-first-out)
1219
1312
  # queues][9]:
@@ -1260,8 +1353,8 @@ module Aws::SQS
1260
1353
  #
1261
1354
  #
1262
1355
  # [1]: http://en.wikipedia.org/wiki/Unix_time
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
1356
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1357
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
1265
1358
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
1266
1359
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
1267
1360
  # [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
@@ -1408,13 +1501,57 @@ module Aws::SQS
1408
1501
  req.send_request(options)
1409
1502
  end
1410
1503
 
1504
+ # Gets the most recent message movement tasks (up to 10) under a
1505
+ # specific source queue.
1506
+ #
1507
+ # @option params [required, String] :source_arn
1508
+ # The ARN of the queue whose message movement tasks are to be listed.
1509
+ #
1510
+ # @option params [Integer] :max_results
1511
+ # The maximum number of results to include in the response. The default
1512
+ # is 1, which provides the most recent message movement task. The upper
1513
+ # limit is 10.
1514
+ #
1515
+ # @return [Types::ListMessageMoveTasksResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1516
+ #
1517
+ # * {Types::ListMessageMoveTasksResult#results #results} => Array&lt;Types::ListMessageMoveTasksResultEntry&gt;
1518
+ #
1519
+ # @example Request syntax with placeholder values
1520
+ #
1521
+ # resp = client.list_message_move_tasks({
1522
+ # source_arn: "String", # required
1523
+ # max_results: 1,
1524
+ # })
1525
+ #
1526
+ # @example Response structure
1527
+ #
1528
+ # resp.results #=> Array
1529
+ # resp.results[0].task_handle #=> String
1530
+ # resp.results[0].status #=> String
1531
+ # resp.results[0].source_arn #=> String
1532
+ # resp.results[0].destination_arn #=> String
1533
+ # resp.results[0].max_number_of_messages_per_second #=> Integer
1534
+ # resp.results[0].approximate_number_of_messages_moved #=> Integer
1535
+ # resp.results[0].approximate_number_of_messages_to_move #=> Integer
1536
+ # resp.results[0].failure_reason #=> String
1537
+ # resp.results[0].started_timestamp #=> Integer
1538
+ #
1539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasks AWS API Documentation
1540
+ #
1541
+ # @overload list_message_move_tasks(params = {})
1542
+ # @param [Hash] params ({})
1543
+ def list_message_move_tasks(params = {}, options = {})
1544
+ req = build_request(:list_message_move_tasks, params)
1545
+ req.send_request(options)
1546
+ end
1547
+
1411
1548
  # List all cost allocation tags added to the specified Amazon SQS queue.
1412
1549
  # For an overview, see [Tagging Your Amazon SQS Queues][1] in the
1413
1550
  # *Amazon SQS Developer Guide*.
1414
1551
  #
1415
1552
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1416
- # information, see [Grant cross-account permissions to a role and a user
1417
- # name][2] in the *Amazon SQS Developer Guide*.
1553
+ # information, see [Grant cross-account permissions to a role and a
1554
+ # username][2] in the *Amazon SQS Developer Guide*.
1418
1555
  #
1419
1556
  # </note>
1420
1557
  #
@@ -1464,8 +1601,8 @@ module Aws::SQS
1464
1601
  # request to `listQueues` to receive the next page of results.
1465
1602
  #
1466
1603
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
1467
- # information, see [Grant cross-account permissions to a role and a user
1468
- # name][1] in the *Amazon SQS Developer Guide*.
1604
+ # information, see [Grant cross-account permissions to a role and a
1605
+ # username][1] in the *Amazon SQS Developer Guide*.
1469
1606
  #
1470
1607
  # </note>
1471
1608
  #
@@ -1633,7 +1770,7 @@ module Aws::SQS
1633
1770
  #
1634
1771
  # * `SenderId`
1635
1772
  #
1636
- # * For an IAM user, returns the IAM user ID, for example
1773
+ # * For a user, returns the user ID, for example
1637
1774
  # `ABCDEFGHI1JKLMNOPQ23R`.
1638
1775
  #
1639
1776
  # * For an IAM role, returns the IAM role ID, for example
@@ -1644,7 +1781,7 @@ module Aws::SQS
1644
1781
  #
1645
1782
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
1646
1783
  # SQS owned encryption keys. Only one server-side encryption option is
1647
- # supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
1784
+ # supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
1648
1785
  #
1649
1786
  # * `MessageDeduplicationId` – Returns the value provided by the
1650
1787
  # producer that calls the ` SendMessage ` action.
@@ -1827,7 +1964,7 @@ module Aws::SQS
1827
1964
  #
1828
1965
  # * Cross-account permissions don't apply to this action. For more
1829
1966
  # information, see [Grant cross-account permissions to a role and a
1830
- # user name][1] in the *Amazon SQS Developer Guide*.
1967
+ # username][1] in the *Amazon SQS Developer Guide*.
1831
1968
  #
1832
1969
  # * To remove the ability to change queue permissions, you must deny
1833
1970
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -1888,7 +2025,7 @@ module Aws::SQS
1888
2025
  #
1889
2026
  # @option params [required, String] :message_body
1890
2027
  # The message to send. The minimum size is one character. The maximum
1891
- # size is 256 KB.
2028
+ # size is 256 KiB.
1892
2029
  #
1893
2030
  # A message can include only XML, JSON, and unformatted text. The
1894
2031
  # following Unicode characters are allowed:
@@ -2083,7 +2220,9 @@ module Aws::SQS
2083
2220
  req.send_request(options)
2084
2221
  end
2085
2222
 
2086
- # Delivers up to ten messages to the specified queue. This is a batch
2223
+ # You can use `SendMessageBatch` to send up to 10 messages to the
2224
+ # specified queue by assigning either identical or different values to
2225
+ # each message (or by not assigning values at all). This is a batch
2087
2226
  # version of ` SendMessage.` For a FIFO queue, multiple messages within
2088
2227
  # a single batch are enqueued in the order they are sent.
2089
2228
  #
@@ -2094,7 +2233,7 @@ module Aws::SQS
2094
2233
  #
2095
2234
  # The maximum allowed individual message size and the maximum total
2096
2235
  # payload size (the sum of the individual lengths of all of the batched
2097
- # messages) are both 256 KB (262,144 bytes).
2236
+ # messages) are both 256 KiB (262,144 bytes).
2098
2237
  #
2099
2238
  # A message can include only XML, JSON, and unformatted text. The
2100
2239
  # following Unicode characters are allowed:
@@ -2108,14 +2247,6 @@ module Aws::SQS
2108
2247
  # If you don't specify the `DelaySeconds` parameter for an entry,
2109
2248
  # Amazon SQS uses the default value for the queue.
2110
2249
  #
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
- #
2119
2250
  #
2120
2251
  #
2121
2252
  # [1]: http://www.w3.org/TR/REC-xml/#charsets
@@ -2194,7 +2325,9 @@ module Aws::SQS
2194
2325
  # queue's attributes, the change can take up to 60 seconds for most of
2195
2326
  # the attributes to propagate throughout the Amazon SQS system. Changes
2196
2327
  # made to the `MessageRetentionPeriod` attribute can take up to 15
2197
- # minutes.
2328
+ # minutes and will impact existing messages in the queue potentially
2329
+ # causing them to be expired and deleted if the `MessageRetentionPeriod`
2330
+ # is reduced below the age of existing messages.
2198
2331
  #
2199
2332
  # <note markdown="1"> * In the future, new attributes might be added. If you write code that
2200
2333
  # calls this action, we recommend that you structure your code so that
@@ -2202,7 +2335,7 @@ module Aws::SQS
2202
2335
  #
2203
2336
  # * Cross-account permissions don't apply to this action. For more
2204
2337
  # information, see [Grant cross-account permissions to a role and a
2205
- # user name][1] in the *Amazon SQS Developer Guide*.
2338
+ # username][1] in the *Amazon SQS Developer Guide*.
2206
2339
  #
2207
2340
  # * To remove the ability to change queue permissions, you must deny
2208
2341
  # permission to the `AddPermission`, `RemovePermission`, and
@@ -2237,7 +2370,13 @@ module Aws::SQS
2237
2370
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
2238
2371
  # Amazon SQS retains a message. Valid values: An integer representing
2239
2372
  # seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
2240
- # (4 days).
2373
+ # (4 days). When you change a queue's attributes, the change can take
2374
+ # up to 60 seconds for most of the attributes to propagate throughout
2375
+ # the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
2376
+ # attribute can take up to 15 minutes and will impact existing
2377
+ # messages in the queue potentially causing them to be expired and
2378
+ # deleted if the `MessageRetentionPeriod` is reduced below the age of
2379
+ # existing messages.
2241
2380
  #
2242
2381
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
2243
2382
  # For more information about policy structure, see [Overview of Amazon
@@ -2248,31 +2387,59 @@ module Aws::SQS
2248
2387
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
2249
2388
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
2250
2389
  #
2390
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
2391
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2392
+ # Default: 30. For more information about the visibility timeout, see
2393
+ # [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
2394
+ #
2395
+ # The following attributes apply only to [dead-letter queues:][3]
2396
+ #
2251
2397
  # * `RedrivePolicy` – The string that includes the parameters for the
2252
2398
  # dead-letter queue functionality of the source queue as a JSON
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*.
2399
+ # object. The parameters are as follows:
2256
2400
  #
2257
2401
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2258
2402
  # dead-letter queue to which Amazon SQS moves messages after the
2259
2403
  # value of `maxReceiveCount` is exceeded.
2260
2404
  #
2261
2405
  # * `maxReceiveCount` – The number of times a message is delivered to
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.
2265
- #
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>
2406
+ # the source queue before being moved to the dead-letter queue.
2407
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
2408
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
2409
+ # dead-letter-queue.
2410
+ #
2411
+ # * `RedriveAllowPolicy` The string that includes the parameters for
2412
+ # the permissions for the dead-letter queue redrive permission and
2413
+ # which source queues can specify dead-letter queues as a JSON object.
2414
+ # The parameters are as follows:
2415
+ #
2416
+ # * `redrivePermission` – The permission type that defines which
2417
+ # source queues can specify the current queue as the dead-letter
2418
+ # queue. Valid values are:
2419
+ #
2420
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
2421
+ # Services account in the same Region can specify this queue as
2422
+ # the dead-letter queue.
2423
+ #
2424
+ # * `denyAll` – No source queues can specify this queue as the
2425
+ # dead-letter queue.
2426
+ #
2427
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
2428
+ # parameter can specify this queue as the dead-letter queue.
2429
+ #
2430
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
2431
+ # queues that can specify this queue as the dead-letter queue and
2432
+ # redrive messages. You can specify this parameter only when the
2433
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
2434
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
2435
+ # specify dead-letter queues, set the `redrivePermission` parameter
2436
+ # to `allowAll`.
2437
+ #
2438
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
2439
+ # Similarly, the dead-letter queue of a standard queue must also be a
2440
+ # standard queue.
2271
2441
  #
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*.
2442
+ # </note>
2276
2443
  #
2277
2444
  # The following attributes apply only to [server-side-encryption][4]:
2278
2445
  #
@@ -2294,7 +2461,7 @@ module Aws::SQS
2294
2461
  #
2295
2462
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
2296
2463
  # SQS owned encryption keys. Only one server-side encryption option is
2297
- # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
2464
+ # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
2298
2465
  #
2299
2466
  # The following attribute applies only to [FIFO (first-in-first-out)
2300
2467
  # queues][11]:
@@ -2360,8 +2527,8 @@ module Aws::SQS
2360
2527
  #
2361
2528
  #
2362
2529
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.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
2530
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
2531
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
2365
2532
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
2366
2533
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
2367
2534
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -2394,6 +2561,65 @@ module Aws::SQS
2394
2561
  req.send_request(options)
2395
2562
  end
2396
2563
 
2564
+ # Starts an asynchronous task to move messages from a specified source
2565
+ # queue to a specified destination queue.
2566
+ #
2567
+ # <note markdown="1"> * This action is currently limited to supporting message redrive from
2568
+ # dead-letter queues (DLQs) only. In this context, the source queue is
2569
+ # the dead-letter queue (DLQ), while the destination queue can be the
2570
+ # original source queue (from which the messages were driven to the
2571
+ # dead-letter-queue), or a custom destination queue.
2572
+ #
2573
+ # * Currently, only standard queues are supported.
2574
+ #
2575
+ # * Only one active message movement task is supported per queue at any
2576
+ # given time.
2577
+ #
2578
+ # </note>
2579
+ #
2580
+ # @option params [required, String] :source_arn
2581
+ # The ARN of the queue that contains the messages to be moved to another
2582
+ # queue. Currently, only dead-letter queue (DLQ) ARNs are accepted.
2583
+ #
2584
+ # @option params [String] :destination_arn
2585
+ # The ARN of the queue that receives the moved messages. You can use
2586
+ # this field to specify the destination queue where you would like to
2587
+ # redrive messages. If this field is left blank, the messages will be
2588
+ # redriven back to their respective original source queues.
2589
+ #
2590
+ # @option params [Integer] :max_number_of_messages_per_second
2591
+ # The number of messages to be moved per second (the message movement
2592
+ # rate). You can use this field to define a fixed message movement rate.
2593
+ # The maximum value for messages per second is 500. If this field is
2594
+ # left blank, the system will optimize the rate based on the queue
2595
+ # message backlog size, which may vary throughout the duration of the
2596
+ # message movement task.
2597
+ #
2598
+ # @return [Types::StartMessageMoveTaskResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2599
+ #
2600
+ # * {Types::StartMessageMoveTaskResult#task_handle #task_handle} => String
2601
+ #
2602
+ # @example Request syntax with placeholder values
2603
+ #
2604
+ # resp = client.start_message_move_task({
2605
+ # source_arn: "String", # required
2606
+ # destination_arn: "String",
2607
+ # max_number_of_messages_per_second: 1,
2608
+ # })
2609
+ #
2610
+ # @example Response structure
2611
+ #
2612
+ # resp.task_handle #=> String
2613
+ #
2614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTask AWS API Documentation
2615
+ #
2616
+ # @overload start_message_move_task(params = {})
2617
+ # @param [Hash] params ({})
2618
+ def start_message_move_task(params = {}, options = {})
2619
+ req = build_request(:start_message_move_task, params)
2620
+ req.send_request(options)
2621
+ end
2622
+
2397
2623
  # Add cost allocation tags to the specified Amazon SQS queue. For an
2398
2624
  # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
2399
2625
  # Developer Guide*.
@@ -2414,8 +2640,8 @@ module Aws::SQS
2414
2640
  # in the *Amazon SQS Developer Guide*.
2415
2641
  #
2416
2642
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
2417
- # information, see [Grant cross-account permissions to a role and a user
2418
- # name][3] in the *Amazon SQS Developer Guide*.
2643
+ # information, see [Grant cross-account permissions to a role and a
2644
+ # username][3] in the *Amazon SQS Developer Guide*.
2419
2645
  #
2420
2646
  # </note>
2421
2647
  #
@@ -2456,8 +2682,8 @@ module Aws::SQS
2456
2682
  # SQS Developer Guide*.
2457
2683
  #
2458
2684
  # <note markdown="1"> Cross-account permissions don't apply to this action. For more
2459
- # information, see [Grant cross-account permissions to a role and a user
2460
- # name][2] in the *Amazon SQS Developer Guide*.
2685
+ # information, see [Grant cross-account permissions to a role and a
2686
+ # username][2] in the *Amazon SQS Developer Guide*.
2461
2687
  #
2462
2688
  # </note>
2463
2689
  #
@@ -2503,7 +2729,7 @@ module Aws::SQS
2503
2729
  params: params,
2504
2730
  config: config)
2505
2731
  context[:gem_name] = 'aws-sdk-sqs'
2506
- context[:gem_version] = '1.55.0'
2732
+ context[:gem_version] = '1.57.0'
2507
2733
  Seahorse::Client::Request.new(handlers, context)
2508
2734
  end
2509
2735