aws-sdk-sqs 1.23.1 → 1.28.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  require 'set'
2
4
 
3
5
  module Aws
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -6,6 +8,18 @@
6
8
  # WARNING ABOUT GENERATED CODE
7
9
 
8
10
  module Aws::SQS
11
+
12
+ # This class provides a resource oriented interface for SQS.
13
+ # To create a resource object:
14
+ #
15
+ # resource = Aws::SQS::Resource.new(region: 'us-west-2')
16
+ #
17
+ # You can supply a client object with custom configuration that will be used for all resource operations.
18
+ # If you do not pass `:client`, a default client will be constructed.
19
+ #
20
+ # client = Aws::SQS::Client.new(region: 'us-west-2')
21
+ # resource = Aws::SQS::Resource.new(client: client)
22
+ #
9
23
  class Resource
10
24
 
11
25
  # @param options ({})
@@ -50,39 +64,39 @@ module Aws::SQS
50
64
  # The following lists the names, descriptions, and values of the special
51
65
  # request parameters that the `CreateQueue` action uses:
52
66
  #
53
- # * `DelaySeconds` - The length of time, in seconds, for which the
67
+ # * `DelaySeconds` The length of time, in seconds, for which the
54
68
  # delivery of all messages in the queue is delayed. Valid values: An
55
69
  # integer from 0 to 900 seconds (15 minutes). Default: 0.
56
70
  #
57
- # * `MaximumMessageSize` - The limit of how many bytes a message can
71
+ # * `MaximumMessageSize` The limit of how many bytes a message can
58
72
  # contain before Amazon SQS rejects it. Valid values: An integer from
59
73
  # 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
60
74
  # (256 KiB).
61
75
  #
62
- # * `MessageRetentionPeriod` - The length of time, in seconds, for which
76
+ # * `MessageRetentionPeriod` The length of time, in seconds, for which
63
77
  # Amazon SQS retains a message. Valid values: An integer from 60
64
78
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
65
79
  # (4 days).
66
80
  #
67
- # * `Policy` - The queue's policy. A valid AWS policy. For more
81
+ # * `Policy` The queue's policy. A valid AWS policy. For more
68
82
  # information about policy structure, see [Overview of AWS IAM
69
83
  # Policies][1] in the *Amazon IAM User Guide*.
70
84
  #
71
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
85
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
72
86
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
73
87
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
74
88
  #
75
- # * `RedrivePolicy` - The string that includes the parameters for the
76
- # dead-letter queue functionality of the source queue. For more
77
- # information about the redrive policy and dead-letter queues, see
78
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple Queue
79
- # Service Developer Guide*.
89
+ # * `RedrivePolicy` The string that includes the parameters for the
90
+ # dead-letter queue functionality of the source queue as a JSON
91
+ # object. For more information about the redrive policy and
92
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
93
+ # the *Amazon Simple Queue Service Developer Guide*.
80
94
  #
81
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
95
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
82
96
  # dead-letter queue to which Amazon SQS moves messages after the
83
97
  # value of `maxReceiveCount` is exceeded.
84
98
  #
85
- # * `maxReceiveCount` - The number of times a message is delivered to
99
+ # * `maxReceiveCount` The number of times a message is delivered to
86
100
  # the source queue before being moved to the dead-letter queue. When
87
101
  # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
88
102
  # a queue, Amazon SQS moves the message to the dead-letter-queue.
@@ -93,7 +107,7 @@ module Aws::SQS
93
107
  #
94
108
  # </note>
95
109
  #
96
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
110
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
97
111
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
98
112
  # Default: 30. For more information about the visibility timeout, see
99
113
  # [Visibility Timeout][3] in the *Amazon Simple Queue Service
@@ -101,14 +115,14 @@ module Aws::SQS
101
115
  #
102
116
  # The following attributes apply only to [server-side-encryption][4]\:
103
117
  #
104
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
118
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
105
119
  # (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
106
120
  # Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
107
121
  # always `alias/aws/sqs`, the alias of a custom CMK can, for example,
108
122
  # be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
109
123
  # Key Management Service API Reference*.
110
124
  #
111
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds, for
125
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds, for
112
126
  # which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
113
127
  # messages before calling AWS KMS again. An integer representing
114
128
  # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
@@ -120,7 +134,7 @@ module Aws::SQS
120
134
  # The following attributes apply only to [FIFO (first-in-first-out)
121
135
  # queues][9]\:
122
136
  #
123
- # * `FifoQueue` - Designates a queue as FIFO. Valid values: `true`,
137
+ # * `FifoQueue` Designates a queue as FIFO. Valid values: `true`,
124
138
  # `false`. If you don't specify the `FifoQueue` attribute, Amazon SQS
125
139
  # creates a standard queue. You can provide this attribute only during
126
140
  # queue creation. You can't change it for an existing queue. When you
@@ -130,7 +144,7 @@ module Aws::SQS
130
144
  # For more information, see [FIFO Queue Logic][10] in the *Amazon
