aws-sdk-sqs 1.6.0 → 1.7.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -21,7 +21,7 @@ module Aws::SQS
21
21
  # @!attribute [rw] queue_url
22
22
  # The URL of the Amazon SQS queue to which permissions are added.
23
23
  #
24
- # Queue URLs are case-sensitive.
24
+ # Queue URLs and names are case-sensitive.
25
25
  # @return [String]
26
26
  #
27
27
  # @!attribute [rw] label
@@ -41,30 +41,16 @@ module Aws::SQS
41
41
  #
42
42
  #
43
43
  # [1]: http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P
44
- # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html
44
+ # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication
45
45
  # @return [Array<String>]
46
46
  #
47
47
  # @!attribute [rw] actions
48
48
  # The action the client wants to allow for the specified principal.
49
- # The following values are valid:
49
+ # Valid values: the name of any action or `*`.
50
50
  #
51
- # * `*`
52
- #
53
- # * `ChangeMessageVisibility`
54
- #
55
- # * `DeleteMessage`
56
- #
57
- # * `GetQueueAttributes`
58
- #
59
- # * `GetQueueUrl`
60
- #
61
- # * `ReceiveMessage`
62
- #
63
- # * `SendMessage`
64
- #
65
- # For more information about these actions, see [Understanding
66
- # Permissions][1] in the *Amazon Simple Queue Service Developer
67
- # Guide*.
51
+ # For more information about these actions, see [Overview of Managing
52
+ # Access Permissions to Your Amazon Simple Queue Service Resource][1]
53
+ # in the *Amazon Simple Queue Service Developer Guide*.
68
54
  #
69
55
  # Specifying `SendMessage`, `DeleteMessage`, or
70
56
  # `ChangeMessageVisibility` for `ActionName.n` also grants permissions
@@ -74,7 +60,7 @@ module Aws::SQS
74
60
  #
75
61
  #
76
62
  #
77
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes
63
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html
78
64
  # @return [Array<String>]
79
65
  #
80
66
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermissionRequest AWS API Documentation
@@ -87,15 +73,15 @@ module Aws::SQS
87
73
  include Aws::Structure
88
74
  end
89
75
 
90
- # This is used in the responses of batch API to give a detailed
91
- # description of the result of an action on each entry in the request.
76
+ # Gives a detailed description of the result of an action on each entry
77
+ # in the request.
92
78
  #
93
79
  # @!attribute [rw] id
94
80
  # The `Id` of an entry in a batch request.
95
81
  # @return [String]
96
82
  #
97
83
  # @!attribute [rw] sender_fault
98
- # Specifies whether the error happened due to the sender's fault.
84
+ # Specifies whether the error happened due to the producer.
99
85
  # @return [Boolean]
100
86
  #
101
87
  # @!attribute [rw] code
@@ -134,7 +120,7 @@ module Aws::SQS
134
120
  # The URL of the Amazon SQS queue whose messages' visibility is
135
121
  # changed.
136
122
  #
137
- # Queue URLs are case-sensitive.
123
+ # Queue URLs and names are case-sensitive.
138
124
  # @return [String]
139
125
  #
140
126
  # @!attribute [rw] entries
@@ -158,11 +144,11 @@ module Aws::SQS
158
144
  # value starting with `1`. For example, a parameter list for this action
159
145
  # might look like this:
160
146
  #
161
- # `&amp;ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
147
+ # `&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
162
148
  #
163
- # `&amp;ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=<replaceable>Your_Receipt_Handle</replaceable>`
149
+ # `&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle`
164
150
  #
165
- # `&amp;ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
151
+ # `&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
166
152
  #
167
153
  # @note When making an API call, you may pass ChangeMessageVisibilityBatchRequestEntry
168
154
  # data as a hash:
@@ -246,7 +232,7 @@ module Aws::SQS
246
232
  # The URL of the Amazon SQS queue whose message's visibility is
247
233
  # changed.
248
234
  #
249
- # Queue URLs are case-sensitive.
235
+ # Queue URLs and names are case-sensitive.
250
236
  # @return [String]
251
237
  #
252
238
  # @!attribute [rw] receipt_handle
@@ -289,7 +275,7 @@ module Aws::SQS
289
275
  #
290
276
  # * A FIFO queue name must end with the `.fifo` suffix.
291
277
  #
292
- # Queue names are case-sensitive.
278
+ # Queue URLs and names are case-sensitive.
293
279
  # @return [String]
294
280
  #
295
281
  # @!attribute [rw] attributes
@@ -300,18 +286,17 @@ module Aws::SQS
300
286
  #
301
287
  # * `DelaySeconds` - The length of time, in seconds, for which the
302
288
  # delivery of all messages in the queue is delayed. Valid values: An
303
- # integer from 0 to 900 seconds (15 minutes). The default is 0
304
- # (zero).
289
+ # integer from 0 to 900 seconds (15 minutes). Default: 0.
305
290
  #
