aws-sdk-sqs 1.6.0 → 1.7.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-sqs.rb +1 -1
- data/lib/aws-sdk-sqs/client.rb +269 -273
- data/lib/aws-sdk-sqs/client_api.rb +1 -0
- data/lib/aws-sdk-sqs/message.rb +23 -7
- data/lib/aws-sdk-sqs/queue.rb +49 -105
- data/lib/aws-sdk-sqs/resource.rb +21 -34
- data/lib/aws-sdk-sqs/types.rb +161 -201
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bf3f848b01bff04d0f62b5a6d7361ebc13561c66
|
4
|
+
data.tar.gz: '0329e5d580835310d23f096c15805d805e506fe9'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a66a412b27366de667b45626fe17175a89e36b8af83e2bd5ecae9cee1df9c35a95a7a1229baa5b700e237d802d1c9902705f5c07a3c520e36f5b3909e8b479f6
|
7
|
+
data.tar.gz: d965f5c96437d4cde096407597223c00959b57582c9697afeb1bfdd184c6a7d249c0b46e36c170d030562c097ae1b7c4c5a3287062d1f2b12857d17ec36104f0
|
data/lib/aws-sdk-sqs.rb
CHANGED
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -191,36 +191,45 @@ module Aws::SQS
|
|
191
191
|
#
|
192
192
|
# When you create a queue, you have full control access rights for the
|
193
193
|
# queue. Only you, the owner of the queue, can grant or deny permissions
|
194
|
-
# to the queue. For more information about these permissions, see
|
195
|
-
#
|
196
|
-
# Guide*.
|
194
|
+
# to the queue. For more information about these permissions, see [Allow
|
195
|
+
# Developers to Write Messages to a Shared Queue][2] in the *Amazon
|
196
|
+
# Simple Queue Service Developer Guide*.
|
197
197
|
#
|
198
198
|
# <note markdown="1"> `AddPermission` writes an Amazon-SQS-generated policy. If you want to
|
199
199
|
# write your own policy, use ` SetQueueAttributes ` to upload your
|
200
200
|
# policy. For more information about writing your own policy, see [Using
|
201
|
-
#
|
202
|
-
# Developer Guide*.
|
201
|
+
# Custom Policies with the Amazon SQS Access Policy Language][3] in the
|
202
|
+
# *Amazon Simple Queue Service Developer Guide*.
|
203
203
|
#
|
204
|
-
#
|
204
|
+
# An Amazon SQS policy can have a maximum of 7 actions.
|
205
|
+
#
|
206
|
+
# </note>
|
207
|
+
#
|
208
|
+
# Some actions take lists of parameters. These lists are specified using
|
205
209
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
206
210
|
# For example, a parameter list with two elements looks like this:
|
207
211
|
#
|
208
|
-
#
|
212
|
+
# `&Attribute.1=first`
|
213
|
+
#
|
214
|
+
# `&Attribute.2=second`
|
209
215
|
#
|
210
|
-
#
|
216
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
217
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
218
|
+
# User Name][4] in the *Amazon Simple Queue Service Developer Guide*.
|
211
219
|
#
|
212
220
|
# </note>
|
213
221
|
#
|
214
222
|
#
|
215
223
|
#
|
216
224
|
# [1]: http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P
|
217
|
-
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
218
|
-
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
225
|
+
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue
|
226
|
+
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html
|
227
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
219
228
|
#
|
220
229
|
# @option params [required, String] :queue_url
|
221
230
|
# The URL of the Amazon SQS queue to which permissions are added.
|
222
231
|
#
|
223
|
-
# Queue URLs are case-sensitive.
|
232
|
+
# Queue URLs and names are case-sensitive.
|
224
233
|
#
|
225
234
|
# @option params [required, String] :label
|
226
235
|
# The unique identification of the permission you're setting (for
|
@@ -238,28 +247,15 @@ module Aws::SQS
|
|
238
247
|
#
|
239
248
|
#
|
240
249
|
# [1]: http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P
|
241
|
-
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
250
|
+
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication
|
242
251
|
#
|
243
252
|
# @option params [required, Array<String>] :actions
|
244
|
-
# The action the client wants to allow for the specified principal.
|
245
|
-
#
|
246
|
-
#
|
247
|
-
# * `*`
|
253
|
+
# The action the client wants to allow for the specified principal.
|
254
|
+
# Valid values: the name of any action or `*`.
|
248
255
|
#
|
249
|
-
#
|
250
|
-
#
|
251
|
-
# *
|
252
|
-
#
|
253
|
-
# * `GetQueueAttributes`
|
254
|
-
#
|
255
|
-
# * `GetQueueUrl`
|
256
|
-
#
|
257
|
-
# * `ReceiveMessage`
|
258
|
-
#
|
259
|
-
# * `SendMessage`
|
260
|
-
#
|
261
|
-
# For more information about these actions, see [Understanding
|
262
|
-
# Permissions][1] in the *Amazon Simple Queue Service Developer Guide*.
|
256
|
+
# For more information about these actions, see [Overview of Managing
|
257
|
+
# Access Permissions to Your Amazon Simple Queue Service Resource][1] in
|
258
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
263
259
|
#
|
264
260
|
# Specifying `SendMessage`, `DeleteMessage`, or
|
265
261
|
# `ChangeMessageVisibility` for `ActionName.n` also grants permissions
|
@@ -269,7 +265,7 @@ module Aws::SQS
|
|
269
265
|
#
|
270
266
|
#
|
271
267
|
#
|
272
|
-
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
268
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html
|
273
269
|
#
|
274
270
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
275
271
|
#
|
@@ -292,18 +288,13 @@ module Aws::SQS
|
|
292
288
|
end
|
293
289
|
|
294
290
|
# Changes the visibility timeout of a specified message in a queue to a
|
295
|
-
# new value. The maximum allowed timeout value is 12 hours.
|
296
|
-
#
|
297
|
-
#
|
298
|
-
# [Visibility Timeout][1] in the *Amazon Simple Queue Service Developer
|
299
|
-
# Guide*.
|
291
|
+
# new value. The maximum allowed timeout value is 12 hours. For more
|
292
|
+
# information, see [Visibility Timeout][1] in the *Amazon Simple Queue
|
293
|
+
# Service Developer Guide*.
|
300
294
|
#
|
301
295
|
# For example, you have a message with a visibility timeout of 5
|
302
|
-
# minutes. After 3 minutes, you call `
|
303
|
-
# timeout of 10 minutes.
|
304
|
-
# extended by 10 minutes beyond the time of the
|
305
|
-
# `ChangeMessageVisibility` action. This results in a total visibility
|
306
|
-
# timeout of 13 minutes. You can continue to call the
|
296
|
+
# minutes. After 3 minutes, you call `ChangeMessageVisibility` with a
|
297
|
+
# timeout of 10 minutes. You can continue to call
|
307
298
|
# `ChangeMessageVisibility` to extend the visibility timeout to a
|
308
299
|
# maximum of 12 hours. If you try to extend the visibility timeout
|
309
300
|
# beyond 12 hours, your request is rejected.
|
@@ -342,7 +333,7 @@ module Aws::SQS
|
|
342
333
|
# The URL of the Amazon SQS queue whose message's visibility is
|
343
334
|
# changed.
|
344
335
|
#
|
345
|
-
# Queue URLs are case-sensitive.
|
336
|
+
# Queue URLs and names are case-sensitive.
|
346
337
|
#
|
347
338
|
# @option params [required, String] :receipt_handle
|
348
339
|
# The receipt handle associated with the message whose visibility
|
@@ -382,21 +373,19 @@ module Aws::SQS
|
|
382
373
|
# and unsuccessful actions, you should check for batch errors even when
|
383
374
|
# the call returns an HTTP status code of `200`.
|
384
375
|
#
|
385
|
-
#
|
376
|
+
# Some actions take lists of parameters. These lists are specified using
|
386
377
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
387
378
|
# For example, a parameter list with two elements looks like this:
|
388
379
|
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
# `&Attribute.2=that`
|
380
|
+
# `&Attribute.1=first`
|
392
381
|
#
|
393
|
-
#
|
382
|
+
# `&Attribute.2=second`
|
394
383
|
#
|
395
384
|
# @option params [required, String] :queue_url
|
396
385
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
397
386
|
# changed.
|
398
387
|
#
|
399
|
-
# Queue URLs are case-sensitive.
|
388
|
+
# Queue URLs and names are case-sensitive.
|
400
389
|
#
|
401
390
|
# @option params [required, Array<Types::ChangeMessageVisibilityBatchRequestEntry>] :entries
|
402
391
|
# A list of receipt handles of the messages for which the visibility
|
@@ -449,7 +438,7 @@ module Aws::SQS
|
|
449
438
|
# convert an existing standard queue into a FIFO queue. You must
|
450
439
|
# either create a new FIFO queue for your application or delete your
|
451
440
|
# existing standard queue and recreate it as a FIFO queue. For more
|
452
|
-
# information, see [
|
441
|
+
# information, see [Moving From a Standard Queue to a FIFO Queue][1]
|
453
442
|
# in the *Amazon Simple Queue Service Developer Guide*.
|
454
443
|
#
|
455
444
|
# </note>
|
@@ -475,13 +464,17 @@ module Aws::SQS
|
|
475
464
|
# * If the queue name, attribute names, or attribute values don't match
|
476
465
|
# an existing queue, `CreateQueue` returns an error.
|
477
466
|
#
|
478
|
-
#
|
467
|
+
# Some actions take lists of parameters. These lists are specified using
|
479
468
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
480
469
|
# For example, a parameter list with two elements looks like this:
|
481
470
|
#
|
482
|
-
#
|
471
|
+
# `&Attribute.1=first`
|
472
|
+
#
|
473
|
+
# `&Attribute.2=second`
|
483
474
|
#
|
484
|
-
#
|
475
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
476
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
477
|
+
# User Name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
485
478
|
#
|
486
479
|
# </note>
|
487
480
|
#
|
@@ -489,6 +482,7 @@ module Aws::SQS
|
|
489
482
|
#
|
490
483
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving
|
491
484
|
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html
|
485
|
+
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
492
486
|
#
|
493
487
|
# @option params [required, String] :queue_name
|
494
488
|
# The name of the new queue. The following limits apply to this name:
|
@@ -500,7 +494,7 @@ module Aws::SQS
|
|
500
494
|
#
|
501
495
|
# * A FIFO queue name must end with the `.fifo` suffix.
|
502
496
|
#
|
503
|
-
# Queue names are case-sensitive.
|
497
|
+
# Queue URLs and names are case-sensitive.
|
504
498
|
#
|
505
499
|
# @option params [Hash<String,String>] :attributes
|
506
500
|
# A map of attributes with their corresponding values.
|
@@ -510,17 +504,17 @@ module Aws::SQS
|
|
510
504
|
#
|
511
505
|
# * `DelaySeconds` - The length of time, in seconds, for which the
|
512
506
|
# delivery of all messages in the queue is delayed. Valid values: An
|
513
|
-
# integer from 0 to 900 seconds (15 minutes).
|
507
|
+
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
514
508
|
#
|
515
509
|
# * `MaximumMessageSize` - The limit of how many bytes a message can
|
516
510
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
517
|
-
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB).
|
518
|
-
#
|
511
|
+
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
|
512
|
+
# (256 KiB).
|
519
513
|
#
|
520
514
|
# * `MessageRetentionPeriod` - The length of time, in seconds, for which
|
521
515
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
522
|
-
# seconds (1 minute) to 1,209,600 seconds (14 days).
|
523
|
-
#
|
516
|
+
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
517
|
+
# (4 days).
|
524
518
|
#
|
525
519
|
# * `Policy` - The queue's policy. A valid AWS policy. For more
|
526
520
|
# information about policy structure, see [Overview of AWS IAM
|
@@ -528,8 +522,7 @@ module Aws::SQS
|
|
528
522
|
#
|
529
523
|
# * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
|
530
524
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
531
|
-
# Valid values: An integer from 0 to 20 (seconds).
|
532
|
-
# (zero).
|
525
|
+
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
533
526
|
#
|
534
527
|
# * `RedrivePolicy` - The string that includes the parameters for the
|
535
528
|
# dead-letter queue functionality of the source queue. For more
|
@@ -542,7 +535,9 @@ module Aws::SQS
|
|
542
535
|
# value of `maxReceiveCount` is exceeded.
|
543
536
|
#
|
544
537
|
# * `maxReceiveCount` - The number of times a message is delivered to
|
545
|
-
# the source queue before being moved to the dead-letter queue.
|
538
|
+
# the source queue before being moved to the dead-letter queue. When
|
539
|
+
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
540
|
+
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
546
541
|
#
|
547
542
|
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
548
543
|
# Similarly, the dead-letter queue of a standard queue must also be a
|
@@ -550,10 +545,11 @@ module Aws::SQS
|
|
550
545
|
#
|
551
546
|
# </note>
|
552
547
|
#
|
553
|
-
# * `VisibilityTimeout` - The visibility timeout for the queue
|
554
|
-
# values: An integer from 0 to 43,200 (12 hours).
|
555
|
-
# For more information about the visibility timeout, see
|
556
|
-
# Timeout][3] in the *Amazon Simple Queue Service
|
548
|
+
# * `VisibilityTimeout` - The visibility timeout for the queue, in
|
549
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
550
|
+
# Default: 30. For more information about the visibility timeout, see
|
551
|
+
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
552
|
+
# Developer Guide*.
|
557
553
|
#
|
558
554
|
# The following attributes apply only to [server-side-encryption][4]\:
|
559
555
|
#
|
@@ -568,10 +564,10 @@ module Aws::SQS
|
|
568
564
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
569
565
|
# messages before calling AWS KMS again. An integer representing
|
570
566
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
571
|
-
# hours).
|
572
|
-
#
|
573
|
-
#
|
574
|
-
#
|
567
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
568
|
+
# better security but results in more calls to KMS which might incur
|
569
|
+
# charges after Free Tier. For more information, see [How Does the
|
570
|
+
# Data Key Reuse Period Work?][8].
|
575
571
|
#
|
576
572
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
577
573
|
# queues][9]\:
|
@@ -618,21 +614,6 @@ module Aws::SQS
|
|
618
614
|
# `MessageDeduplicationId`, the two messages are treated as
|
619
615
|
# duplicates and only one copy of the message is delivered.
|
620
616
|
#
|
621
|
-
# Any other valid special request parameters (such as the following) are
|
622
|
-
# ignored:
|
623
|
-
#
|
624
|
-
# * `ApproximateNumberOfMessages`
|
625
|
-
#
|
626
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
627
|
-
#
|
628
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
629
|
-
#
|
630
|
-
# * `CreatedTimestamp`
|
631
|
-
#
|
632
|
-
# * `LastModifiedTimestamp`
|
633
|
-
#
|
634
|
-
# * `QueueArn`
|
635
|
-
#
|
636
617
|
#
|
637
618
|
#
|
638
619
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -673,27 +654,27 @@ module Aws::SQS
|
|
673
654
|
req.send_request(options)
|
674
655
|
end
|
675
656
|
|
676
|
-
# Deletes the specified message from the specified queue.
|
677
|
-
#
|
678
|
-
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
#
|
682
|
-
#
|
683
|
-
#
|
684
|
-
# <note markdown="1"> The
|
685
|
-
#
|
686
|
-
#
|
687
|
-
#
|
688
|
-
#
|
689
|
-
# but the message might not be deleted.
|
657
|
+
# Deletes the specified message from the specified queue. To select the
|
658
|
+
# message to delete, use the `ReceiptHandle` of the message (*not* the
|
659
|
+
# `MessageId` which you receive when you send the message). Amazon SQS
|
660
|
+
# can delete a message from a queue even if a visibility timeout setting
|
661
|
+
# causes the message to be locked by another consumer. Amazon SQS
|
662
|
+
# automatically deletes messages left in a queue longer than the
|
663
|
+
# retention period configured for the queue.
|
664
|
+
#
|
665
|
+
# <note markdown="1"> The `ReceiptHandle` is associated with a *specific instance* of
|
666
|
+
# receiving a message. If you receive a message more than once, the
|
667
|
+
# `ReceiptHandle` is different each time you receive a message. When you
|
668
|
+
# use the `DeleteMessage` action, you must provide the most recently
|
669
|
+
# received `ReceiptHandle` for the message (otherwise, the request
|
670
|
+
# succeeds, but the message might not be deleted).
|
690
671
|
#
|
691
672
|
# For standard queues, it is possible to receive a message even after
|
692
673
|
# you delete it. This might happen on rare occasions if one of the
|
693
|
-
# servers
|
694
|
-
# request to delete the message. The copy remains on the server
|
695
|
-
# might be returned to you
|
696
|
-
# ensure that your application is idempotent, so that receiving a
|
674
|
+
# servers which stores a copy of the message is unavailable when you
|
675
|
+
# send the request to delete the message. The copy remains on the server
|
676
|
+
# and might be returned to you during a subsequent receive request. You
|
677
|
+
# should ensure that your application is idempotent, so that receiving a
|
697
678
|
# message more than once does not cause issues.
|
698
679
|
#
|
699
680
|
# </note>
|
@@ -701,7 +682,7 @@ module Aws::SQS
|
|
701
682
|
# @option params [required, String] :queue_url
|
702
683
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
703
684
|
#
|
704
|
-
# Queue URLs are case-sensitive.
|
685
|
+
# Queue URLs and names are case-sensitive.
|
705
686
|
#
|
706
687
|
# @option params [required, String] :receipt_handle
|
707
688
|
# The receipt handle associated with the message to delete.
|
@@ -732,20 +713,18 @@ module Aws::SQS
|
|
732
713
|
# and unsuccessful actions, you should check for batch errors even when
|
733
714
|
# the call returns an HTTP status code of `200`.
|
734
715
|
#
|
735
|
-
#
|
716
|
+
# Some actions take lists of parameters. These lists are specified using
|
736
717
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
737
718
|
# For example, a parameter list with two elements looks like this:
|
738
719
|
#
|
739
|
-
#
|
720
|
+
# `&Attribute.1=first`
|
740
721
|
#
|
741
|
-
#
|
742
|
-
#
|
743
|
-
# </note>
|
722
|
+
# `&Attribute.2=second`
|
744
723
|
#
|
745
724
|
# @option params [required, String] :queue_url
|
746
725
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
747
726
|
#
|
748
|
-
# Queue URLs are case-sensitive.
|
727
|
+
# Queue URLs and names are case-sensitive.
|
749
728
|
#
|
750
729
|
# @option params [required, Array<Types::DeleteMessageBatchRequestEntry>] :entries
|
751
730
|
# A list of receipt handles for the messages to be deleted.
|
@@ -801,10 +780,20 @@ module Aws::SQS
|
|
801
780
|
# When you delete a queue, you must wait at least 60 seconds before
|
802
781
|
# creating a queue with the same name.
|
803
782
|
#
|
783
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
784
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
785
|
+
# User Name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
786
|
+
#
|
787
|
+
# </note>
|
788
|
+
#
|
789
|
+
#
|
790
|
+
#
|
791
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
792
|
+
#
|
804
793
|
# @option params [required, String] :queue_url
|
805
794
|
# The URL of the Amazon SQS queue to delete.
|
806
795
|
#
|
807
|
-
# Queue URLs are case-sensitive.
|
796
|
+
# Queue URLs and names are case-sensitive.
|
808
797
|
#
|
809
798
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
810
799
|
#
|
@@ -830,15 +819,13 @@ module Aws::SQS
|
|
830
819
|
#
|
831
820
|
# </note>
|
832
821
|
#
|
833
|
-
#
|
822
|
+
# Some actions take lists of parameters. These lists are specified using
|
834
823
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
835
824
|
# For example, a parameter list with two elements looks like this:
|
836
825
|
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
# `&Attribute.2=that`
|
826
|
+
# `&Attribute.1=first`
|
840
827
|
#
|
841
|
-
#
|
828
|
+
# `&Attribute.2=second`
|
842
829
|
#
|
843
830
|
#
|
844
831
|
#
|
@@ -848,7 +835,7 @@ module Aws::SQS
|
|
848
835
|
# The URL of the Amazon SQS queue whose attribute information is
|
849
836
|
# retrieved.
|
850
837
|
#
|
851
|
-
# Queue URLs are case-sensitive.
|
838
|
+
# Queue URLs and names are case-sensitive.
|
852
839
|
#
|
853
840
|
# @option params [Array<String>] :attribute_names
|
854
841
|
# A list of attributes for which to retrieve information.
|
@@ -864,25 +851,26 @@ module Aws::SQS
|
|
864
851
|
# * `All` - Returns all values.
|
865
852
|
#
|
866
853
|
# * `ApproximateNumberOfMessages` - Returns the approximate number of
|
867
|
-
#
|
868
|
-
# Required to Process Messages][1] in the *Amazon Simple Queue Service
|
869
|
-
# Developer Guide*.
|
854
|
+
# messages available for retrieval from the queue.
|
870
855
|
#
|
871
856
|
# * `ApproximateNumberOfMessagesDelayed` - Returns the approximate
|
872
|
-
# number of messages
|
857
|
+
# number of messages in the queue that are delayed and not available
|
858
|
+
# for reading immediately. This can happen when the queue is
|
859
|
+
# configured as a delay queue or when a message has been sent with a
|
860
|
+
# delay parameter.
|
873
861
|
#
|
874
862
|
# * `ApproximateNumberOfMessagesNotVisible` - Returns the approximate
|
875
|
-
# number of messages that
|
876
|
-
#
|
877
|
-
# the
|
863
|
+
# number of messages that are in flight. Messages are considered to be
|
864
|
+
# *in flight* if they have been sent to a client but have not yet been
|
865
|
+
# deleted or have not yet reached the end of their visibility window.
|
878
866
|
#
|
879
867
|
# * `CreatedTimestamp` - Returns the time when the queue was created in
|
880
|
-
# seconds ([epoch time][
|
868
|
+
# seconds ([epoch time][1]).
|
881
869
|
#
|
882
870
|
# * `DelaySeconds` - Returns the default delay on the queue in seconds.
|
883
871
|
#
|
884
872
|
# * `LastModifiedTimestamp` - Returns the time when the queue was last
|
885
|
-
# changed in seconds ([epoch time][
|
873
|
+
# changed in seconds ([epoch time][1]).
|
886
874
|
#
|
887
875
|
# * `MaximumMessageSize` - Returns the limit of how many bytes a message
|
888
876
|
# can contain before Amazon SQS rejects it.
|
@@ -901,7 +889,7 @@ module Aws::SQS
|
|
901
889
|
# * `RedrivePolicy` - Returns the string that includes the parameters
|
902
890
|
# for dead-letter queue functionality of the source queue. For more
|
903
891
|
# information about the redrive policy and dead-letter queues, see
|
904
|
-
# [Using Amazon SQS Dead-Letter Queues][
|
892
|
+
# [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple Queue
|
905
893
|
# Service Developer Guide*.
|
906
894
|
#
|
907
895
|
# * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
|
@@ -909,52 +897,53 @@ module Aws::SQS
|
|
909
897
|
# value of `maxReceiveCount` is exceeded.
|
910
898
|
#
|
911
899
|
# * `maxReceiveCount` - The number of times a message is delivered to
|
912
|
-
# the source queue before being moved to the dead-letter queue.
|
900
|
+
# the source queue before being moved to the dead-letter queue. When
|
901
|
+
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
902
|
+
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
913
903
|
#
|
914
904
|
# * `VisibilityTimeout` - Returns the visibility timeout for the queue.
|
915
905
|
# For more information about the visibility timeout, see [Visibility
|
916
|
-
# Timeout][
|
906
|
+
# Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
|
917
907
|
#
|
918
|
-
# The following attributes apply only to [server-side-encryption][
|
908
|
+
# The following attributes apply only to [server-side-encryption][4]\:
|
919
909
|
#
|
920
910
|
# * `KmsMasterKeyId` - Returns the ID of an AWS-managed customer master
|
921
911
|
# key (CMK) for Amazon SQS or a custom CMK. For more information, see
|
922
|
-
# [Key Terms][
|
912
|
+
# [Key Terms][5].
|
923
913
|
#
|
924
914
|
# * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
|
925
915
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
926
916
|
# decrypt messages before calling AWS KMS again. For more information,
|
927
|
-
# see [How Does the Data Key Reuse Period Work?][
|
917
|
+
# see [How Does the Data Key Reuse Period Work?][6].
|
928
918
|
#
|
929
919
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
930
|
-
# queues][
|
920
|
+
# queues][7]\:
|
931
921
|
#
|
932
922
|
# * `FifoQueue` - Returns whether the queue is FIFO. For more
|
933
|
-
# information, see [FIFO Queue Logic][
|
923
|
+
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
934
924
|
# Service Developer Guide*.
|
935
925
|
#
|
936
|
-
# <note markdown="1"> To determine whether a queue is [FIFO][
|
926
|
+
# <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
|
937
927
|
# `QueueName` ends with the `.fifo` suffix.
|
938
928
|
#
|
939
929
|
# </note>
|
940
930
|
#
|
941
931
|
# * `ContentBasedDeduplication` - Returns whether content-based
|
942
932
|
# deduplication is enabled for the queue. For more information, see
|
943
|
-
# [Exactly-Once Processing][
|
933
|
+
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
944
934
|
# Developer Guide*.
|
945
935
|
#
|
946
936
|
#
|
947
937
|
#
|
948
|
-
# [1]: http://
|
949
|
-
# [2]: http://
|
950
|
-
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
951
|
-
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
952
|
-
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
953
|
-
# [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-
|
954
|
-
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
955
|
-
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
956
|
-
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-
|
957
|
-
# [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
938
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
939
|
+
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
940
|
+
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
941
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
942
|
+
# [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
943
|
+
# [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
944
|
+
# [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
945
|
+
# [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
946
|
+
# [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
958
947
|
#
|
959
948
|
# @return [Types::GetQueueAttributesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
960
949
|
#
|
@@ -981,26 +970,25 @@ module Aws::SQS
|
|
981
970
|
req.send_request(options)
|
982
971
|
end
|
983
972
|
|
984
|
-
# Returns the URL of an existing queue.
|
985
|
-
# way to retrieve the URL of an Amazon SQS queue.
|
973
|
+
# Returns the URL of an existing Amazon SQS queue.
|
986
974
|
#
|
987
975
|
# To access a queue that belongs to another AWS account, use the
|
988
976
|
# `QueueOwnerAWSAccountId` parameter to specify the account ID of the
|
989
977
|
# queue's owner. The queue's owner must grant you permission to access
|
990
978
|
# the queue. For more information about shared queue access, see `
|
991
|
-
# AddPermission ` or see [
|
992
|
-
# Service Developer Guide*.
|
979
|
+
# AddPermission ` or see [Allow Developers to Write Messages to a Shared
|
980
|
+
# Queue][1] in the *Amazon Simple Queue Service Developer Guide*.
|
993
981
|
#
|
994
982
|
#
|
995
983
|
#
|
996
|
-
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
984
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue
|
997
985
|
#
|
998
986
|
# @option params [required, String] :queue_name
|
999
987
|
# The name of the queue whose URL must be fetched. Maximum 80
|
1000
988
|
# characters. Valid values: alphanumeric characters, hyphens (`-`), and
|
1001
989
|
# underscores (`_`).
|
1002
990
|
#
|
1003
|
-
# Queue names are case-sensitive.
|
991
|
+
# Queue URLs and names are case-sensitive.
|
1004
992
|
#
|
1005
993
|
# @option params [String] :queue_owner_aws_account_id
|
1006
994
|
# The AWS account ID of the account that created the queue.
|
@@ -1043,7 +1031,7 @@ module Aws::SQS
|
|
1043
1031
|
# @option params [required, String] :queue_url
|
1044
1032
|
# The URL of a dead-letter queue.
|
1045
1033
|
#
|
1046
|
-
# Queue URLs are case-sensitive.
|
1034
|
+
# Queue URLs and names are case-sensitive.
|
1047
1035
|
#
|
1048
1036
|
# @return [Types::ListDeadLetterSourceQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1049
1037
|
#
|
@@ -1070,8 +1058,8 @@ module Aws::SQS
|
|
1070
1058
|
end
|
1071
1059
|
|
1072
1060
|
# List all cost allocation tags added to the specified Amazon SQS queue.
|
1073
|
-
# For an overview, see [Tagging Amazon SQS Queues][1] in the
|
1074
|
-
# Simple Queue Service Developer Guide*.
|
1061
|
+
# For an overview, see [Tagging Your Amazon SQS Queues][1] in the
|
1062
|
+
# *Amazon Simple Queue Service Developer Guide*.
|
1075
1063
|
#
|
1076
1064
|
# When you use queue tags, keep the following guidelines in mind:
|
1077
1065
|
#
|
@@ -1085,18 +1073,25 @@ module Aws::SQS
|
|
1085
1073
|
# * A new tag with a key identical to that of an existing tag overwrites
|
1086
1074
|
# the existing tag.
|
1087
1075
|
#
|
1088
|
-
# * Tagging
|
1076
|
+
# * Tagging actions are limited to 5 TPS per AWS account. If your
|
1089
1077
|
# application requires a higher throughput, file a [technical support
|
1090
1078
|
# request][2].
|
1091
1079
|
#
|
1092
1080
|
# For a full list of tag restrictions, see [Limits Related to Queues][3]
|
1093
1081
|
# in the *Amazon Simple Queue Service Developer Guide*.
|
1094
1082
|
#
|
1083
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1084
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
1085
|
+
# User Name][4] in the *Amazon Simple Queue Service Developer Guide*.
|
1086
|
+
#
|
1087
|
+
# </note>
|
1088
|
+
#
|
1095
1089
|
#
|
1096
1090
|
#
|
1097
|
-
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
1091
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html
|
1098
1092
|
# [2]: https://console.aws.amazon.com/support/home#/case/create?issueType=technical
|
1099
|
-
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues
|
1093
|
+
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues
|
1094
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
1100
1095
|
#
|
1101
1096
|
# @option params [required, String] :queue_url
|
1102
1097
|
# The URL of the queue.
|
@@ -1130,11 +1125,21 @@ module Aws::SQS
|
|
1130
1125
|
# `QueueNamePrefix` parameter, only queues with a name that begins with
|
1131
1126
|
# the specified value are returned.
|
1132
1127
|
#
|
1128
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1129
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
1130
|
+
# User Name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
1131
|
+
#
|
1132
|
+
# </note>
|
1133
|
+
#
|
1134
|
+
#
|
1135
|
+
#
|
1136
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
1137
|
+
#
|
1133
1138
|
# @option params [String] :queue_name_prefix
|
1134
1139
|
# A string to use for filtering the list results. Only those queues
|
1135
1140
|
# whose name begins with the specified string are returned.
|
1136
1141
|
#
|
1137
|
-
# Queue names are case-sensitive.
|
1142
|
+
# Queue URLs and names are case-sensitive.
|
1138
1143
|
#
|
1139
1144
|
# @return [Types::ListQueuesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1140
1145
|
#
|
@@ -1162,21 +1167,23 @@ module Aws::SQS
|
|
1162
1167
|
|
1163
1168
|
# Deletes the messages in a queue specified by the `QueueURL` parameter.
|
1164
1169
|
#
|
1165
|
-
# When you use the `PurgeQueue` action, you can't retrieve
|
1170
|
+
# When you use the `PurgeQueue` action, you can't retrieve any messages
|
1166
1171
|
# deleted from a queue.
|
1167
1172
|
#
|
1168
|
-
#
|
1169
|
-
#
|
1170
|
-
#
|
1171
|
-
#
|
1172
|
-
#
|
1173
|
-
#
|
1173
|
+
# The message deletion process takes up to 60 seconds. We recommend
|
1174
|
+
# waiting for 60 seconds regardless of your queue's size.
|
1175
|
+
#
|
1176
|
+
# Messages sent to the queue *before* you call `PurgeQueue` might be
|
1177
|
+
# received but are deleted within the next minute.
|
1178
|
+
#
|
1179
|
+
# Messages sent to the queue *after* you call `PurgeQueue` might be
|
1180
|
+
# deleted while the queue is being purged.
|
1174
1181
|
#
|
1175
1182
|
# @option params [required, String] :queue_url
|
1176
1183
|
# The URL of the queue from which the `PurgeQueue` action deletes
|
1177
1184
|
# messages.
|
1178
1185
|
#
|
1179
|
-
# Queue URLs are case-sensitive.
|
1186
|
+
# Queue URLs and names are case-sensitive.
|
1180
1187
|
#
|
1181
1188
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1182
1189
|
#
|
@@ -1256,11 +1263,11 @@ module Aws::SQS
|
|
1256
1263
|
# @option params [required, String] :queue_url
|
1257
1264
|
# The URL of the Amazon SQS queue from which messages are received.
|
1258
1265
|
#
|
1259
|
-
# Queue URLs are case-sensitive.
|
1266
|
+
# Queue URLs and names are case-sensitive.
|
1260
1267
|
#
|
1261
1268
|
# @option params [Array<String>] :attribute_names
|
1262
|
-
# A list of
|
1263
|
-
#
|
1269
|
+
# A list of s that need to be returned along with each message. These
|
1270
|
+
# attributes include:
|
1264
1271
|
#
|
1265
1272
|
# * `All` - Returns all values.
|
1266
1273
|
#
|
@@ -1281,48 +1288,15 @@ module Aws::SQS
|
|
1281
1288
|
# * `SentTimestamp` - Returns the time the message was sent to the queue
|
1282
1289
|
# ([epoch time][1] in milliseconds).
|
1283
1290
|
#
|
1284
|
-
# * `MessageDeduplicationId` - Returns the value provided by the
|
1285
|
-
# that calls the ` SendMessage ` action.
|
1291
|
+
# * `MessageDeduplicationId` - Returns the value provided by the
|
1292
|
+
# producer that calls the ` SendMessage ` action.
|
1286
1293
|
#
|
1287
|
-
# * `MessageGroupId` - Returns the value provided by the
|
1294
|
+
# * `MessageGroupId` - Returns the value provided by the producer that
|
1288
1295
|
# calls the ` SendMessage ` action. Messages with the same
|
1289
1296
|
# `MessageGroupId` are returned in sequence.
|
1290
1297
|
#
|
1291
1298
|
# * `SequenceNumber` - Returns the value provided by Amazon SQS.
|
1292
1299
|
#
|
1293
|
-
# Any other valid special request parameters (such as the following) are
|
1294
|
-
# ignored:
|
1295
|
-
#
|
1296
|
-
# * `ApproximateNumberOfMessages`
|
1297
|
-
#
|
1298
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
1299
|
-
#
|
1300
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
1301
|
-
#
|
1302
|
-
# * `CreatedTimestamp`
|
1303
|
-
#
|
1304
|
-
# * `ContentBasedDeduplication`
|
1305
|
-
#
|
1306
|
-
# * `DelaySeconds`
|
1307
|
-
#
|
1308
|
-
# * `FifoQueue`
|
1309
|
-
#
|
1310
|
-
# * `LastModifiedTimestamp`
|
1311
|
-
#
|
1312
|
-
# * `MaximumMessageSize`
|
1313
|
-
#
|
1314
|
-
# * `MessageRetentionPeriod`
|
1315
|
-
#
|
1316
|
-
# * `Policy`
|
1317
|
-
#
|
1318
|
-
# * `QueueArn`,
|
1319
|
-
#
|
1320
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
1321
|
-
#
|
1322
|
-
# * `RedrivePolicy`
|
1323
|
-
#
|
1324
|
-
# * `VisibilityTimeout`
|
1325
|
-
#
|
1326
1300
|
#
|
1327
1301
|
#
|
1328
1302
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
@@ -1352,7 +1326,7 @@ module Aws::SQS
|
|
1352
1326
|
# @option params [Integer] :max_number_of_messages
|
1353
1327
|
# The maximum number of messages to return. Amazon SQS never returns
|
1354
1328
|
# more messages than this value (however, fewer messages might be
|
1355
|
-
# returned). Valid values
|
1329
|
+
# returned). Valid values: 1 to 10. Default: 1.
|
1356
1330
|
#
|
1357
1331
|
# @option params [Integer] :visibility_timeout
|
1358
1332
|
# The duration (in seconds) that the received messages are hidden from
|
@@ -1396,13 +1370,12 @@ module Aws::SQS
|
|
1396
1370
|
# resets the visibility timeout. For more information, see [Visibility
|
1397
1371
|
# Timeout][1] in the *Amazon Simple Queue Service Developer Guide*.
|
1398
1372
|
#
|
1399
|
-
# If a caller of the `ReceiveMessage` action
|
1400
|
-
#
|
1401
|
-
#
|
1402
|
-
#
|
1403
|
-
#
|
1404
|
-
#
|
1405
|
-
# error.
|
1373
|
+
# If a caller of the `ReceiveMessage` action still processes messages
|
1374
|
+
# when the visibility timeout expires and messages become visible,
|
1375
|
+
# another worker consuming from the same queue can receive the same
|
1376
|
+
# messages and therefore process duplicates. Also, if a consumer whose
|
1377
|
+
# message processing time is longer than the visibility timeout tries
|
1378
|
+
# to delete the processed messages, the action fails with an error.
|
1406
1379
|
#
|
1407
1380
|
# To mitigate this effect, ensure that your application observes a
|
1408
1381
|
# safe threshold before the visibility timeout expires and extend the
|
@@ -1430,7 +1403,7 @@ module Aws::SQS
|
|
1430
1403
|
#
|
1431
1404
|
#
|
1432
1405
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1433
|
-
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1406
|
+
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html
|
1434
1407
|
#
|
1435
1408
|
# @return [Types::ReceiveMessageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1436
1409
|
#
|
@@ -1477,12 +1450,24 @@ module Aws::SQS
|
|
1477
1450
|
end
|
1478
1451
|
|
1479
1452
|
# Revokes any permissions in the queue policy that matches the specified
|
1480
|
-
# `Label` parameter.
|
1453
|
+
# `Label` parameter.
|
1454
|
+
#
|
1455
|
+
# <note markdown="1"> Only the owner of a queue can remove permissions from it.
|
1456
|
+
#
|
1457
|
+
# Cross-account permissions don't apply to this action. For more
|
1458
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
1459
|
+
# User Name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
1460
|
+
#
|
1461
|
+
# </note>
|
1462
|
+
#
|
1463
|
+
#
|
1464
|
+
#
|
1465
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
1481
1466
|
#
|
1482
1467
|
# @option params [required, String] :queue_url
|
1483
1468
|
# The URL of the Amazon SQS queue from which permissions are removed.
|
1484
1469
|
#
|
1485
|
-
# Queue URLs are case-sensitive.
|
1470
|
+
# Queue URLs and names are case-sensitive.
|
1486
1471
|
#
|
1487
1472
|
# @option params [required, String] :label
|
1488
1473
|
# The identification of the permission to remove. This is the label
|
@@ -1524,7 +1509,7 @@ module Aws::SQS
|
|
1524
1509
|
# @option params [required, String] :queue_url
|
1525
1510
|
# The URL of the Amazon SQS queue to which a message is sent.
|
1526
1511
|
#
|
1527
|
-
# Queue URLs are case-sensitive.
|
1512
|
+
# Queue URLs and names are case-sensitive.
|
1528
1513
|
#
|
1529
1514
|
# @option params [required, String] :message_body
|
1530
1515
|
# The message to send. The maximum string size is 256 KB.
|
@@ -1556,12 +1541,12 @@ module Aws::SQS
|
|
1556
1541
|
#
|
1557
1542
|
# @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
1558
1543
|
# Each message attribute consists of a `Name`, `Type`, and `Value`. For
|
1559
|
-
# more information, see [
|
1560
|
-
#
|
1544
|
+
# more information, see [Amazon SQS Message Attributes][1] in the
|
1545
|
+
# *Amazon Simple Queue Service Developer Guide*.
|
1561
1546
|
#
|
1562
1547
|
#
|
1563
1548
|
#
|
1564
|
-
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
|
1549
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
|
1565
1550
|
#
|
1566
1551
|
# @option params [String] :message_deduplication_id
|
1567
1552
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
@@ -1599,13 +1584,16 @@ module Aws::SQS
|
|
1599
1584
|
# the two messages are treated as duplicates and only one copy of the
|
1600
1585
|
# message is delivered.
|
1601
1586
|
#
|
1602
|
-
# <note markdown="1"> The `MessageDeduplicationId` is available to the
|
1587
|
+
# <note markdown="1"> The `MessageDeduplicationId` is available to the consumer of the
|
1603
1588
|
# message (this can be useful for troubleshooting delivery issues).
|
1604
1589
|
#
|
1605
1590
|
# If a message is sent successfully but the acknowledgement is lost and
|
1606
1591
|
# the message is resent with the same `MessageDeduplicationId` after the
|
1607
1592
|
# deduplication interval, Amazon SQS can't detect duplicate messages.
|
1608
1593
|
#
|
1594
|
+
# Amazon SQS continues to keep track of the message deduplication ID
|
1595
|
+
# even after the message is received and deleted.
|
1596
|
+
#
|
1609
1597
|
# </note>
|
1610
1598
|
#
|
1611
1599
|
# The length of `MessageDeduplicationId` is 128 characters.
|
@@ -1620,7 +1608,7 @@ module Aws::SQS
|
|
1620
1608
|
#
|
1621
1609
|
#
|
1622
1610
|
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
1623
|
-
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1611
|
+
# [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
1624
1612
|
#
|
1625
1613
|
# @option params [String] :message_group_id
|
1626
1614
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
@@ -1630,7 +1618,7 @@ module Aws::SQS
|
|
1630
1618
|
# a FIFO manner (however, messages in different message groups might be
|
1631
1619
|
# processed out of order). To interleave multiple ordered streams within
|
1632
1620
|
# a single queue, use `MessageGroupId` values (for example, session data
|
1633
|
-
# for multiple users). In this scenario, multiple
|
1621
|
+
# for multiple users). In this scenario, multiple consumers can process
|
1634
1622
|
# the queue, but the session data of each user is processed in a FIFO
|
1635
1623
|
# fashion.
|
1636
1624
|
#
|
@@ -1641,7 +1629,7 @@ module Aws::SQS
|
|
1641
1629
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
1642
1630
|
# sorted by time sent. The caller can't specify a `MessageGroupId`.
|
1643
1631
|
#
|
1644
|
-
# The length of `MessageGroupId` is 128 characters. Valid values
|
1632
|
+
# The length of `MessageGroupId` is 128 characters. Valid values:
|
1645
1633
|
# alphanumeric characters and punctuation ``
|
1646
1634
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
|
1647
1635
|
#
|
@@ -1654,7 +1642,7 @@ module Aws::SQS
|
|
1654
1642
|
#
|
1655
1643
|
#
|
1656
1644
|
#
|
1657
|
-
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/
|
1645
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
1658
1646
|
#
|
1659
1647
|
# @return [Types::SendMessageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1660
1648
|
#
|
@@ -1723,15 +1711,13 @@ module Aws::SQS
|
|
1723
1711
|
# If you don't specify the `DelaySeconds` parameter for an entry,
|
1724
1712
|
# Amazon SQS uses the default value for the queue.
|
1725
1713
|
#
|
1726
|
-
#
|
1714
|
+
# Some actions take lists of parameters. These lists are specified using
|
1727
1715
|
# the `param.n` notation. Values of `n` are integers starting from 1.
|
1728
1716
|
# For example, a parameter list with two elements looks like this:
|
1729
1717
|
#
|
1730
|
-
#
|
1718
|
+
# `&Attribute.1=first`
|
1731
1719
|
#
|
1732
|
-
#
|
1733
|
-
#
|
1734
|
-
# </note>
|
1720
|
+
# `&Attribute.2=second`
|
1735
1721
|
#
|
1736
1722
|
#
|
1737
1723
|
#
|
@@ -1740,7 +1726,7 @@ module Aws::SQS
|
|
1740
1726
|
# @option params [required, String] :queue_url
|
1741
1727
|
# The URL of the Amazon SQS queue to which batched messages are sent.
|
1742
1728
|
#
|
1743
|
-
# Queue URLs are case-sensitive.
|
1729
|
+
# Queue URLs and names are case-sensitive.
|
1744
1730
|
#
|
1745
1731
|
# @option params [required, Array<Types::SendMessageBatchRequestEntry>] :entries
|
1746
1732
|
# A list of ` SendMessageBatchRequestEntry ` items.
|
@@ -1807,12 +1793,20 @@ module Aws::SQS
|
|
1807
1793
|
# calls this action, we recommend that you structure your code so that
|
1808
1794
|
# it can handle new attributes gracefully.
|
1809
1795
|
#
|
1796
|
+
# Cross-account permissions don't apply to this action. For more
|
1797
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
1798
|
+
# User Name][1] in the *Amazon Simple Queue Service Developer Guide*.
|
1799
|
+
#
|
1810
1800
|
# </note>
|
1811
1801
|
#
|
1802
|
+
#
|
1803
|
+
#
|
1804
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
1805
|
+
#
|
1812
1806
|
# @option params [required, String] :queue_url
|
1813
1807
|
# The URL of the Amazon SQS queue whose attributes are set.
|
1814
1808
|
#
|
1815
|
-
# Queue URLs are case-sensitive.
|
1809
|
+
# Queue URLs and names are case-sensitive.
|
1816
1810
|
#
|
1817
1811
|
# @option params [required, Hash<String,String>] :attributes
|
1818
1812
|
# A map of attributes to set.
|
@@ -1822,17 +1816,17 @@ module Aws::SQS
|
|
1822
1816
|
#
|
1823
1817
|
# * `DelaySeconds` - The length of time, in seconds, for which the
|
1824
1818
|
# delivery of all messages in the queue is delayed. Valid values: An
|
1825
|
-
# integer from 0 to 900 (15 minutes).
|
1819
|
+
# integer from 0 to 900 (15 minutes). Default: 0.
|
1826
1820
|
#
|
1827
1821
|
# * `MaximumMessageSize` - The limit of how many bytes a message can
|
1828
1822
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
1829
|
-
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB).
|
1830
|
-
#
|
1823
|
+
# 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default: 262,144
|
1824
|
+
# (256 KiB).
|
1831
1825
|
#
|
1832
1826
|
# * `MessageRetentionPeriod` - The length of time, in seconds, for which
|
1833
1827
|
# Amazon SQS retains a message. Valid values: An integer representing
|
1834
|
-
# seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
1835
|
-
#
|
1828
|
+
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
1829
|
+
# (4 days).
|
1836
1830
|
#
|
1837
1831
|
# * `Policy` - The queue's policy. A valid AWS policy. For more
|
1838
1832
|
# information about policy structure, see [Overview of AWS IAM
|
@@ -1840,7 +1834,7 @@ module Aws::SQS
|
|
1840
1834
|
#
|
1841
1835
|
# * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
|
1842
1836
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
1843
|
-
# Valid values: an integer from 0 to 20 (seconds).
|
1837
|
+
# Valid values: an integer from 0 to 20 (seconds). Default: 0.
|
1844
1838
|
#
|
1845
1839
|
# * `RedrivePolicy` - The string that includes the parameters for the
|
1846
1840
|
# dead-letter queue functionality of the source queue. For more
|
@@ -1853,7 +1847,9 @@ module Aws::SQS
|
|
1853
1847
|
# value of `maxReceiveCount` is exceeded.
|
1854
1848
|
#
|
1855
1849
|
# * `maxReceiveCount` - The number of times a message is delivered to
|
1856
|
-
# the source queue before being moved to the dead-letter queue.
|
1850
|
+
# the source queue before being moved to the dead-letter queue. When
|
1851
|
+
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
1852
|
+
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
1857
1853
|
#
|
1858
1854
|
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
1859
1855
|
# Similarly, the dead-letter queue of a standard queue must also be a
|
@@ -1861,10 +1857,11 @@ module Aws::SQS
|
|
1861
1857
|
#
|
1862
1858
|
# </note>
|
1863
1859
|
#
|
1864
|
-
# * `VisibilityTimeout` - The visibility timeout for the queue
|
1865
|
-
# values: an integer from 0 to 43,200 (12 hours).
|
1866
|
-
# For more information about the visibility timeout, see
|
1867
|
-
# Timeout][3] in the *Amazon Simple Queue Service
|
1860
|
+
# * `VisibilityTimeout` - The visibility timeout for the queue, in
|
1861
|
+
# seconds. Valid values: an integer from 0 to 43,200 (12 hours).
|
1862
|
+
# Default: 30. For more information about the visibility timeout, see
|
1863
|
+
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
1864
|
+
# Developer Guide*.
|
1868
1865
|
#
|
1869
1866
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1870
1867
|
#
|
@@ -1879,10 +1876,10 @@ module Aws::SQS
|
|
1879
1876
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
1880
1877
|
# messages before calling AWS KMS again. An integer representing
|
1881
1878
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
1882
|
-
# hours).
|
1883
|
-
#
|
1884
|
-
#
|
1885
|
-
#
|
1879
|
+
# hours). Default: 300 (5 minutes). A shorter time period provides
|
1880
|
+
# better security but results in more calls to KMS which might incur
|
1881
|
+
# charges after Free Tier. For more information, see [How Does the
|
1882
|
+
# Data Key Reuse Period Work?][8].
|
1886
1883
|
#
|
1887
1884
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
1888
1885
|
# queues][9]\:
|
@@ -1919,21 +1916,6 @@ module Aws::SQS
|
|
1919
1916
|
# `MessageDeduplicationId`, the two messages are treated as
|
1920
1917
|
# duplicates and only one copy of the message is delivered.
|
1921
1918
|
#
|
1922
|
-
# Any other valid special request parameters (such as the following) are
|
1923
|
-
# ignored:
|
1924
|
-
#
|
1925
|
-
# * `ApproximateNumberOfMessages`
|
1926
|
-
#
|
1927
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
1928
|
-
#
|
1929
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
1930
|
-
#
|
1931
|
-
# * `CreatedTimestamp`
|
1932
|
-
#
|
1933
|
-
# * `LastModifiedTimestamp`
|
1934
|
-
#
|
1935
|
-
# * `QueueArn`
|
1936
|
-
#
|
1937
1919
|
#
|
1938
1920
|
#
|
1939
1921
|
# [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
@@ -1968,8 +1950,8 @@ module Aws::SQS
|
|
1968
1950
|
end
|
1969
1951
|
|
1970
1952
|
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
1971
|
-
# overview, see [Tagging Amazon SQS Queues][1] in the *Amazon
|
1972
|
-
# Queue Service Developer Guide*.
|
1953
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
1954
|
+
# Simple Queue Service Developer Guide*.
|
1973
1955
|
#
|
1974
1956
|
# When you use queue tags, keep the following guidelines in mind:
|
1975
1957
|
#
|
@@ -1983,18 +1965,25 @@ module Aws::SQS
|
|
1983
1965
|
# * A new tag with a key identical to that of an existing tag overwrites
|
1984
1966
|
# the existing tag.
|
1985
1967
|
#
|
1986
|
-
# * Tagging
|
1968
|
+
# * Tagging actions are limited to 5 TPS per AWS account. If your
|
1987
1969
|
# application requires a higher throughput, file a [technical support
|
1988
1970
|
# request][2].
|
1989
1971
|
#
|
1990
1972
|
# For a full list of tag restrictions, see [Limits Related to Queues][3]
|
1991
1973
|
# in the *Amazon Simple Queue Service Developer Guide*.
|
1992
1974
|
#
|
1975
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
1976
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
1977
|
+
# User Name][4] in the *Amazon Simple Queue Service Developer Guide*.
|
1993
1978
|
#
|
1979
|
+
# </note>
|
1994
1980
|
#
|
1995
|
-
#
|
1981
|
+
#
|
1982
|
+
#
|
1983
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html
|
1996
1984
|
# [2]: https://console.aws.amazon.com/support/home#/case/create?issueType=technical
|
1997
|
-
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues
|
1985
|
+
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues
|
1986
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
1998
1987
|
#
|
1999
1988
|
# @option params [required, String] :queue_url
|
2000
1989
|
# The URL of the queue.
|
@@ -2023,8 +2012,8 @@ module Aws::SQS
|
|
2023
2012
|
end
|
2024
2013
|
|
2025
2014
|
# Remove cost allocation tags from the specified Amazon SQS queue. For
|
2026
|
-
# an overview, see [Tagging Amazon SQS Queues][1] in the *Amazon
|
2027
|
-
# Queue Service Developer Guide*.
|
2015
|
+
# an overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
2016
|
+
# Simple Queue Service Developer Guide*.
|
2028
2017
|
#
|
2029
2018
|
# When you use queue tags, keep the following guidelines in mind:
|
2030
2019
|
#
|
@@ -2038,18 +2027,25 @@ module Aws::SQS
|
|
2038
2027
|
# * A new tag with a key identical to that of an existing tag overwrites
|
2039
2028
|
# the existing tag.
|
2040
2029
|
#
|
2041
|
-
# * Tagging
|
2030
|
+
# * Tagging actions are limited to 5 TPS per AWS account. If your
|
2042
2031
|
# application requires a higher throughput, file a [technical support
|
2043
2032
|
# request][2].
|
2044
2033
|
#
|
2045
2034
|
# For a full list of tag restrictions, see [Limits Related to Queues][3]
|
2046
2035
|
# in the *Amazon Simple Queue Service Developer Guide*.
|
2047
2036
|
#
|
2037
|
+
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
2038
|
+
# information, see see [Grant Cross-Account Permissions to a Role and a
|
2039
|
+
# User Name][4] in the *Amazon Simple Queue Service Developer Guide*.
|
2040
|
+
#
|
2041
|
+
# </note>
|
2042
|
+
#
|
2048
2043
|
#
|
2049
2044
|
#
|
2050
|
-
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2045
|
+
# [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html
|
2051
2046
|
# [2]: https://console.aws.amazon.com/support/home#/case/create?issueType=technical
|
2052
|
-
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues
|
2047
|
+
# [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues
|
2048
|
+
# [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
2053
2049
|
#
|
2054
2050
|
# @option params [required, String] :queue_url
|
2055
2051
|
# The URL of the queue.
|
@@ -2088,7 +2084,7 @@ module Aws::SQS
|
|
2088
2084
|
params: params,
|
2089
2085
|
config: config)
|
2090
2086
|
context[:gem_name] = 'aws-sdk-sqs'
|
2091
|
-
context[:gem_version] = '1.
|
2087
|
+
context[:gem_version] = '1.7.0'
|
2092
2088
|
Seahorse::Client::Request.new(handlers, context)
|
2093
2089
|
end
|
2094
2090
|
|