131
145
  # Simple Queue Service Developer Guide*.
132
146
  #
133
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
147
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
134
148
  # Valid values: `true`, `false`. For more information, see
135
149
  # [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
136
150
  # Developer Guide*.
@@ -268,15 +282,17 @@ module Aws::SQS
268
282
  # @return [Queue::Collection]
269
283
  def queues(options = {})
270
284
  batches = Enumerator.new do |y|
271
- batch = []
272
285
  resp = @client.list_queues(options)
273
- resp.data.queue_urls.each do |q|
274
- batch << Queue.new(
275
- url: q,
276
- client: @client
277
- )
286
+ resp.each_page do |page|
287
+ batch = []
288
+ page.data.queue_urls.each do |q|
289
+ batch << Queue.new(
290
+ url: q,
291
+ client: @client
292
+ )
293
+ end
294
+ y.yield(batch)
278
295
  end
279
- y.yield(batch)
280
296
  end
281
297
  Queue::Collection.new(batches)
282
298
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -73,6 +75,18 @@ module Aws::SQS
73
75
  include Aws::Structure
74
76
  end
75
77
 
78
+ # Two or more batch entries in the request have the same `Id`.
79
+ #
80
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchEntryIdsNotDistinct AWS API Documentation
81
+ #
82
+ class BatchEntryIdsNotDistinct < Aws::EmptyStructure; end
83
+
84
+ # The length of all the messages put together is more than the limit.
85
+ #
86
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchRequestTooLong AWS API Documentation
87
+ #
88
+ class BatchRequestTooLong < Aws::EmptyStructure; end
89
+
76
90
  # Gives a detailed description of the result of an action on each entry
77
91
  # in the request.
78
92
  #
@@ -81,7 +95,8 @@ module Aws::SQS
81
95
  # @return [String]
82
96
  #
83
97
  # @!attribute [rw] sender_fault
84
- # Specifies whether the error happened due to the producer.
98
+ # Specifies whether the error happened due to the caller of the batch
99
+ # API action.
85
100
  # @return [Boolean]
86
101
  #
87
102
  # @!attribute [rw] code
@@ -163,7 +178,11 @@ module Aws::SQS
163
178
  # An identifier for this particular receipt handle used to communicate
164
179
  # the result.
165
180
  #
166
- # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
181
+ # <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
182
+ #
183
+ # This identifier can have up to 80 characters. The following
184
+ # characters are accepted: alphanumeric characters, hyphens(-), and
185
+ # underscores (\_).
167
186
  #
168
187
  # </note>
169
188
  # @return [String]
@@ -287,40 +306,40 @@ module Aws::SQS
287
306
  # The following lists the names, descriptions, and values of the
288
307
  # special request parameters that the `CreateQueue` action uses:
289
308
  #
290
- # * `DelaySeconds` - The length of time, in seconds, for which the
309
+ # * `DelaySeconds` The length of time, in seconds, for which the
291
310
  # delivery of all messages in the queue is delayed. Valid values: An
292
311
  # integer from 0 to 900 seconds (15 minutes). Default: 0.
293
312
  #
294
- # * `MaximumMessageSize` - The limit of how many bytes a message can
313
+ # * `MaximumMessageSize` The limit of how many bytes a message can
295
314
  # contain before Amazon SQS rejects it. Valid values: An integer
296
315
  # from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
297
316
  # 262,144 (256 KiB).
298
317
  #
299
- # * `MessageRetentionPeriod` - The length of time, in seconds, for
318
+ # * `MessageRetentionPeriod` The length of time, in seconds, for
300
319
  # which Amazon SQS retains a message. Valid values: An integer from
301
320
  # 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
302
321
  # 345,600 (4 days).
303
322
  #
304
- # * `Policy` - The queue's policy. A valid AWS policy. For more
323
+ # * `Policy` The queue's policy. A valid AWS policy. For more
305
324
  # information about policy structure, see [Overview of AWS IAM
306
325
  # Policies][1] in the *Amazon IAM User Guide*.
307
326
  #
308
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
327
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
309
328
  # for which a ` ReceiveMessage ` action waits for a message to
310
329
  # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
311
330
  # 0.
312
331
  #
313
- # * `RedrivePolicy` - The string that includes the parameters for the
314
- # dead-letter queue functionality of the source queue. For more
315
- # information about the redrive policy and dead-letter queues, see
316
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
317
- # Queue Service Developer Guide*.
332
+ # * `RedrivePolicy` The string that includes the parameters for the
333
+ # dead-letter queue functionality of the source queue as a JSON
334
+ # object. For more information about the redrive policy and
335
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
336
+ # in the *Amazon Simple Queue Service Developer Guide*.
318
337
  #
319
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
338
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
320
339
  # dead-letter queue to which Amazon SQS moves messages after the
321
340
  # value of `maxReceiveCount` is exceeded.
322
341
  #
323
- # * `maxReceiveCount` - The number of times a message is delivered
342
+ # * `maxReceiveCount` The number of times a message is delivered
324
343
  # to the source queue before being moved to the dead-letter queue.