306
291
  # * `MaximumMessageSize` - The limit of how many bytes a message can
307
292
  # contain before Amazon SQS rejects it. Valid values: An integer
308
- # from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). The default
309
- # is 262,144 (256 KiB).
293
+ # from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
294
+ # 262,144 (256 KiB).
310
295
  #
311
296
  # * `MessageRetentionPeriod` - The length of time, in seconds, for
312
297
  # which Amazon SQS retains a message. Valid values: An integer from
313
- # 60 seconds (1 minute) to 1,209,600 seconds (14 days). The default
314
- # is 345,600 (4 days).
298
+ # 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
299
+ # 345,600 (4 days).
315
300
  #
316
301
  # * `Policy` - The queue's policy. A valid AWS policy. For more
317
302
  # information about policy structure, see [Overview of AWS IAM
@@ -319,8 +304,8 @@ module Aws::SQS
319
304
  #
320
305
  # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
321
306
  # for which a ` ReceiveMessage ` action waits for a message to
322
- # arrive. Valid values: An integer from 0 to 20 (seconds). The
323
- # default is 0 (zero).
307
+ # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
308
+ # 0.
324
309
  #
325
310
  # * `RedrivePolicy` - The string that includes the parameters for the
326
311
  # dead-letter queue functionality of the source queue. For more
@@ -334,6 +319,9 @@ module Aws::SQS
334
319
  #
335
320
  # * `maxReceiveCount` - The number of times a message is delivered
336
321
  # to the source queue before being moved to the dead-letter queue.
322
+ # When the `ReceiveCount` for a message exceeds the
323
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to
324
+ # the dead-letter-queue.
337
325
  #
338
326
  # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
339
327
  # Similarly, the dead-letter queue of a standard queue must also be
@@ -341,10 +329,11 @@ module Aws::SQS
341
329
  #
342
330
  # </note>
343
331
  #
344
- # * `VisibilityTimeout` - The visibility timeout for the queue. Valid
345
- # values: An integer from 0 to 43,200 (12 hours). The default is 30.
346
- # For more information about the visibility timeout, see [Visibility
347
- # Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
332
+ # * `VisibilityTimeout` - The visibility timeout for the queue, in
333
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
334
+ # Default: 30. For more information about the visibility timeout,
335
+ # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
336
+ # Developer Guide*.
348
337
  #
349
338
  # The following attributes apply only to [server-side-encryption][4]\:
350
339
  #
@@ -359,7 +348,7 @@ module Aws::SQS
359
348
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
360
349
  # decrypt messages before calling AWS KMS again. An integer
361
350
  # representing seconds, between 60 seconds (1 minute) and 86,400
362
- # seconds (24 hours). The default is 300 (5 minutes). A shorter time
351
+ # seconds (24 hours). Default: 300 (5 minutes). A shorter time
363
352
  # period provides better security but results in more calls to KMS
364
353
  # which might incur charges after Free Tier. For more information,
365
354
  # see [How Does the Data Key Reuse Period Work?][8].
@@ -409,21 +398,6 @@ module Aws::SQS
409
398
  # `MessageDeduplicationId`, the two messages are treated as
410
399
  # duplicates and only one copy of the message is delivered.
411
400
  #
412
- # Any other valid special request parameters (such as the following)
413
- # are ignored:
414
- #
415
- # * `ApproximateNumberOfMessages`
416
- #
417
- # * `ApproximateNumberOfMessagesDelayed`
418
- #
419
- # * `ApproximateNumberOfMessagesNotVisible`
420
- #
421
- # * `CreatedTimestamp`
422
- #
423
- # * `LastModifiedTimestamp`
424
- #
425
- # * `QueueArn`
426
- #
427
401
  #
428
402
  #
429
403
  # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
@@ -476,7 +450,7 @@ module Aws::SQS
476
450
  # @!attribute [rw] queue_url
477
451
  # The URL of the Amazon SQS queue from which messages are deleted.
478
452
  #
479
- # Queue URLs are case-sensitive.
453
+ # Queue URLs and names are case-sensitive.
480
454
  # @return [String]
481
455
  #
482
456
  # @!attribute [rw] entries
@@ -566,7 +540,7 @@ module Aws::SQS
566
540
  # @!attribute [rw] queue_url
567
541
  # The URL of the Amazon SQS queue from which messages are deleted.
568
542
  #
569
- # Queue URLs are case-sensitive.
543
+ # Queue URLs and names are case-sensitive.
570
544
  # @return [String]
571
545
  #
572
546
  # @!attribute [rw] receipt_handle
@@ -591,7 +565,7 @@ module Aws::SQS
591
565
  # @!attribute [rw] queue_url
592
566
  # The URL of the Amazon SQS queue to delete.
593
567
  #
594
- # Queue URLs are case-sensitive.
568
+ # Queue URLs and names are case-sensitive.
595
569
  # @return [String]