325
344
  # When the `ReceiveCount` for a message exceeds the
326
345
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
@@ -332,7 +351,7 @@ module Aws::SQS
332
351
  #
333
352
  # </note>
334
353
  #
335
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
354
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
336
355
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
337
356
  # Default: 30. For more information about the visibility timeout,
338
357
  # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
@@ -340,14 +359,14 @@ module Aws::SQS
340
359
  #
341
360
  # The following attributes apply only to [server-side-encryption][4]\:
342
361
  #
343
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
362
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
344
363
  # (CMK) for Amazon SQS or a custom CMK. For more information, see
345
364
  # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
346
365
  # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
347
366
  # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
348
367
  # the *AWS Key Management Service API Reference*.
349
368
  #
350
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
369
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds,
351
370
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
352
371
  # decrypt messages before calling AWS KMS again. An integer
353
372
  # representing seconds, between 60 seconds (1 minute) and 86,400
@@ -359,7 +378,7 @@ module Aws::SQS
359
378
  # The following attributes apply only to [FIFO (first-in-first-out)
360
379
  # queues][9]\:
361
380
  #
362
- # * `FifoQueue` - Designates a queue as FIFO. Valid values: `true`,
381
+ # * `FifoQueue` Designates a queue as FIFO. Valid values: `true`,
363
382
  # `false`. If you don't specify the `FifoQueue` attribute, Amazon
364
383
  # SQS creates a standard queue. You can provide this attribute only
365
384
  # during queue creation. You can't change it for an existing queue.
@@ -369,7 +388,7 @@ module Aws::SQS
369
388
  # For more information, see [FIFO Queue Logic][10] in the *Amazon
370
389
  # Simple Queue Service Developer Guide*.
371
390
  #
372
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
391
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
373
392
  # Valid values: `true`, `false`. For more information, see
374
393
  # [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
375
394
  # Developer Guide*.
@@ -520,7 +539,11 @@ module Aws::SQS
520
539
  # An identifier for this particular receipt handle. This is used to
521
540
  # communicate the result.
522
541
  #
523
- # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
542
+ # <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
543
+ #
544
+ # This identifier can have up to 80 characters. The following
545
+ # characters are accepted: alphanumeric characters, hyphens(-), and
546
+ # underscores (\_).
524
547
  #
525
548
  # </note>
526
549
  # @return [String]
@@ -616,6 +639,12 @@ module Aws::SQS
616
639
  include Aws::Structure
617
640
  end
618
641
 
642
+ # The batch request doesn't contain any entries.
643
+ #
644
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/EmptyBatchRequest AWS API Documentation
645
+ #
646
+ class EmptyBatchRequest < Aws::EmptyStructure; end
647
+
619
648
  # @note When making an API call, you may pass GetQueueAttributesRequest
620
649
  # data as a hash:
621
650
  #
@@ -642,74 +671,81 @@ module Aws::SQS
642
671
  #
643
672
  # The following attributes are supported:
644
673
  #
645
- # * `All` - Returns all values.
674
+ # The `ApproximateNumberOfMessagesDelayed`,
675
+ # `ApproximateNumberOfMessagesNotVisible`, and
676
+ # `ApproximateNumberOfMessagesVisible` metrics may not achieve
677
+ # consistency until at least 1 minute after the producers stop sending
678
+ # messages. This period is required for the queue metadata to reach
679
+ # eventual consistency.
646
680
  #
647
- # * `ApproximateNumberOfMessages` - Returns the approximate number of
681
+ # * `All` Returns all values.
682
+ #
683
+ # * `ApproximateNumberOfMessages` – Returns the approximate number of
648
684
  # messages available for retrieval from the queue.
649
685
  #
650
- # * `ApproximateNumberOfMessagesDelayed` - Returns the approximate
686
+ # * `ApproximateNumberOfMessagesDelayed` Returns the approximate
651
687
  # number of messages in the queue that are delayed and not available
652
688
  # for reading immediately. This can happen when the queue is
653
689
  # configured as a delay queue or when a message has been sent with a
654
690
  # delay parameter.
655
691
  #
656
- # * `ApproximateNumberOfMessagesNotVisible` - Returns the approximate
692
+ # * `ApproximateNumberOfMessagesNotVisible` Returns the approximate
657
693
  # number of messages that are in flight. Messages are considered to
658
694
  # be *in flight* if they have been sent to a client but have not yet
659
695
  # been deleted or have not yet reached the end of their visibility
660
696
  # window.
661
697
  #
662
- # * `CreatedTimestamp` - Returns the time when the queue was created
698
+ # * `CreatedTimestamp` Returns the time when the queue was created
663
699
  # in seconds ([epoch time][1]).
664
700
  #
665
- # * `DelaySeconds` - Returns the default delay on the queue in
701
+ # * `DelaySeconds` Returns the default delay on the queue in
666
702
  # seconds.
667
703
  #
668
- # * `LastModifiedTimestamp` - Returns the time when the queue was last
704
+ # * `LastModifiedTimestamp` Returns the time when the queue was last
669
705
  # changed in seconds ([epoch time][1]).
670
706
  #
671
- # * `MaximumMessageSize` - Returns the limit of how many bytes a
707
+ # * `MaximumMessageSize` Returns the limit of how many bytes a
672
708
  # message can contain before Amazon SQS rejects it.
673
709
  #
674
- # * `MessageRetentionPeriod` - Returns the length of time, in seconds,
710
+ # * `MessageRetentionPeriod` Returns the length of time, in seconds,
675
711
  # for which Amazon SQS retains a message.
676
712
  #
677
- # * `Policy` - Returns the policy of the queue.
713
+ # * `Policy` Returns the policy of the queue.
678
714
  #
679
- # * `QueueArn` - Returns the Amazon resource name (ARN) of the queue.
715
+ # * `QueueArn` Returns the Amazon resource name (ARN) of the queue.
680
716
  #
681
- # * `ReceiveMessageWaitTimeSeconds` - Returns the length of time, in
717
+ # * `ReceiveMessageWaitTimeSeconds` Returns the length of time, in
682
718
  # seconds, for which the `ReceiveMessage` action waits for a message
683
719
  # to arrive.
684
720
  #
685
- # * `RedrivePolicy` - Returns the string that includes the parameters
686
- # for dead-letter queue functionality of the source queue. For more
687
- # information about the redrive policy and dead-letter queues, see
688
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
689
- # Queue Service Developer Guide*.
721
+ # * `RedrivePolicy` The string that includes the parameters for the
722
+ # dead-letter queue functionality of the source queue as a JSON
723
+ # object. For more information about the redrive policy and
724
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
725
+ # in the *Amazon Simple Queue Service Developer Guide*.
690
726
  #
691
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
727
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
692
728
  # dead-letter queue to which Amazon SQS moves messages after the
693
729
  # value of `maxReceiveCount` is exceeded.
694
730
  #
695
- # * `maxReceiveCount` - The number of times a message is delivered
731
+ # * `maxReceiveCount` The number of times a message is delivered
696
732
  # to the source queue before being moved to the dead-letter queue.
697
733
  # When the `ReceiveCount` for a message exceeds the
698
734
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
699
735
  # the dead-letter-queue.
700
736
  #
701
- # * `VisibilityTimeout` - Returns the visibility timeout for the
737
+ # * `VisibilityTimeout` Returns the visibility timeout for the
702
738
  # queue. For more information about the visibility timeout, see
703
739
  # [Visibility Timeout][3] in the *Amazon Simple Queue Service
704
740
  # Developer Guide*.
705
741
  #
706
742
  # The following attributes apply only to [server-side-encryption][4]\:
707
743
  #
708
- # * `KmsMasterKeyId` - Returns the ID of an AWS-managed customer
744
+ # * `KmsMasterKeyId` Returns the ID of an AWS-managed customer
709
745
  # master key (CMK) for Amazon SQS or a custom CMK. For more
710
746
  # information, see [Key Terms][5].
711
747
  #
712
- # * `KmsDataKeyReusePeriodSeconds` - Returns the length of time, in
748
+ # * `KmsDataKeyReusePeriodSeconds` Returns the length of time, in
713
749
  # seconds, for which Amazon SQS can reuse a data key to encrypt or
714
750
  # decrypt messages before calling AWS KMS again. For more
715
751
  # information, see [How Does the Data Key Reuse Period Work?][6].
@@ -717,7 +753,7 @@ module Aws::SQS
717
753
  # The following attributes apply only to [FIFO (first-in-first-out)
718
754
  # queues][7]\:
719
755
  #
720
- # * `FifoQueue` - Returns whether the queue is FIFO. For more
756
+ # * `FifoQueue` Returns whether the queue is FIFO. For more
721
757
  # information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
722
758
  # Service Developer Guide*.
723
759
  #
@@ -726,7 +762,7 @@ module Aws::SQS
726
762
  #
727
763
  # </note>
728
764
  #
729
- # * `ContentBasedDeduplication` - Returns whether content-based
765
+ # * `ContentBasedDeduplication` Returns whether content-based
730
766
  # deduplication is enabled for the queue. For more information, see
731
767
  # [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
732
768
  # Developer Guide*.
@@ -811,11 +847,38 @@ module Aws::SQS
811
847
  include Aws::Structure
812
848
  end
813
849
 
850
+ # The specified attribute doesn't exist.
851
+ #
852
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeName AWS API Documentation
853
+ #
854
+ class InvalidAttributeName < Aws::EmptyStructure; end
855
+
856
+ # The `Id` of a batch entry in a batch request doesn't abide by the
857
+ # specification.
858
+ #
859
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidBatchEntryId AWS API Documentation
860
+ #
861
+ class InvalidBatchEntryId < Aws::EmptyStructure; end
862
+
863
+ # The specified receipt handle isn't valid for the current version.
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidIdFormat AWS API Documentation
866
+ #
867
+ class InvalidIdFormat < Aws::EmptyStructure; end
868
+
869
+ # The message contains characters outside the allowed set.
870
+ #
871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidMessageContents AWS API Documentation
872
+ #
873
+ class InvalidMessageContents < Aws::EmptyStructure; end
874
+
814
875
  # @note When making an API call, you may pass ListDeadLetterSourceQueuesRequest