596
570
  #
597
571
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteQueueRequest AWS API Documentation
@@ -613,7 +587,7 @@ module Aws::SQS
613
587
  # The URL of the Amazon SQS queue whose attribute information is
614
588
  # retrieved.
615
589
  #
616
- # Queue URLs are case-sensitive.
590
+ # Queue URLs and names are case-sensitive.
617
591
  # @return [String]
618
592
  #
619
593
  # @!attribute [rw] attribute_names
@@ -630,26 +604,28 @@ module Aws::SQS
630
604
  # * `All` - Returns all values.
631
605
  #
632
606
  # * `ApproximateNumberOfMessages` - Returns the approximate number of
633
- # visible messages in a queue. For more information, see [Resources
634
- # Required to Process Messages][1] in the *Amazon Simple Queue
635
- # Service Developer Guide*.
607
+ # messages available for retrieval from the queue.
636
608
  #
637
609
  # * `ApproximateNumberOfMessagesDelayed` - Returns the approximate
638
- # number of messages that are waiting to be added to the queue.
610
+ # number of messages in the queue that are delayed and not available
611
+ # for reading immediately. This can happen when the queue is
612
+ # configured as a delay queue or when a message has been sent with a
613
+ # delay parameter.
639
614
  #
640
615
  # * `ApproximateNumberOfMessagesNotVisible` - Returns the approximate
641
- # number of messages that have not timed-out and aren't deleted.
642
- # For more information, see [Resources Required to Process
643
- # Messages][1] in the *Amazon Simple Queue Service Developer Guide*.
616
+ # number of messages that are in flight. Messages are considered to
617
+ # be *in flight* if they have been sent to a client but have not yet
618
+ # been deleted or have not yet reached the end of their visibility
619
+ # window.
644
620
  #
645
621
  # * `CreatedTimestamp` - Returns the time when the queue was created
646
- # in seconds ([epoch time][2]).
622
+ # in seconds ([epoch time][1]).
647
623
  #
648
624
  # * `DelaySeconds` - Returns the default delay on the queue in
649
625
  # seconds.
650
626
  #
651
627
  # * `LastModifiedTimestamp` - Returns the time when the queue was last
652
- # changed in seconds ([epoch time][2]).
628
+ # changed in seconds ([epoch time][1]).
653
629
  #
654
630
  # * `MaximumMessageSize` - Returns the limit of how many bytes a
655
631
  # message can contain before Amazon SQS rejects it.
@@ -668,7 +644,7 @@ module Aws::SQS
668
644
  # * `RedrivePolicy` - Returns the string that includes the parameters
669
645
  # for dead-letter queue functionality of the source queue. For more
670
646
  # information about the redrive policy and dead-letter queues, see
671
- # [Using Amazon SQS Dead-Letter Queues][3] in the *Amazon Simple
647
+ # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
672
648
  # Queue Service Developer Guide*.
673
649
  #
674
650
  # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
@@ -677,52 +653,54 @@ module Aws::SQS
677
653
  #
678
654
  # * `maxReceiveCount` - The number of times a message is delivered
679
655
  # to the source queue before being moved to the dead-letter queue.
656
+ # When the `ReceiveCount` for a message exceeds the
657
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to
658
+ # the dead-letter-queue.
680
659
  #
681
660
  # * `VisibilityTimeout` - Returns the visibility timeout for the
682
661
  # queue. For more information about the visibility timeout, see
683
- # [Visibility Timeout][4] in the *Amazon Simple Queue Service
662
+ # [Visibility Timeout][3] in the *Amazon Simple Queue Service
684
663
  # Developer Guide*.
685
664
  #
686
- # The following attributes apply only to [server-side-encryption][5]\:
665
+ # The following attributes apply only to [server-side-encryption][4]\:
687
666
  #
688
667
  # * `KmsMasterKeyId` - Returns the ID of an AWS-managed customer
689
668
  # master key (CMK) for Amazon SQS or a custom CMK. For more
690
- # information, see [Key Terms][6].
669
+ # information, see [Key Terms][5].
691
670
  #
692
671
  # * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
693
672
  # seconds, for which Amazon SQS can reuse a data key to encrypt or
694
673
  # decrypt messages before calling AWS KMS again. For more
695
- # information, see [How Does the Data Key Reuse Period Work?][7].
674
+ # information, see [How Does the Data Key Reuse Period Work?][6].
696
675
  #
697
676
  # The following attributes apply only to [FIFO (first-in-first-out)
698
- # queues][8]\:
677
+ # queues][7]\:
699
678
  #
700
679
  # * `FifoQueue` - Returns whether the queue is FIFO. For more
701
- # information, see [FIFO Queue Logic][9] in the *Amazon Simple Queue
680
+ # information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
702
681
  # Service Developer Guide*.
703
682
  #
704
- # <note markdown="1"> To determine whether a queue is [FIFO][8], you can check whether
683
+ # <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
705
684
  # `QueueName` ends with the `.fifo` suffix.