815
876
  # data as a hash:
816
877
  #
817
878
  # {
818
879
  # queue_url: "String", # required
880
+ # next_token: "Token",
881
+ # max_results: 1,
819
882
  # }
820
883
  #
821
884
  # @!attribute [rw] queue_url
@@ -824,10 +887,20 @@ module Aws::SQS
824
887
  # Queue URLs and names are case-sensitive.
825
888
  # @return [String]
826
889
  #
890
+ # @!attribute [rw] next_token
891
+ # Pagination token to request the next set of results.
892
+ # @return [String]
893
+ #
894
+ # @!attribute [rw] max_results
895
+ # Maximum number of results to include in the response.
896
+ # @return [Integer]
897
+ #
827
898
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
828
899
  #
829
900
  class ListDeadLetterSourceQueuesRequest < Struct.new(
830
- :queue_url)
901
+ :queue_url,
902
+ :next_token,
903
+ :max_results)
831
904
  include Aws::Structure
832
905
  end
833
906
 
@@ -838,10 +911,15 @@ module Aws::SQS
838
911
  # attribute configured with a dead-letter queue.
839
912
  # @return [Array<String>]
840
913
  #
914
+ # @!attribute [rw] next_token
915
+ # Pagination token to include in the next request.
916
+ # @return [String]
917
+ #
841
918
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
842
919
  #
843
920
  class ListDeadLetterSourceQueuesResult < Struct.new(
844
- :queue_urls)
921
+ :queue_urls,
922
+ :next_token)
845
923
  include Aws::Structure
846
924
  end
847
925
 
@@ -879,6 +957,8 @@ module Aws::SQS
879
957
  #
880
958
  # {
881
959
  # queue_name_prefix: "String",
960
+ # next_token: "Token",
961
+ # max_results: 1,
882
962
  # }
883
963
  #
884
964
  # @!attribute [rw] queue_name_prefix
@@ -888,23 +968,39 @@ module Aws::SQS
888
968
  # Queue URLs and names are case-sensitive.
889
969
  # @return [String]
890
970
  #
971
+ # @!attribute [rw] next_token
972
+ # Pagination token to request the next set of results.
973
+ # @return [String]
974
+ #
975
+ # @!attribute [rw] max_results
976
+ # Maximum number of results to include in the response.
977
+ # @return [Integer]
978
+ #
891
979
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
892
980
  #
893
981
  class ListQueuesRequest < Struct.new(
894
- :queue_name_prefix)
982
+ :queue_name_prefix,
983
+ :next_token,
984
+ :max_results)
895
985
  include Aws::Structure
896
986
  end
897
987
 
898
988
  # A list of your queues.
899
989
  #
900
990
  # @!attribute [rw] queue_urls
901
- # A list of queue URLs, up to 1,000 entries.
991
+ # A list of queue URLs, up to 1,000 entries, or the value of
992
+ # MaxResults that you sent in the request.
902
993
  # @return [Array<String>]
903
994
  #
995
+ # @!attribute [rw] next_token
996
+ # Pagination token to include in the next request.
997
+ # @return [String]
998
+ #
904
999
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult AWS API Documentation
905
1000
  #
906
1001
  class ListQueuesResult < Struct.new(
907
- :queue_urls)
1002
+ :queue_urls,
1003
+ :next_token)
908
1004
  include Aws::Structure
909
1005
  end
910
1006
 
@@ -1059,6 +1155,12 @@ module Aws::SQS
1059
1155
  include Aws::Structure
1060
1156
  end
1061
1157
 
1158
+ # The specified message isn't in flight.
1159
+ #
1160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageNotInflight AWS API Documentation
1161
+ #
1162
+ class MessageNotInflight < Aws::EmptyStructure; end
1163
+
1062
1164
  # The user-specified message system attribute value. For string data
1063
1165
  # types, the `Value` attribute has the same restrictions on the content
1064
1166
  # as the message body. For more information, see ` SendMessage.`
@@ -1124,6 +1226,23 @@ module Aws::SQS
1124
1226
  include Aws::Structure
1125
1227
  end
1126
1228
 
1229
+ # The specified action violates a limit. For example, `ReceiveMessage`
1230
+ # returns this error if the maximum number of inflight messages is
1231
+ # reached and `AddPermission` returns this error if the maximum number
1232
+ # of permissions for the queue is reached.
1233
+ #
1234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/OverLimit AWS API Documentation
1235
+ #
1236
+ class OverLimit < Aws::EmptyStructure; end
1237
+
1238
+ # Indicates that the specified queue previously received a `PurgeQueue`
1239
+ # request within the last 60 seconds (the time it can take to delete the
1240
+ # messages in the queue).
1241
+ #
1242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueInProgress AWS API Documentation
1243
+ #
1244
+ class PurgeQueueInProgress < Aws::EmptyStructure; end
1245
+
1127
1246
  # @note When making an API call, you may pass PurgeQueueRequest
1128
1247
  # data as a hash:
1129
1248
  #
@@ -1145,6 +1264,33 @@ module Aws::SQS
1145
1264
  include Aws::Structure
1146
1265
  end
1147
1266
 
1267
+ # You must wait 60 seconds after deleting a queue before you can create
1268
+ # another queue with the same name.
1269
+ #
1270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDeletedRecently AWS API Documentation
1271
+ #
1272
+ class QueueDeletedRecently < Aws::EmptyStructure; end
1273
+
1274
+ # The specified queue doesn't exist.
1275
+ #
1276
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDoesNotExist AWS API Documentation
1277
+ #
1278
+ class QueueDoesNotExist < Aws::EmptyStructure; end
1279
+
1280
+ # A queue with this name already exists. Amazon SQS returns this error
1281
+ # only if the request includes attributes whose values differ from those
1282
+ # of the existing queue.
1283
+ #
1284
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueNameExists AWS API Documentation
1285
+ #
1286
+ class QueueNameExists < Aws::EmptyStructure; end
1287
+
1288
+ # The specified receipt handle isn't valid.
1289
+ #
1290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiptHandleIsInvalid AWS API Documentation
1291
+ #
1292
+ class ReceiptHandleIsInvalid < Aws::EmptyStructure; end
1293
+
1148
1294
  # @note When making an API call, you may pass ReceiveMessageRequest
1149
1295
  # data as a hash:
1150
1296
  #
@@ -1168,16 +1314,16 @@ module Aws::SQS
1168
1314
  # A list of attributes that need to be returned along with each
1169
1315
  # message. These attributes include:
1170
1316
  #
1171
- # * `All` - Returns all values.
1317
+ # * `All` Returns all values.
1172
1318
  #
1173
- # * `ApproximateFirstReceiveTimestamp` - Returns the time the message
1319
+ # * `ApproximateFirstReceiveTimestamp` Returns the time the message
1174
1320
  # was first received from the queue ([epoch time][1] in
1175
1321
  # milliseconds).
1176
1322
  #
1177
- # * `ApproximateReceiveCount` - Returns the number of times a message
1178
- # has been received from the queue but not deleted.
1323
+ # * `ApproximateReceiveCount` Returns the number of times a message
1324
+ # has been received across all queues but not deleted.
1179
1325
  #
1180
- # * `AWSTraceHeader` - Returns the AWS X-Ray trace header string.
1326
+ # * `AWSTraceHeader` Returns the AWS X-Ray trace header string.
1181
1327
  #
1182
1328
  # * `SenderId`
1183
1329
  #
@@ -1187,17 +1333,17 @@ module Aws::SQS
1187
1333
  # * For an IAM role, returns the IAM role ID, for example
1188
1334
  # `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
1189
1335
  #
1190
- # * `SentTimestamp` - Returns the time the message was sent to the
1336
+ # * `SentTimestamp` Returns the time the message was sent to the
1191
1337
  # queue ([epoch time][1] in milliseconds).
1192
1338
  #
1193
- # * `MessageDeduplicationId` - Returns the value provided by the
1339
+ # * `MessageDeduplicationId` Returns the value provided by the
1194
1340
  # producer that calls the ` SendMessage ` action.
1195
1341
  #
1196
- # * `MessageGroupId` - Returns the value provided by the producer that
1342
+ # * `MessageGroupId` Returns the value provided by the producer that
1197
1343
  # calls the ` SendMessage ` action. Messages with the same
1198
1344
  # `MessageGroupId` are returned in sequence.
1199
1345
  #
1200
- # * `SequenceNumber` - Returns the value provided by Amazon SQS.
1346
+ # * `SequenceNumber` Returns the value provided by Amazon SQS.
1201
1347
  #
1202
1348
  #
1203
1349
  #
@@ -1245,6 +1391,18 @@ module Aws::SQS
1245
1391
  # call returns sooner than `WaitTimeSeconds`. If no messages are
1246
1392
  # available and the wait time expires, the call returns successfully
1247
1393
  # with an empty list of messages.
1394
+ #
1395
+ # To avoid HTTP errors, ensure that the HTTP response timeout for
1396
+ # `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
1397
+ # parameter. For example, with the Java SDK, you can set HTTP
1398
+ # transport settings using the [ NettyNioAsyncHttpClient][1] for
1399
+ # asynchronous clients, or the [ ApacheHttpClient][2] for synchronous
1400
+ # clients.
1401
+ #
1402
+ #
1403
+ #
1404
+ # [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
1405
+ # [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
1248
1406
  # @return [Integer]
1249
1407
  #
1250
1408
  # @!attribute [rw] receive_request_attempt_id