706
685
  #
707
686
  # </note>
708
687
  #
709
688
  # * `ContentBasedDeduplication` - Returns whether content-based
710
689
  # deduplication is enabled for the queue. For more information, see
711
- # [Exactly-Once Processing][10] in the *Amazon Simple Queue Service
690
+ # [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
712
691
  # Developer Guide*.
713
692
  #
714
693
  #
715
694
  #
716
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-resources-required-process-messages.html
717
- # [2]: http://en.wikipedia.org/wiki/Unix_time
718
- # [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
719
- # [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
720
- # [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
721
- # [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
722
- # [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
723
- # [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
724
- # [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
725
- # [10]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
695
+ # [1]: http://en.wikipedia.org/wiki/Unix_time
696
+ # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
697
+ # [3]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
698
+ # [4]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
699
+ # [5]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
700
+ # [6]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
701
+ # [7]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
702
+ # [8]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
703
+ # [9]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
726
704
  # @return [Array<String>]
727
705
  #
728
706
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
@@ -759,7 +737,7 @@ module Aws::SQS
759
737
  # characters. Valid values: alphanumeric characters, hyphens (`-`),
760
738
  # and underscores (`_`).
761
739
  #
762
- # Queue names are case-sensitive.
740
+ # Queue URLs and names are case-sensitive.
763
741
  # @return [String]
764
742
  #
765
743
  # @!attribute [rw] queue_owner_aws_account_id
@@ -774,12 +752,12 @@ module Aws::SQS
774
752
  include Aws::Structure
775
753
  end
776
754
 
777
- # For more information, see [Responses][1] in the *Amazon Simple Queue
778
- # Service Developer Guide*.
755
+ # For more information, see [Interpreting Responses][1] in the *Amazon
756
+ # Simple Queue Service Developer Guide*.
779
757
  #
780
758
  #
781
759
  #
782
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/UnderstandingResponses.html
760
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html
783
761
  #
784
762
  # @!attribute [rw] queue_url
785
763
  # The URL of the queue.
@@ -802,7 +780,7 @@ module Aws::SQS
802
780
  # @!attribute [rw] queue_url
803
781
  # The URL of a dead-letter queue.
804
782
  #
805
- # Queue URLs are case-sensitive.
783
+ # Queue URLs and names are case-sensitive.
806
784
  # @return [String]
807
785
  #
808
786
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
@@ -866,7 +844,7 @@ module Aws::SQS
866
844
  # A string to use for filtering the list results. Only those queues
867
845
  # whose name begins with the specified string are returned.
868
846
  #
869
- # Queue names are case-sensitive.
847
+ # Queue URLs and names are case-sensitive.
870
848
  # @return [String]
871
849
  #
872
850
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
@@ -912,10 +890,26 @@ module Aws::SQS
912
890
  # @return [String]
913
891
  #
914
892
  # @!attribute [rw] attributes
915
- # `SenderId`, `SentTimestamp`, `ApproximateReceiveCount`, and/or
916
- # `ApproximateFirstReceiveTimestamp`. `SentTimestamp` and
917
- # `ApproximateFirstReceiveTimestamp` are each returned as an integer
918
- # representing the [epoch time][1] in milliseconds.
893
+ # A map of the attributes requested in ` ReceiveMessage ` to their
894
+ # respective values. Supported attributes:
895
+ #
896
+ # * `ApproximateReceiveCount`
897
+ #
898
+ # * `ApproximateFirstReceiveTimestamp`
899
+ #
900
+ # * `MessageDeduplicationId`
901
+ #
902
+ # * `MessageGroupId`
903
+ #
904
+ # * `SenderId`
905
+ #
906
+ # * `SentTimestamp`
907
+ #
908
+ # * `SequenceNumber`
909
+ #
910
+ # `ApproximateFirstReceiveTimestamp` and `SentTimestamp` are each
911
+ # returned as an integer representing the [epoch time][1] in
912
+ # milliseconds.
919
913
  #
920
914
  #
921
915
  #
@@ -936,12 +930,12 @@ module Aws::SQS
936
930
  #
937
931
  # @!attribute [rw] message_attributes
938
932
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
939
- # For more information, see [Message Attribute Items and
940
- # Validation][1] in the *Amazon Simple Queue Service Developer Guide*.
933
+ # For more information, see [Amazon SQS Message Attributes][1] in the
934
+ # *Amazon Simple Queue Service Developer Guide*.
941
935
  #
942
936
  #
943
937
  #
944
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
938
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
945
939
  # @return [Hash<String,Types::MessageAttributeValue>]
946
940
  #
947
941
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/Message AWS API Documentation
@@ -1004,13 +998,13 @@ module Aws::SQS
1004
998
  # `Number`, and `Binary`. For the `Number` data type, you must use
1005
999
  # `StringValue`.
1006
1000
  #
1007
- # You can also append custom labels. For more information, see
1008
- # [Message Attribute Data Types and Validation][1] in the *Amazon
1009
- # Simple Queue Service Developer Guide*.
1001
+ # You can also append custom labels. For more information, see [Amazon
1002
+ # SQS Message Attributes][1] in the *Amazon Simple Queue Service
1003
+ # Developer Guide*.
1010
1004
  #
1011
1005
  #
1012
1006
  #
1013
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-data-types-validation
1007
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
1014
1008
  # @return [String]
1015
1009
  #
1016
1010
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageAttributeValue AWS API Documentation
@@ -1035,7 +1029,7 @@ module Aws::SQS
1035
1029
  # The URL of the queue from which the `PurgeQueue` action deletes
1036
1030
  # messages.
1037
1031
  #
1038
- # Queue URLs are case-sensitive.
1032
+ # Queue URLs and names are case-sensitive.
1039
1033
  # @return [String]
1040
1034
  #
1041
1035
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueRequest AWS API Documentation
@@ -1061,12 +1055,12 @@ module Aws::SQS
1061
1055
  # @!attribute [rw] queue_url
1062
1056
  # The URL of the Amazon SQS queue from which messages are received.
1063
1057
  #
1064
- # Queue URLs are case-sensitive.
1058
+ # Queue URLs and names are case-sensitive.
1065
1059
  # @return [String]
1066
1060
  #
1067
1061
  # @!attribute [rw] attribute_names
1068
- # A list of attributes that need to be returned along with each
1069
- # message. These attributes include:
1062
+ # A list of s that need to be returned along with each message. These
1063
+ # attributes include:
1070
1064
  #
1071
1065
  # * `All` - Returns all values.
1072
1066
  #
@@ -1089,47 +1083,14 @@ module Aws::SQS
1089
1083
  # queue ([epoch time][1] in milliseconds).
1090
1084
  #
1091
1085
  # * `MessageDeduplicationId` - Returns the value provided by the
1092
- # sender that calls the ` SendMessage ` action.
1086
+ # producer that calls the ` SendMessage ` action.
1093
1087
  #
1094
- # * `MessageGroupId` - Returns the value provided by the sender that
1088
+ # * `MessageGroupId` - Returns the value provided by the producer that
1095
1089
  # calls the ` SendMessage ` action. Messages with the same
1096
1090
  # `MessageGroupId` are returned in sequence.
1097
1091
  #
1098
1092
  # * `SequenceNumber` - Returns the value provided by Amazon SQS.
1099
1093
  #
1100
- # Any other valid special request parameters (such as the following)
1101
- # are ignored:
1102
- #
1103
- # * `ApproximateNumberOfMessages`
1104
- #
1105
- # * `ApproximateNumberOfMessagesDelayed`
1106
- #
1107
- # * `ApproximateNumberOfMessagesNotVisible`
1108
- #
1109
- # * `CreatedTimestamp`
1110
- #
1111
- # * `ContentBasedDeduplication`
1112
- #
1113
- # * `DelaySeconds`
1114
- #
1115
- # * `FifoQueue`
1116
- #
1117
- # * `LastModifiedTimestamp`
1118
- #
1119
- # * `MaximumMessageSize`
1120
- #
1121
- # * `MessageRetentionPeriod`
1122
- #
1123
- # * `Policy`
1124
- #
1125
- # * `QueueArn`,
1126
- #
1127
- # * `ReceiveMessageWaitTimeSeconds`
1128
- #
1129
- # * `RedrivePolicy`
1130
- #
1131
- # * `VisibilityTimeout`
1132
- #
1133
1094
  #
1134
1095
  #
1135
1096
  # [1]: http://en.wikipedia.org/wiki/Unix_time
@@ -1161,7 +1122,7 @@ module Aws::SQS
1161
1122
  # @!attribute [rw] max_number_of_messages
1162
1123
  # The maximum number of messages to return. Amazon SQS never returns
1163
1124
  # more messages than this value (however, fewer messages might be
1164
- # returned). Valid values are 1 to 10. Default is 1.
1125
+ # returned). Valid values: 1 to 10. Default: 1.
1165
1126
  # @return [Integer]
1166
1127
  #
1167
1128
  # @!attribute [rw] visibility_timeout
@@ -1209,13 +1170,13 @@ module Aws::SQS
1209
1170
  # [Visibility Timeout][1] in the *Amazon Simple Queue Service
1210
1171
  # Developer Guide*.
1211
1172
  #
1212
- # If a caller of the `ReceiveMessage` action is still processing
1173
+ # If a caller of the `ReceiveMessage` action still processes
1213
1174
  # messages when the visibility timeout expires and messages become
1214
- # visible, another worker reading from the same queue can receive
1175
+ # visible, another worker consuming from the same queue can receive
1215
1176
  # the same messages and therefore process duplicates. Also, if a