@@ -1252,10 +1410,10 @@ module Aws::SQS
1252
1410
  #
1253
1411
  # The token used for deduplication of `ReceiveMessage` calls. If a
1254
1412
  # networking issue occurs after a `ReceiveMessage` action, and instead
1255
- # of a response you receive a generic error, you can retry the same
1256
- # action with an identical `ReceiveRequestAttemptId` to retrieve the
1257
- # same set of messages, even if their visibility timeout has not yet
1258
- # expired.
1413
+ # of a response you receive a generic error, it is possible to retry
1414
+ # the same action with an identical `ReceiveRequestAttemptId` to
1415
+ # retrieve the same set of messages, even if their visibility timeout
1416
+ # has not yet expired.
1259
1417
  #
1260
1418
  # * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
1261
1419
  # `ReceiveMessage` action.
@@ -1267,7 +1425,7 @@ module Aws::SQS
1267
1425
  # `ReceiveRequestAttemptId`, Amazon SQS generates a
1268
1426
  # `ReceiveRequestAttemptId`.
1269
1427
  #
1270
- # * You can retry the `ReceiveMessage` action with the same
1428
+ # * It is possible to retry the `ReceiveMessage` action with the same
1271
1429
  # `ReceiveRequestAttemptId` if none of the messages have been
1272
1430
  # modified (deleted or had their visibility changes).
1273
1431
  #
@@ -1301,7 +1459,7 @@ module Aws::SQS
1301
1459
  # visibility timeout expires. As a result, delays might occur but
1302
1460
  # the messages in the queue remain in a strict order.
1303
1461
  #
1304
- # The length of `ReceiveRequestAttemptId` is 128 characters.
1462
+ # The maximum length of `ReceiveRequestAttemptId` is 128 characters.
1305
1463
  # `ReceiveRequestAttemptId` can contain alphanumeric characters
1306
1464
  # (`a-z`, `A-Z`, `0-9`) and punctuation (``
1307
1465
  # !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
@@ -1457,7 +1615,7 @@ module Aws::SQS
1457
1615
  # An identifier for a message in this batch used to communicate the
1458
1616
  # result.
1459
1617
  #
1460
- # <note markdown="1"> The `Id`s of a batch request need to be unique within a request
1618
+ # <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
1461
1619
  #
1462
1620
  # This identifier can have up to 80 characters. The following
1463
1621
  # characters are accepted: alphanumeric characters, hyphens(-), and
@@ -1499,7 +1657,7 @@ module Aws::SQS
1499
1657
  #
1500
1658
  # * Currently, the only supported message system attribute is
1501
1659
  # `AWSTraceHeader`. Its type must be `String` and its value must be
1502
- # a correctly formatted AWS X-Ray trace string.
1660
+ # a correctly formatted AWS X-Ray trace header string.
1503
1661
  #
1504
1662
  # * The size of a message system attribute doesn't count towards the
1505
1663
  # total size of a message.
@@ -1791,7 +1949,7 @@ module Aws::SQS
1791
1949
  #
1792
1950
  # * Currently, the only supported message system attribute is
1793
1951
  # `AWSTraceHeader`. Its type must be `String` and its value must be
1794
- # a correctly formatted AWS X-Ray trace string.
1952
+ # a correctly formatted AWS X-Ray trace header string.
1795
1953
  #
1796
1954
  # * The size of a message system attribute doesn't count towards the
1797
1955
  # total size of a message.
@@ -1848,7 +2006,7 @@ module Aws::SQS
1848
2006
  #
1849
2007
  # </note>
1850
2008
  #
1851
- # The length of `MessageDeduplicationId` is 128 characters.
2009
+ # The maximum length of `MessageDeduplicationId` is 128 characters.
1852
2010
  # `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
1853
2011
  # `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
1854
2012
  # ``).
@@ -1999,40 +2157,40 @@ module Aws::SQS
1999
2157
  # special request parameters that the `SetQueueAttributes` action
2000
2158
  # uses:
2001
2159
  #
2002
- # * `DelaySeconds` - The length of time, in seconds, for which the
2160
+ # * `DelaySeconds` The length of time, in seconds, for which the
2003
2161
  # delivery of all messages in the queue is delayed. Valid values: An
2004
2162
  # integer from 0 to 900 (15 minutes). Default: 0.
2005
2163
  #
2006
- # * `MaximumMessageSize` - The limit of how many bytes a message can
2164
+ # * `MaximumMessageSize` The limit of how many bytes a message can
2007
2165
  # contain before Amazon SQS rejects it. Valid values: An integer
2008
2166
  # from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
2009
2167
  # 262,144 (256 KiB).
2010
2168
  #
2011
- # * `MessageRetentionPeriod` - The length of time, in seconds, for
2169
+ # * `MessageRetentionPeriod` The length of time, in seconds, for
2012
2170
  # which Amazon SQS retains a message. Valid values: An integer
2013
2171
  # representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
2014
2172
  # Default: 345,600 (4 days).