1216
- # reader whose message processing time is longer than the visibility
1217
- # timeout tries to delete the processed messages, the action fails
1218
- # with an error.
1177
+ # consumer whose message processing time is longer than the
1178
+ # visibility timeout tries to delete the processed messages, the
1179
+ # action fails with an error.
1219
1180
  #
1220
1181
  # To mitigate this effect, ensure that your application observes a
1221
1182
  # safe threshold before the visibility timeout expires and extend
@@ -1244,7 +1205,7 @@ module Aws::SQS
1244
1205
  #
1245
1206
  #
1246
1207
  # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
1247
- # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-receiverequestattemptid-request-parameter
1208
+ # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html
1248
1209
  # @return [String]
1249
1210
  #
1250
1211
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessageRequest AWS API Documentation
@@ -1284,7 +1245,7 @@ module Aws::SQS
1284
1245
  # @!attribute [rw] queue_url
1285
1246
  # The URL of the Amazon SQS queue from which permissions are removed.
1286
1247
  #
1287
- # Queue URLs are case-sensitive.
1248
+ # Queue URLs and names are case-sensitive.
1288
1249
  # @return [String]
1289
1250
  #
1290
1251
  # @!attribute [rw] label
@@ -1328,7 +1289,7 @@ module Aws::SQS
1328
1289
  # @!attribute [rw] queue_url
1329
1290
  # The URL of the Amazon SQS queue to which batched messages are sent.
1330
1291
  #
1331
- # Queue URLs are case-sensitive.
1292
+ # Queue URLs and names are case-sensitive.
1332
1293
  # @return [String]
1333
1294
  #
1334
1295
  # @!attribute [rw] entries
@@ -1372,6 +1333,10 @@ module Aws::SQS
1372
1333
  #
1373
1334
  # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
1374
1335
  #
1336
+ # This identifier can have up to 80 characters. The following
1337
+ # characters are accepted: alphanumeric characters, hyphens(-), and
1338
+ # underscores (\_).
1339
+ #
1375
1340
  # </note>
1376
1341
  # @return [String]
1377
1342
  #
@@ -1394,12 +1359,12 @@ module Aws::SQS
1394
1359
  #
1395
1360
  # @!attribute [rw] message_attributes
1396
1361
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
1397
- # For more information, see [Message Attribute Items and
1398
- # Validation][1] in the *Amazon Simple Queue Service Developer Guide*.
1362
+ # For more information, see [Amazon SQS Message Attributes][1] in the
1363
+ # *Amazon Simple Queue Service Developer Guide*.
1399
1364
  #
1400
1365
  #
1401
1366
  #
1402
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
1367
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
1403
1368
  # @return [Hash<String,Types::MessageAttributeValue>]
1404
1369
  #
1405
1370
  # @!attribute [rw] message_deduplication_id
@@ -1440,7 +1405,7 @@ module Aws::SQS
1440
1405
  # `MessageDeduplicationId`, the two messages are treated as
1441
1406
  # duplicates and only one copy of the message is delivered.
1442
1407
  #
1443
- # <note markdown="1"> The `MessageDeduplicationId` is available to the recipient of the
1408
+ # <note markdown="1"> The `MessageDeduplicationId` is available to the consumer of the
1444
1409
  # message (this can be useful for troubleshooting delivery issues).
1445
1410
  #
1446
1411
  # If a message is sent successfully but the acknowledgement is lost
@@ -1448,6 +1413,9 @@ module Aws::SQS
1448
1413
  # after the deduplication interval, Amazon SQS can't detect duplicate
1449
1414
  # messages.
1450
1415
  #
1416
+ # Amazon SQS continues to keep track of the message deduplication ID
1417
+ # even after the message is received and deleted.
1418
+ #
1451
1419
  # </note>
1452
1420
  #
1453
1421
  # The length of `MessageDeduplicationId` is 128 characters.
@@ -1462,7 +1430,7 @@ module Aws::SQS
1462
1430
  #
1463
1431
  #
1464
1432
  # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
1465
- # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagededuplicationid-property
1433
+ # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
1466
1434
  # @return [String]
1467
1435
  #
1468
1436
  # @!attribute [rw] message_group_id
@@ -1474,8 +1442,8 @@ module Aws::SQS
1474
1442
  # might be processed out of order). To interleave multiple ordered
1475
1443
  # streams within a single queue, use `MessageGroupId` values (for
1476
1444
  # example, session data for multiple users). In this scenario,
1477
- # multiple readers can process the queue, but the session data of each
1478
- # user is processed in a FIFO fashion.
1445
+ # multiple consumers can process the queue, but the session data of
1446
+ # each user is processed in a FIFO fashion.
1479
1447
  #
1480
1448
  # * You must associate a non-empty `MessageGroupId` with a message. If
1481
1449
  # you don't provide a `MessageGroupId`, the action fails.
@@ -1485,7 +1453,7 @@ module Aws::SQS
1485
1453
  # are sorted by time sent. The caller can't specify a
1486
1454
  # `MessageGroupId`.
1487
1455
  #
1488
- # The length of `MessageGroupId` is 128 characters. Valid values are
1456
+ # The length of `MessageGroupId` is 128 characters. Valid values:
1489
1457
  # alphanumeric characters and punctuation ``
1490
1458
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
1491
1459
  #
@@ -1498,7 +1466,7 @@ module Aws::SQS
1498
1466
  #
1499
1467
  #
1500
1468
  #
1501
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property
1469
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
1502
1470
  # @return [String]
1503
1471
  #
1504
1472
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatchRequestEntry AWS API Documentation
@@ -1613,7 +1581,7 @@ module Aws::SQS
1613
1581
  # @!attribute [rw] queue_url
1614
1582
  # The URL of the Amazon SQS queue to which a message is sent.
1615
1583
  #
1616
- # Queue URLs are case-sensitive.
1584
+ # Queue URLs and names are case-sensitive.
1617
1585
  # @return [String]
1618
1586
  #
1619
1587
  # @!attribute [rw] message_body
@@ -1648,12 +1616,12 @@ module Aws::SQS
1648
1616
  #
1649
1617
  # @!attribute [rw] message_attributes
1650
1618
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
1651
- # For more information, see [Message Attribute Items and
1652
- # Validation][1] in the *Amazon Simple Queue Service Developer Guide*.
1619
+ # For more information, see [Amazon SQS Message Attributes][1] in the
1620
+ # *Amazon Simple Queue Service Developer Guide*.
1653
1621
  #
1654
1622
  #
1655
1623
  #
1656
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html#message-attributes-items-validation
1624
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-attributes.html
1657
1625
  # @return [Hash<String,Types::MessageAttributeValue>]
1658
1626
  #
1659
1627
  # @!attribute [rw] message_deduplication_id
@@ -1694,7 +1662,7 @@ module Aws::SQS
1694
1662
  # `MessageDeduplicationId`, the two messages are treated as
1695
1663
  # duplicates and only one copy of the message is delivered.
1696
1664
  #
1697
- # <note markdown="1"> The `MessageDeduplicationId` is available to the recipient of the
1665
+ # <note markdown="1"> The `MessageDeduplicationId` is available to the consumer of the
1698
1666
  # message (this can be useful for troubleshooting delivery issues).
1699
1667
  #
1700
1668
  # If a message is sent successfully but the acknowledgement is lost
@@ -1702,6 +1670,9 @@ module Aws::SQS
1702
1670
  # after the deduplication interval, Amazon SQS can't detect duplicate
1703
1671
  # messages.
1704
1672
  #
1673
+ # Amazon SQS continues to keep track of the message deduplication ID
1674
+ # even after the message is received and deleted.
1675
+ #
1705
1676
  # </note>
1706
1677
  #
1707
1678
  # The length of `MessageDeduplicationId` is 128 characters.
@@ -1716,7 +1687,7 @@ module Aws::SQS
1716
1687
  #
1717
1688
  #
1718
1689
  # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
1719
- # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagededuplicationid-property
1690
+ # [2]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
1720
1691
  # @return [String]
1721
1692
  #
1722
1693
  # @!attribute [rw] message_group_id
@@ -1728,8 +1699,8 @@ module Aws::SQS
1728
1699
  # might be processed out of order). To interleave multiple ordered
1729
1700
  # streams within a single queue, use `MessageGroupId` values (for
1730
1701
  # example, session data for multiple users). In this scenario,
1731
- # multiple readers can process the queue, but the session data of each
1732
- # user is processed in a FIFO fashion.
1702
+ # multiple consumers can process the queue, but the session data of
1703
+ # each user is processed in a FIFO fashion.
1733
1704
  #
1734
1705
  # * You must associate a non-empty `MessageGroupId` with a message. If
1735
1706
  # you don't provide a `MessageGroupId`, the action fails.
@@ -1739,7 +1710,7 @@ module Aws::SQS
1739
1710
  # are sorted by time sent. The caller can't specify a
1740
1711
  # `MessageGroupId`.
1741
1712
  #
1742
- # The length of `MessageGroupId` is 128 characters. Valid values are
1713
+ # The length of `MessageGroupId` is 128 characters. Valid values:
1743
1714
  # alphanumeric characters and punctuation ``
1744
1715
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
1745
1716
  #
@@ -1752,7 +1723,7 @@ module Aws::SQS
1752
1723
  #
1753
1724
  #
1754
1725
  #
1755
- # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queue-recommendations.html#using-messagegroupid-property
1726
+ # [1]: http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
1756
1727
  # @return [String]
1757
1728
  #
1758
1729
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageRequest AWS API Documentation
@@ -1836,7 +1807,7 @@ module Aws::SQS
1836
1807
  # @!attribute [rw] queue_url
1837
1808
  # The URL of the Amazon SQS queue whose attributes are set.