2015
2173
  #
2016
- # * `Policy` - The queue's policy. A valid AWS policy. For more
2174
+ # * `Policy` The queue's policy. A valid AWS policy. For more
2017
2175
  # information about policy structure, see [Overview of AWS IAM
2018
2176
  # Policies][1] in the *Amazon IAM User Guide*.
2019
2177
  #
2020
- # * `ReceiveMessageWaitTimeSeconds` - The length of time, in seconds,
2178
+ # * `ReceiveMessageWaitTimeSeconds` The length of time, in seconds,
2021
2179
  # for which a ` ReceiveMessage ` action waits for a message to
2022
- # arrive. Valid values: an integer from 0 to 20 (seconds). Default:
2180
+ # arrive. Valid values: An integer from 0 to 20 (seconds). Default:
2023
2181
  # 0.
2024
2182
  #
2025
- # * `RedrivePolicy` - The string that includes the parameters for the
2026
- # dead-letter queue functionality of the source queue. For more
2027
- # information about the redrive policy and dead-letter queues, see
2028
- # [Using Amazon SQS Dead-Letter Queues][2] in the *Amazon Simple
2029
- # Queue Service Developer Guide*.
2183
+ # * `RedrivePolicy` The string that includes the parameters for the
2184
+ # dead-letter queue functionality of the source queue as a JSON
2185
+ # object. For more information about the redrive policy and
2186
+ # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
2187
+ # in the *Amazon Simple Queue Service Developer Guide*.
2030
2188
  #
2031
- # * `deadLetterTargetArn` - The Amazon Resource Name (ARN) of the
2189
+ # * `deadLetterTargetArn` The Amazon Resource Name (ARN) of the
2032
2190
  # dead-letter queue to which Amazon SQS moves messages after the
2033
2191
  # value of `maxReceiveCount` is exceeded.
2034
2192
  #
2035
- # * `maxReceiveCount` - The number of times a message is delivered
2193
+ # * `maxReceiveCount` The number of times a message is delivered
2036
2194
  # to the source queue before being moved to the dead-letter queue.
2037
2195
  # When the `ReceiveCount` for a message exceeds the
2038
2196
  # `maxReceiveCount` for a queue, Amazon SQS moves the message to
@@ -2044,22 +2202,22 @@ module Aws::SQS
2044
2202
  #
2045
2203
  # </note>
2046
2204
  #
2047
- # * `VisibilityTimeout` - The visibility timeout for the queue, in
2048
- # seconds. Valid values: an integer from 0 to 43,200 (12 hours).
2205
+ # * `VisibilityTimeout` The visibility timeout for the queue, in
2206
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2049
2207
  # Default: 30. For more information about the visibility timeout,
2050
2208
  # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
2051
2209
  # Developer Guide*.
2052
2210
  #
2053
2211
  # The following attributes apply only to [server-side-encryption][4]\:
2054
2212
  #
2055
- # * `KmsMasterKeyId` - The ID of an AWS-managed customer master key
2213
+ # * `KmsMasterKeyId` The ID of an AWS-managed customer master key
2056
2214
  # (CMK) for Amazon SQS or a custom CMK. For more information, see
2057
2215
  # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
2058
2216
  # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
2059
2217
  # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
2060
2218
  # the *AWS Key Management Service API Reference*.
2061
2219
  #
2062
- # * `KmsDataKeyReusePeriodSeconds` - The length of time, in seconds,
2220
+ # * `KmsDataKeyReusePeriodSeconds` The length of time, in seconds,
2063
2221
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
2064
2222
  # decrypt messages before calling AWS KMS again. An integer
2065
2223
  # representing seconds, between 60 seconds (1 minute) and 86,400
@@ -2071,7 +2229,7 @@ module Aws::SQS
2071
2229
  # The following attribute applies only to [FIFO (first-in-first-out)
2072
2230
  # queues][9]\:
2073
2231
  #
2074
- # * `ContentBasedDeduplication` - Enables content-based deduplication.
2232
+ # * `ContentBasedDeduplication` Enables content-based deduplication.
2075
2233
  # For more information, see [Exactly-Once Processing][10] in the
2076
2234
  # *Amazon Simple Queue Service Developer Guide*.
2077
2235
  #
@@ -2151,6 +2309,18 @@ module Aws::SQS
2151
2309
  include Aws::Structure
2152
2310
  end
2153
2311
 
2312
+ # The batch request contains more entries than permissible.
2313
+ #
2314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TooManyEntriesInBatchRequest AWS API Documentation
2315
+ #
2316
+ class TooManyEntriesInBatchRequest < Aws::EmptyStructure; end
2317
+
2318
+ # Error code 400. Unsupported operation.
2319
+ #
2320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UnsupportedOperation AWS API Documentation
2321
+ #
2322
+ class UnsupportedOperation < Aws::EmptyStructure; end
2323
+
2154
2324
  # @note When making an API call, you may pass UntagQueueRequest
2155
2325
  # data as a hash:
2156
2326
  #