1838
1809
  #
1839
- # Queue URLs are case-sensitive.
1810
+ # Queue URLs and names are case-sensitive.
1840
1811
  # @return [String]
1841
1812
  #
1842
1813
  # @!attribute [rw] attributes
@@ -1848,17 +1819,17 @@ module Aws::SQS
1848
1819
  #
1849
1820
  # * `DelaySeconds` - The length of time, in seconds, for which the
1850
1821
  # delivery of all messages in the queue is delayed. Valid values: An
1851
- # integer from 0 to 900 (15 minutes). The default is 0 (zero).
1822
+ # integer from 0 to 900 (15 minutes). Default: 0.
1852
1823
  #
1853
1824
  # * `MaximumMessageSize` - The limit of how many bytes a message can
1854
1825
  # contain before Amazon SQS rejects it. Valid values: An integer
1855
- # from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The
1856
- # default is 262,144 (256 KiB).
1826
+ # from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
1827
+ # 262,144 (256 KiB).
1857
1828
  #
1858
1829
  # * `MessageRetentionPeriod` - The length of time, in seconds, for
1859
1830
  # which Amazon SQS retains a message. Valid values: An integer
1860
1831
  # representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
1861
- # The default is 345,600 (4 days).
1832
+ # Default: 345,600 (4 days).
1862
1833
  #
1863
1834
  # * `Policy` - The queue's policy. A valid AWS policy. For more
1864
1835
  # information about policy structure, see [Overview of AWS IAM
@@ -1866,8 +1837,8 @@ module Aws::SQS
1866
1837
  #
1867
1838
  # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
1868
1839
  # for which a ` ReceiveMessage ` action waits for a message to
1869
- # arrive. Valid values: an integer from 0 to 20 (seconds). The
1870
- # default is 0.
1840
+ # arrive. Valid values: an integer from 0 to 20 (seconds). Default:
1841
+ # 0.
1871
1842
  #
1872
1843
  # * `RedrivePolicy` - The string that includes the parameters for the
1873
1844
  # dead-letter queue functionality of the source queue. For more
@@ -1881,6 +1852,9 @@ module Aws::SQS
1881
1852
  #
1882
1853
  # * `maxReceiveCount` - The number of times a message is delivered
1883
1854
  # to the source queue before being moved to the dead-letter queue.
1855
+ # When the `ReceiveCount` for a message exceeds the
1856
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to
1857
+ # the dead-letter-queue.
1884
1858
  #
1885
1859
  # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
1886
1860
  # Similarly, the dead-letter queue of a standard queue must also be
@@ -1888,10 +1862,11 @@ module Aws::SQS
1888
1862
  #
1889
1863
  # </note>
1890
1864
  #
1891
- # * `VisibilityTimeout` - The visibility timeout for the queue. Valid
1892
- # values: an integer from 0 to 43,200 (12 hours). The default is 30.
1893
- # For more information about the visibility timeout, see [Visibility
1894
- # Timeout][3] in the *Amazon Simple Queue Service Developer Guide*.
1865
+ # * `VisibilityTimeout` - The visibility timeout for the queue, in
1866
+ # seconds. Valid values: an integer from 0 to 43,200 (12 hours).
1867
+ # Default: 30. For more information about the visibility timeout,
1868
+ # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
1869
+ # Developer Guide*.
1895
1870
  #
1896
1871
  # The following attributes apply only to [server-side-encryption][4]\:
1897
1872
  #
@@ -1906,7 +1881,7 @@ module Aws::SQS
1906
1881
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
1907
1882
  # decrypt messages before calling AWS KMS again. An integer
1908
1883
  # representing seconds, between 60 seconds (1 minute) and 86,400
1909
- # seconds (24 hours). The default is 300 (5 minutes). A shorter time
1884
+ # seconds (24 hours). Default: 300 (5 minutes). A shorter time
1910
1885
  # period provides better security but results in more calls to KMS
1911
1886
  # which might incur charges after Free Tier. For more information,
1912
1887
  # see [How Does the Data Key Reuse Period Work?][8].
@@ -1946,21 +1921,6 @@ module Aws::SQS
1946
1921
  # `MessageDeduplicationId`, the two messages are treated as
1947
1922
  # duplicates and only one copy of the message is delivered.
1948
1923
  #
1949
- # Any other valid special request parameters (such as the following)
1950
- # are ignored:
1951
- #
1952
- # * `ApproximateNumberOfMessages`
1953
- #
1954
- # * `ApproximateNumberOfMessagesDelayed`
1955
- #
1956
- # * `ApproximateNumberOfMessagesNotVisible`
1957
- #
1958
- # * `CreatedTimestamp`
1959
- #
1960
- # * `LastModifiedTimestamp`
1961
- #
1962
- # * `QueueArn`
1963
- #
1964
1924
  #
1965
1925
  #
1966
1926
  # [1]: http://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html