aws-sdk-sqs 1.52.0 → 1.62.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +57 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +434 -151
- data/lib/aws-sdk-sqs/client_api.rb +76 -0
- data/lib/aws-sdk-sqs/endpoint_provider.rb +41 -100
- data/lib/aws-sdk-sqs/endpoints.rb +43 -0
- data/lib/aws-sdk-sqs/errors.rb +11 -0
- data/lib/aws-sdk-sqs/message.rb +9 -3
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-sqs/queue.rb +98 -40
- data/lib/aws-sdk-sqs/queue_poller.rb +6 -0
- data/lib/aws-sdk-sqs/resource.rb +70 -30
- data/lib/aws-sdk-sqs/types.rb +351 -379
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -10,16 +10,6 @@
|
|
10
10
|
module Aws::SQS
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# @note When making an API call, you may pass AddPermissionRequest
|
14
|
-
# data as a hash:
|
15
|
-
#
|
16
|
-
# {
|
17
|
-
# queue_url: "String", # required
|
18
|
-
# label: "String", # required
|
19
|
-
# aws_account_ids: ["String"], # required
|
20
|
-
# actions: ["String"], # required
|
21
|
-
# }
|
22
|
-
#
|
23
13
|
# @!attribute [rw] queue_url
|
24
14
|
# The URL of the Amazon SQS queue to which permissions are added.
|
25
15
|
#
|
@@ -118,20 +108,31 @@ module Aws::SQS
|
|
118
108
|
include Aws::Structure
|
119
109
|
end
|
120
110
|
|
121
|
-
#
|
122
|
-
#
|
111
|
+
# @!attribute [rw] task_handle
|
112
|
+
# An identifier associated with a message movement task.
|
113
|
+
# @return [String]
|
114
|
+
#
|
115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTaskRequest AWS API Documentation
|
116
|
+
#
|
117
|
+
class CancelMessageMoveTaskRequest < Struct.new(
|
118
|
+
:task_handle)
|
119
|
+
SENSITIVE = []
|
120
|
+
include Aws::Structure
|
121
|
+
end
|
122
|
+
|
123
|
+
# @!attribute [rw] approximate_number_of_messages_moved
|
124
|
+
# The approximate number of messages already moved to the destination
|
125
|
+
# queue.
|
126
|
+
# @return [Integer]
|
123
127
|
#
|
124
|
-
#
|
125
|
-
# queue_url: "String", # required
|
126
|
-
# entries: [ # required
|
127
|
-
# {
|
128
|
-
# id: "String", # required
|
129
|
-
# receipt_handle: "String", # required
|
130
|
-
# visibility_timeout: 1,
|
131
|
-
# },
|
132
|
-
# ],
|
133
|
-
# }
|
128
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CancelMessageMoveTaskResult AWS API Documentation
|
134
129
|
#
|
130
|
+
class CancelMessageMoveTaskResult < Struct.new(
|
131
|
+
:approximate_number_of_messages_moved)
|
132
|
+
SENSITIVE = []
|
133
|
+
include Aws::Structure
|
134
|
+
end
|
135
|
+
|
135
136
|
# @!attribute [rw] queue_url
|
136
137
|
# The URL of the Amazon SQS queue whose messages' visibility is
|
137
138
|
# changed.
|
@@ -140,7 +141,7 @@ module Aws::SQS
|
|
140
141
|
# @return [String]
|
141
142
|
#
|
142
143
|
# @!attribute [rw] entries
|
143
|
-
#
|
144
|
+
# Lists the receipt handles of the messages for which the visibility
|
144
145
|
# timeout must be changed.
|
145
146
|
# @return [Array<Types::ChangeMessageVisibilityBatchRequestEntry>]
|
146
147
|
#
|
@@ -153,29 +154,9 @@ module Aws::SQS
|
|
153
154
|
include Aws::Structure
|
154
155
|
end
|
155
156
|
|
156
|
-
# Encloses a receipt handle and an entry
|
157
|
+
# Encloses a receipt handle and an entry ID for each message in `
|
157
158
|
# ChangeMessageVisibilityBatch.`
|
158
159
|
#
|
159
|
-
# All of the following list parameters must be prefixed with
|
160
|
-
# `ChangeMessageVisibilityBatchRequestEntry.n`, where `n` is an integer
|
161
|
-
# value starting with `1`. For example, a parameter list for this action
|
162
|
-
# might look like this:
|
163
|
-
#
|
164
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2`
|
165
|
-
#
|
166
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=your_receipt_handle`
|
167
|
-
#
|
168
|
-
# `&ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45`
|
169
|
-
#
|
170
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityBatchRequestEntry
|
171
|
-
# data as a hash:
|
172
|
-
#
|
173
|
-
# {
|
174
|
-
# id: "String", # required
|
175
|
-
# receipt_handle: "String", # required
|
176
|
-
# visibility_timeout: 1,
|
177
|
-
# }
|
178
|
-
#
|
179
160
|
# @!attribute [rw] id
|
180
161
|
# An identifier for this particular receipt handle used to communicate
|
181
162
|
# the result.
|
@@ -243,15 +224,6 @@ module Aws::SQS
|
|
243
224
|
include Aws::Structure
|
244
225
|
end
|
245
226
|
|
246
|
-
# @note When making an API call, you may pass ChangeMessageVisibilityRequest
|
247
|
-
# data as a hash:
|
248
|
-
#
|
249
|
-
# {
|
250
|
-
# queue_url: "String", # required
|
251
|
-
# receipt_handle: "String", # required
|
252
|
-
# visibility_timeout: 1, # required
|
253
|
-
# }
|
254
|
-
#
|
255
227
|
# @!attribute [rw] queue_url
|
256
228
|
# The URL of the Amazon SQS queue whose message's visibility is
|
257
229
|
# changed.
|
@@ -260,7 +232,7 @@ module Aws::SQS
|
|
260
232
|
# @return [String]
|
261
233
|
#
|
262
234
|
# @!attribute [rw] receipt_handle
|
263
|
-
# The receipt handle associated with the message whose visibility
|
235
|
+
# The receipt handle associated with the message, whose visibility
|
264
236
|
# timeout is changed. This parameter is returned by the `
|
265
237
|
# ReceiveMessage ` action.
|
266
238
|
# @return [String]
|
@@ -280,19 +252,6 @@ module Aws::SQS
|
|
280
252
|
include Aws::Structure
|
281
253
|
end
|
282
254
|
|
283
|
-
# @note When making an API call, you may pass CreateQueueRequest
|
284
|
-
# data as a hash:
|
285
|
-
#
|
286
|
-
# {
|
287
|
-
# queue_name: "String", # required
|
288
|
-
# attributes: {
|
289
|
-
# "All" => "String",
|
290
|
-
# },
|
291
|
-
# tags: {
|
292
|
-
# "TagKey" => "TagValue",
|
293
|
-
# },
|
294
|
-
# }
|
295
|
-
#
|
296
255
|
# @!attribute [rw] queue_name
|
297
256
|
# The name of the new queue. The following limits apply to this name:
|
298
257
|
#
|
@@ -324,23 +283,33 @@ module Aws::SQS
|
|
324
283
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
325
284
|
# which Amazon SQS retains a message. Valid values: An integer from
|
326
285
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
327
|
-
# 345,600 (4 days).
|
286
|
+
# 345,600 (4 days). When you change a queue's attributes, the
|
287
|
+
# change can take up to 60 seconds for most of the attributes to
|
288
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
289
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
290
|
+
# will impact existing messages in the queue potentially causing
|
291
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
292
|
+
# reduced below the age of existing messages.
|
328
293
|
#
|
329
294
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
330
295
|
# policy. For more information about policy structure, see [Overview
|
331
|
-
# of Amazon Web Services IAM Policies][1] in the *
|
332
|
-
# Guide*.
|
296
|
+
# of Amazon Web Services IAM Policies][1] in the *IAM User Guide*.
|
333
297
|
#
|
334
298
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
335
299
|
# for which a ` ReceiveMessage ` action waits for a message to
|
336
300
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
337
301
|
# 0.
|
338
302
|
#
|
303
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
304
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
305
|
+
# Default: 30. For more information about the visibility timeout,
|
306
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
307
|
+
#
|
308
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
309
|
+
#
|
339
310
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
311
|
# dead-letter queue functionality of the source queue as a JSON
|
341
|
-
# object.
|
342
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
-
# in the *Amazon SQS Developer Guide*.
|
312
|
+
# object. The parameters are as follows:
|
344
313
|
#
|
345
314
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
346
315
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -348,22 +317,44 @@ module Aws::SQS
|
|
348
317
|
#
|
349
318
|
# * `maxReceiveCount` – The number of times a message is delivered
|
350
319
|
# to the source queue before being moved to the dead-letter queue.
|
351
|
-
# When the `ReceiveCount` for a message exceeds the
|
320
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
352
321
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
353
322
|
# the dead-letter-queue.
|
354
323
|
#
|
355
|
-
#
|
356
|
-
#
|
357
|
-
# a
|
324
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
325
|
+
# the permissions for the dead-letter queue redrive permission and
|
326
|
+
# which source queues can specify dead-letter queues as a JSON
|
327
|
+
# object. The parameters are as follows:
|
358
328
|
#
|
359
|
-
#
|
329
|
+
# * `redrivePermission` – The permission type that defines which
|
330
|
+
# source queues can specify the current queue as the dead-letter
|
331
|
+
# queue. Valid values are:
|
360
332
|
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
333
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
334
|
+
# Services account in the same Region can specify this queue as
|
335
|
+
# the dead-letter queue.
|
336
|
+
#
|
337
|
+
# * `denyAll` – No source queues can specify this queue as the
|
338
|
+
# dead-letter queue.
|
339
|
+
#
|
340
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
341
|
+
# parameter can specify this queue as the dead-letter queue.
|
342
|
+
#
|
343
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
344
|
+
# source queues that can specify this queue as the dead-letter
|
345
|
+
# queue and redrive messages. You can specify this parameter only
|
346
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
347
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
348
|
+
# source queues to specify dead-letter queues, set the
|
349
|
+
# `redrivePermission` parameter to `allowAll`.
|
350
|
+
#
|
351
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
352
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
353
|
+
# standard queue.
|
354
|
+
#
|
355
|
+
# </note>
|
365
356
|
#
|
366
|
-
# The following attributes apply only to [server-side-encryption][4]
|
357
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
367
358
|
#
|
368
359
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
369
360
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -380,15 +371,15 @@ module Aws::SQS
|
|
380
371
|
# hours). Default: 300 (5 minutes). A shorter time period provides
|
381
372
|
# better security but results in more calls to KMS which might incur
|
382
373
|
# charges after Free Tier. For more information, see [How Does the
|
383
|
-
# Data Key Reuse Period Work?][8]
|
374
|
+
# Data Key Reuse Period Work?][8]
|
384
375
|
#
|
385
376
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
386
377
|
# using SQS owned encryption keys. Only one server-side encryption
|
387
|
-
# option is supported per queue (
|
378
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
388
379
|
# [SSE-SQS][10]).
|
389
380
|
#
|
390
381
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
391
|
-
# queues][11]
|
382
|
+
# queues][11]:
|
392
383
|
#
|
393
384
|
# * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
|
394
385
|
# and `false`. If you don't specify the `FifoQueue` attribute,
|
@@ -434,7 +425,7 @@ module Aws::SQS
|
|
434
425
|
# duplicates and only one copy of the message is delivered.
|
435
426
|
#
|
436
427
|
# The following attributes apply only to [high throughput for FIFO
|
437
|
-
# queues][14]
|
428
|
+
# queues][14]:
|
438
429
|
#
|
439
430
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
440
431
|
# occurs at the message group or queue level. Valid values are
|
@@ -462,8 +453,8 @@ module Aws::SQS
|
|
462
453
|
#
|
463
454
|
#
|
464
455
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
465
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
466
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
456
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
457
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
467
458
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
468
459
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
469
460
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -503,7 +494,7 @@ module Aws::SQS
|
|
503
494
|
#
|
504
495
|
# Cross-account permissions don't apply to this action. For more
|
505
496
|
# information, see [Grant cross-account permissions to a role and a
|
506
|
-
#
|
497
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
507
498
|
#
|
508
499
|
# </note>
|
509
500
|
#
|
@@ -538,19 +529,6 @@ module Aws::SQS
|
|
538
529
|
include Aws::Structure
|
539
530
|
end
|
540
531
|
|
541
|
-
# @note When making an API call, you may pass DeleteMessageBatchRequest
|
542
|
-
# data as a hash:
|
543
|
-
#
|
544
|
-
# {
|
545
|
-
# queue_url: "String", # required
|
546
|
-
# entries: [ # required
|
547
|
-
# {
|
548
|
-
# id: "String", # required
|
549
|
-
# receipt_handle: "String", # required
|
550
|
-
# },
|
551
|
-
# ],
|
552
|
-
# }
|
553
|
-
#
|
554
532
|
# @!attribute [rw] queue_url
|
555
533
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
556
534
|
#
|
@@ -558,7 +536,7 @@ module Aws::SQS
|
|
558
536
|
# @return [String]
|
559
537
|
#
|
560
538
|
# @!attribute [rw] entries
|
561
|
-
#
|
539
|
+
# Lists the receipt handles for the messages to be deleted.
|
562
540
|
# @return [Array<Types::DeleteMessageBatchRequestEntry>]
|
563
541
|
#
|
564
542
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/DeleteMessageBatchRequest AWS API Documentation
|
@@ -572,16 +550,8 @@ module Aws::SQS
|
|
572
550
|
|
573
551
|
# Encloses a receipt handle and an identifier for it.
|
574
552
|
#
|
575
|
-
# @note When making an API call, you may pass DeleteMessageBatchRequestEntry
|
576
|
-
# data as a hash:
|
577
|
-
#
|
578
|
-
# {
|
579
|
-
# id: "String", # required
|
580
|
-
# receipt_handle: "String", # required
|
581
|
-
# }
|
582
|
-
#
|
583
553
|
# @!attribute [rw] id
|
584
|
-
#
|
554
|
+
# The identifier for this particular receipt handle. This is used to
|
585
555
|
# communicate the result.
|
586
556
|
#
|
587
557
|
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
@@ -641,14 +611,6 @@ module Aws::SQS
|
|
641
611
|
include Aws::Structure
|
642
612
|
end
|
643
613
|
|
644
|
-
# @note When making an API call, you may pass DeleteMessageRequest
|
645
|
-
# data as a hash:
|
646
|
-
#
|
647
|
-
# {
|
648
|
-
# queue_url: "String", # required
|
649
|
-
# receipt_handle: "String", # required
|
650
|
-
# }
|
651
|
-
#
|
652
614
|
# @!attribute [rw] queue_url
|
653
615
|
# The URL of the Amazon SQS queue from which messages are deleted.
|
654
616
|
#
|
@@ -668,13 +630,6 @@ module Aws::SQS
|
|
668
630
|
include Aws::Structure
|
669
631
|
end
|
670
632
|
|
671
|
-
# @note When making an API call, you may pass DeleteQueueRequest
|
672
|
-
# data as a hash:
|
673
|
-
#
|
674
|
-
# {
|
675
|
-
# queue_url: "String", # required
|
676
|
-
# }
|
677
|
-
#
|
678
633
|
# @!attribute [rw] queue_url
|
679
634
|
# The URL of the Amazon SQS queue to delete.
|
680
635
|
#
|
@@ -695,14 +650,6 @@ module Aws::SQS
|
|
695
650
|
#
|
696
651
|
class EmptyBatchRequest < Aws::EmptyStructure; end
|
697
652
|
|
698
|
-
# @note When making an API call, you may pass GetQueueAttributesRequest
|
699
|
-
# data as a hash:
|
700
|
-
#
|
701
|
-
# {
|
702
|
-
# queue_url: "String", # required
|
703
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
704
|
-
# }
|
705
|
-
#
|
706
653
|
# @!attribute [rw] queue_url
|
707
654
|
# The URL of the Amazon SQS queue whose attribute information is
|
708
655
|
# retrieved.
|
@@ -713,7 +660,7 @@ module Aws::SQS
|
|
713
660
|
# @!attribute [rw] attribute_names
|
714
661
|
# A list of attributes for which to retrieve information.
|
715
662
|
#
|
716
|
-
# The `
|
663
|
+
# The `AttributeNames` parameter is optional, but if you don't
|
717
664
|
# specify values for this parameter, the request returns empty
|
718
665
|
# results.
|
719
666
|
#
|
@@ -727,10 +674,10 @@ module Aws::SQS
|
|
727
674
|
#
|
728
675
|
# The `ApproximateNumberOfMessagesDelayed`,
|
729
676
|
# `ApproximateNumberOfMessagesNotVisible`, and
|
730
|
-
# `
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
677
|
+
# `ApproximateNumberOfMessages` metrics may not achieve consistency
|
678
|
+
# until at least 1 minute after the producers stop sending messages.
|
679
|
+
# This period is required for the queue metadata to reach eventual
|
680
|
+
# consistency.
|
734
681
|
#
|
735
682
|
# * `All` – Returns all values.
|
736
683
|
#
|
@@ -762,7 +709,14 @@ module Aws::SQS
|
|
762
709
|
# message can contain before Amazon SQS rejects it.
|
763
710
|
#
|
764
711
|
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
765
|
-
# for which Amazon SQS retains a message.
|
712
|
+
# for which Amazon SQS retains a message. When you change a queue's
|
713
|
+
# attributes, the change can take up to 60 seconds for most of the
|
714
|
+
# attributes to propagate throughout the Amazon SQS system. Changes
|
715
|
+
# made to the `MessageRetentionPeriod` attribute can take up to 15
|
716
|
+
# minutes and will impact existing messages in the queue potentially
|
717
|
+
# causing them to be expired and deleted if the
|
718
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
719
|
+
# messages.
|
766
720
|
#
|
767
721
|
# * `Policy` – Returns the policy of the queue.
|
768
722
|
#
|
@@ -772,11 +726,15 @@ module Aws::SQS
|
|
772
726
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
773
727
|
# to arrive.
|
774
728
|
#
|
729
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
730
|
+
# queue. For more information about the visibility timeout, see
|
731
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
732
|
+
#
|
733
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
734
|
+
#
|
775
735
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
776
736
|
# dead-letter queue functionality of the source queue as a JSON
|
777
|
-
# object.
|
778
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
779
|
-
# in the *Amazon SQS Developer Guide*.
|
737
|
+
# object. The parameters are as follows:
|
780
738
|
#
|
781
739
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
782
740
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -784,15 +742,44 @@ module Aws::SQS
|
|
784
742
|
#
|
785
743
|
# * `maxReceiveCount` – The number of times a message is delivered
|
786
744
|
# to the source queue before being moved to the dead-letter queue.
|
787
|
-
# When the `ReceiveCount` for a message exceeds the
|
745
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
788
746
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
789
747
|
# the dead-letter-queue.
|
790
748
|
#
|
791
|
-
# * `
|
792
|
-
#
|
793
|
-
#
|
749
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
750
|
+
# the permissions for the dead-letter queue redrive permission and
|
751
|
+
# which source queues can specify dead-letter queues as a JSON
|
752
|
+
# object. The parameters are as follows:
|
753
|
+
#
|
754
|
+
# * `redrivePermission` – The permission type that defines which
|
755
|
+
# source queues can specify the current queue as the dead-letter
|
756
|
+
# queue. Valid values are:
|
757
|
+
#
|
758
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
759
|
+
# Services account in the same Region can specify this queue as
|
760
|
+
# the dead-letter queue.
|
794
761
|
#
|
795
|
-
#
|
762
|
+
# * `denyAll` – No source queues can specify this queue as the
|
763
|
+
# dead-letter queue.
|
764
|
+
#
|
765
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
766
|
+
# parameter can specify this queue as the dead-letter queue.
|
767
|
+
#
|
768
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
769
|
+
# source queues that can specify this queue as the dead-letter
|
770
|
+
# queue and redrive messages. You can specify this parameter only
|
771
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
772
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
773
|
+
# source queues to specify dead-letter queues, set the
|
774
|
+
# `redrivePermission` parameter to `allowAll`.
|
775
|
+
#
|
776
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
777
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
778
|
+
# standard queue.
|
779
|
+
#
|
780
|
+
# </note>
|
781
|
+
#
|
782
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
796
783
|
#
|
797
784
|
# * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
|
798
785
|
# managed customer master key (CMK) for Amazon SQS or a custom CMK.
|
@@ -805,11 +792,11 @@ module Aws::SQS
|
|
805
792
|
#
|
806
793
|
# * `SqsManagedSseEnabled` – Returns information about whether the
|
807
794
|
# queue is using SSE-SQS encryption using SQS owned encryption keys.
|
808
|
-
# Only one server-side encryption option is supported per queue
|
809
|
-
#
|
795
|
+
# Only one server-side encryption option is supported per queue (for
|
796
|
+
# example, [SSE-KMS][7] or [SSE-SQS][8]).
|
810
797
|
#
|
811
798
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
812
|
-
# queues][9]
|
799
|
+
# queues][9]:
|
813
800
|
#
|
814
801
|
# * `FifoQueue` – Returns information about whether the queue is FIFO.
|
815
802
|
# For more information, see [FIFO queue logic][10] in the *Amazon
|
@@ -825,7 +812,7 @@ module Aws::SQS
|
|
825
812
|
# [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
|
826
813
|
#
|
827
814
|
# The following attributes apply only to [high throughput for FIFO
|
828
|
-
# queues][12]
|
815
|
+
# queues][12]:
|
829
816
|
#
|
830
817
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
831
818
|
# occurs at the message group or queue level. Valid values are
|
@@ -853,8 +840,8 @@ module Aws::SQS
|
|
853
840
|
#
|
854
841
|
#
|
855
842
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
856
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
857
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
843
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
844
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
858
845
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
859
846
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
860
847
|
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
@@ -890,14 +877,6 @@ module Aws::SQS
|
|
890
877
|
include Aws::Structure
|
891
878
|
end
|
892
879
|
|
893
|
-
# @note When making an API call, you may pass GetQueueUrlRequest
|
894
|
-
# data as a hash:
|
895
|
-
#
|
896
|
-
# {
|
897
|
-
# queue_name: "String", # required
|
898
|
-
# queue_owner_aws_account_id: "String",
|
899
|
-
# }
|
900
|
-
#
|
901
880
|
# @!attribute [rw] queue_name
|
902
881
|
# The name of the queue whose URL must be fetched. Maximum 80
|
903
882
|
# characters. Valid values: alphanumeric characters, hyphens (`-`),
|
@@ -964,15 +943,6 @@ module Aws::SQS
|
|
964
943
|
#
|
965
944
|
class InvalidMessageContents < Aws::EmptyStructure; end
|
966
945
|
|
967
|
-
# @note When making an API call, you may pass ListDeadLetterSourceQueuesRequest
|
968
|
-
# data as a hash:
|
969
|
-
#
|
970
|
-
# {
|
971
|
-
# queue_url: "String", # required
|
972
|
-
# next_token: "Token",
|
973
|
-
# max_results: 1,
|
974
|
-
# }
|
975
|
-
#
|
976
946
|
# @!attribute [rw] queue_url
|
977
947
|
# The URL of a dead-letter queue.
|
978
948
|
#
|
@@ -1021,13 +991,106 @@ module Aws::SQS
|
|
1021
991
|
include Aws::Structure
|
1022
992
|
end
|
1023
993
|
|
1024
|
-
#
|
1025
|
-
#
|
994
|
+
# @!attribute [rw] source_arn
|
995
|
+
# The ARN of the queue whose message movement tasks are to be listed.
|
996
|
+
# @return [String]
|
1026
997
|
#
|
1027
|
-
#
|
1028
|
-
#
|
1029
|
-
#
|
998
|
+
# @!attribute [rw] max_results
|
999
|
+
# The maximum number of results to include in the response. The
|
1000
|
+
# default is 1, which provides the most recent message movement task.
|
1001
|
+
# The upper limit is 10.
|
1002
|
+
# @return [Integer]
|
1030
1003
|
#
|
1004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksRequest AWS API Documentation
|
1005
|
+
#
|
1006
|
+
class ListMessageMoveTasksRequest < Struct.new(
|
1007
|
+
:source_arn,
|
1008
|
+
:max_results)
|
1009
|
+
SENSITIVE = []
|
1010
|
+
include Aws::Structure
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
# @!attribute [rw] results
|
1014
|
+
# A list of message movement tasks and their attributes.
|
1015
|
+
# @return [Array<Types::ListMessageMoveTasksResultEntry>]
|
1016
|
+
#
|
1017
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksResult AWS API Documentation
|
1018
|
+
#
|
1019
|
+
class ListMessageMoveTasksResult < Struct.new(
|
1020
|
+
:results)
|
1021
|
+
SENSITIVE = []
|
1022
|
+
include Aws::Structure
|
1023
|
+
end
|
1024
|
+
|
1025
|
+
# Contains the details of a message movement task.
|
1026
|
+
#
|
1027
|
+
# @!attribute [rw] task_handle
|
1028
|
+
# An identifier associated with a message movement task. When this
|
1029
|
+
# field is returned in the response of the `ListMessageMoveTasks`
|
1030
|
+
# action, it is only populated for tasks that are in RUNNING status.
|
1031
|
+
# @return [String]
|
1032
|
+
#
|
1033
|
+
# @!attribute [rw] status
|
1034
|
+
# The status of the message movement task. Possible values are:
|
1035
|
+
# RUNNING, COMPLETED, CANCELLING, CANCELLED, and FAILED.
|
1036
|
+
# @return [String]
|
1037
|
+
#
|
1038
|
+
# @!attribute [rw] source_arn
|
1039
|
+
# The ARN of the queue that contains the messages to be moved to
|
1040
|
+
# another queue.
|
1041
|
+
# @return [String]
|
1042
|
+
#
|
1043
|
+
# @!attribute [rw] destination_arn
|
1044
|
+
# The ARN of the destination queue if it has been specified in the
|
1045
|
+
# `StartMessageMoveTask` request. If a `DestinationArn` has not been
|
1046
|
+
# specified in the `StartMessageMoveTask` request, this field value
|
1047
|
+
# will be NULL.
|
1048
|
+
# @return [String]
|
1049
|
+
#
|
1050
|
+
# @!attribute [rw] max_number_of_messages_per_second
|
1051
|
+
# The number of messages to be moved per second (the message movement
|
1052
|
+
# rate), if it has been specified in the `StartMessageMoveTask`
|
1053
|
+
# request. If a `MaxNumberOfMessagesPerSecond` has not been specified
|
1054
|
+
# in the `StartMessageMoveTask` request, this field value will be
|
1055
|
+
# NULL.
|
1056
|
+
# @return [Integer]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] approximate_number_of_messages_moved
|
1059
|
+
# The approximate number of messages already moved to the destination
|
1060
|
+
# queue.
|
1061
|
+
# @return [Integer]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] approximate_number_of_messages_to_move
|
1064
|
+
# The number of messages to be moved from the source queue. This
|
1065
|
+
# number is obtained at the time of starting the message movement
|
1066
|
+
# task.
|
1067
|
+
# @return [Integer]
|
1068
|
+
#
|
1069
|
+
# @!attribute [rw] failure_reason
|
1070
|
+
# The task failure reason (only included if the task status is
|
1071
|
+
# FAILED).
|
1072
|
+
# @return [String]
|
1073
|
+
#
|
1074
|
+
# @!attribute [rw] started_timestamp
|
1075
|
+
# The timestamp of starting the message movement task.
|
1076
|
+
# @return [Integer]
|
1077
|
+
#
|
1078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListMessageMoveTasksResultEntry AWS API Documentation
|
1079
|
+
#
|
1080
|
+
class ListMessageMoveTasksResultEntry < Struct.new(
|
1081
|
+
:task_handle,
|
1082
|
+
:status,
|
1083
|
+
:source_arn,
|
1084
|
+
:destination_arn,
|
1085
|
+
:max_number_of_messages_per_second,
|
1086
|
+
:approximate_number_of_messages_moved,
|
1087
|
+
:approximate_number_of_messages_to_move,
|
1088
|
+
:failure_reason,
|
1089
|
+
:started_timestamp)
|
1090
|
+
SENSITIVE = []
|
1091
|
+
include Aws::Structure
|
1092
|
+
end
|
1093
|
+
|
1031
1094
|
# @!attribute [rw] queue_url
|
1032
1095
|
# The URL of the queue.
|
1033
1096
|
# @return [String]
|
@@ -1052,15 +1115,6 @@ module Aws::SQS
|
|
1052
1115
|
include Aws::Structure
|
1053
1116
|
end
|
1054
1117
|
|
1055
|
-
# @note When making an API call, you may pass ListQueuesRequest
|
1056
|
-
# data as a hash:
|
1057
|
-
#
|
1058
|
-
# {
|
1059
|
-
# queue_name_prefix: "String",
|
1060
|
-
# next_token: "Token",
|
1061
|
-
# max_results: 1,
|
1062
|
-
# }
|
1063
|
-
#
|
1064
1118
|
# @!attribute [rw] queue_name_prefix
|
1065
1119
|
# A string to use for filtering the list results. Only those queues
|
1066
1120
|
# whose name begins with the specified string are returned.
|
@@ -1092,7 +1146,7 @@ module Aws::SQS
|
|
1092
1146
|
#
|
1093
1147
|
# @!attribute [rw] queue_urls
|
1094
1148
|
# A list of queue URLs, up to 1,000 entries, or the value of
|
1095
|
-
# MaxResults that you sent in the request.
|
1149
|
+
# `MaxResults` that you sent in the request.
|
1096
1150
|
# @return [Array<String>]
|
1097
1151
|
#
|
1098
1152
|
# @!attribute [rw] next_token
|
@@ -1202,20 +1256,9 @@ module Aws::SQS
|
|
1202
1256
|
#
|
1203
1257
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1204
1258
|
# null. All parts of the message attribute, including `Name`, `Type`,
|
1205
|
-
# and `Value`, are part of the message size restriction (256
|
1259
|
+
# and `Value`, are part of the message size restriction (256 KiB or
|
1206
1260
|
# 262,144 bytes).
|
1207
1261
|
#
|
1208
|
-
# @note When making an API call, you may pass MessageAttributeValue
|
1209
|
-
# data as a hash:
|
1210
|
-
#
|
1211
|
-
# {
|
1212
|
-
# string_value: "String",
|
1213
|
-
# binary_value: "data",
|
1214
|
-
# string_list_values: ["String"],
|
1215
|
-
# binary_list_values: ["data"],
|
1216
|
-
# data_type: "String", # required
|
1217
|
-
# }
|
1218
|
-
#
|
1219
1262
|
# @!attribute [rw] string_value
|
1220
1263
|
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1221
1264
|
# values, see [ASCII Printable Characters][1].
|
@@ -1276,17 +1319,6 @@ module Aws::SQS
|
|
1276
1319
|
# `Name`, `type`, `value` and the message body must not be empty or
|
1277
1320
|
# null.
|
1278
1321
|
#
|
1279
|
-
# @note When making an API call, you may pass MessageSystemAttributeValue
|
1280
|
-
# data as a hash:
|
1281
|
-
#
|
1282
|
-
# {
|
1283
|
-
# string_value: "String",
|
1284
|
-
# binary_value: "data",
|
1285
|
-
# string_list_values: ["String"],
|
1286
|
-
# binary_list_values: ["data"],
|
1287
|
-
# data_type: "String", # required
|
1288
|
-
# }
|
1289
|
-
#
|
1290
1322
|
# @!attribute [rw] string_value
|
1291
1323
|
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1292
1324
|
# values, see [ASCII Printable Characters][1].
|
@@ -1335,7 +1367,7 @@ module Aws::SQS
|
|
1335
1367
|
end
|
1336
1368
|
|
1337
1369
|
# The specified action violates a limit. For example, `ReceiveMessage`
|
1338
|
-
# returns this error if the maximum number of
|
1370
|
+
# returns this error if the maximum number of in flight messages is
|
1339
1371
|
# reached and `AddPermission` returns this error if the maximum number
|
1340
1372
|
# of permissions for the queue is reached.
|
1341
1373
|
#
|
@@ -1351,13 +1383,6 @@ module Aws::SQS
|
|
1351
1383
|
#
|
1352
1384
|
class PurgeQueueInProgress < Aws::EmptyStructure; end
|
1353
1385
|
|
1354
|
-
# @note When making an API call, you may pass PurgeQueueRequest
|
1355
|
-
# data as a hash:
|
1356
|
-
#
|
1357
|
-
# {
|
1358
|
-
# queue_url: "String", # required
|
1359
|
-
# }
|
1360
|
-
#
|
1361
1386
|
# @!attribute [rw] queue_url
|
1362
1387
|
# The URL of the queue from which the `PurgeQueue` action deletes
|
1363
1388
|
# messages.
|
@@ -1400,19 +1425,6 @@ module Aws::SQS
|
|
1400
1425
|
#
|
1401
1426
|
class ReceiptHandleIsInvalid < Aws::EmptyStructure; end
|
1402
1427
|
|
1403
|
-
# @note When making an API call, you may pass ReceiveMessageRequest
|
1404
|
-
# data as a hash:
|
1405
|
-
#
|
1406
|
-
# {
|
1407
|
-
# queue_url: "String", # required
|
1408
|
-
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
1409
|
-
# message_attribute_names: ["MessageAttributeName"],
|
1410
|
-
# max_number_of_messages: 1,
|
1411
|
-
# visibility_timeout: 1,
|
1412
|
-
# wait_time_seconds: 1,
|
1413
|
-
# receive_request_attempt_id: "String",
|
1414
|
-
# }
|
1415
|
-
#
|
1416
1428
|
# @!attribute [rw] queue_url
|
1417
1429
|
# The URL of the Amazon SQS queue from which messages are received.
|
1418
1430
|
#
|
@@ -1436,7 +1448,7 @@ module Aws::SQS
|
|
1436
1448
|
#
|
1437
1449
|
# * `SenderId`
|
1438
1450
|
#
|
1439
|
-
# * For
|
1451
|
+
# * For a user, returns the user ID, for example
|
1440
1452
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1441
1453
|
#
|
1442
1454
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -1447,7 +1459,8 @@ module Aws::SQS
|
|
1447
1459
|
#
|
1448
1460
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
1449
1461
|
# using SQS owned encryption keys. Only one server-side encryption
|
1450
|
-
# option is supported per queue (
|
1462
|
+
# option is supported per queue (for example, [SSE-KMS][2] or
|
1463
|
+
# [SSE-SQS][3]).
|
1451
1464
|
#
|
1452
1465
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
1453
1466
|
# producer that calls the ` SendMessage ` action.
|
@@ -1616,14 +1629,6 @@ module Aws::SQS
|
|
1616
1629
|
include Aws::Structure
|
1617
1630
|
end
|
1618
1631
|
|
1619
|
-
# @note When making an API call, you may pass RemovePermissionRequest
|
1620
|
-
# data as a hash:
|
1621
|
-
#
|
1622
|
-
# {
|
1623
|
-
# queue_url: "String", # required
|
1624
|
-
# label: "String", # required
|
1625
|
-
# }
|
1626
|
-
#
|
1627
1632
|
# @!attribute [rw] queue_url
|
1628
1633
|
# The URL of the Amazon SQS queue from which permissions are removed.
|
1629
1634
|
#
|
@@ -1644,40 +1649,12 @@ module Aws::SQS
|
|
1644
1649
|
include Aws::Structure
|
1645
1650
|
end
|
1646
1651
|
|
1647
|
-
#
|
1648
|
-
# data as a hash:
|
1649
|
-
#
|
1650
|
-
# {
|
1651
|
-
# queue_url: "String", # required
|
1652
|
-
# entries: [ # required
|
1653
|
-
# {
|
1654
|
-
# id: "String", # required
|
1655
|
-
# message_body: "String", # required
|
1656
|
-
# delay_seconds: 1,
|
1657
|
-
# message_attributes: {
|
1658
|
-
# "String" => {
|
1659
|
-
# string_value: "String",
|
1660
|
-
# binary_value: "data",
|
1661
|
-
# string_list_values: ["String"],
|
1662
|
-
# binary_list_values: ["data"],
|
1663
|
-
# data_type: "String", # required
|
1664
|
-
# },
|
1665
|
-
# },
|
1666
|
-
# message_system_attributes: {
|
1667
|
-
# "AWSTraceHeader" => {
|
1668
|
-
# string_value: "String",
|
1669
|
-
# binary_value: "data",
|
1670
|
-
# string_list_values: ["String"],
|
1671
|
-
# binary_list_values: ["data"],
|
1672
|
-
# data_type: "String", # required
|
1673
|
-
# },
|
1674
|
-
# },
|
1675
|
-
# message_deduplication_id: "String",
|
1676
|
-
# message_group_id: "String",
|
1677
|
-
# },
|
1678
|
-
# ],
|
1679
|
-
# }
|
1652
|
+
# One or more specified resources don't exist.
|
1680
1653
|
#
|
1654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ResourceNotFoundException AWS API Documentation
|
1655
|
+
#
|
1656
|
+
class ResourceNotFoundException < Aws::EmptyStructure; end
|
1657
|
+
|
1681
1658
|
# @!attribute [rw] queue_url
|
1682
1659
|
# The URL of the Amazon SQS queue to which batched messages are sent.
|
1683
1660
|
#
|
@@ -1700,35 +1677,6 @@ module Aws::SQS
|
|
1700
1677
|
# Contains the details of a single Amazon SQS message along with an
|
1701
1678
|
# `Id`.
|
1702
1679
|
#
|
1703
|
-
# @note When making an API call, you may pass SendMessageBatchRequestEntry
|
1704
|
-
# data as a hash:
|
1705
|
-
#
|
1706
|
-
# {
|
1707
|
-
# id: "String", # required
|
1708
|
-
# message_body: "String", # required
|
1709
|
-
# delay_seconds: 1,
|
1710
|
-
# message_attributes: {
|
1711
|
-
# "String" => {
|
1712
|
-
# string_value: "String",
|
1713
|
-
# binary_value: "data",
|
1714
|
-
# string_list_values: ["String"],
|
1715
|
-
# binary_list_values: ["data"],
|
1716
|
-
# data_type: "String", # required
|
1717
|
-
# },
|
1718
|
-
# },
|
1719
|
-
# message_system_attributes: {
|
1720
|
-
# "AWSTraceHeader" => {
|
1721
|
-
# string_value: "String",
|
1722
|
-
# binary_value: "data",
|
1723
|
-
# string_list_values: ["String"],
|
1724
|
-
# binary_list_values: ["data"],
|
1725
|
-
# data_type: "String", # required
|
1726
|
-
# },
|
1727
|
-
# },
|
1728
|
-
# message_deduplication_id: "String",
|
1729
|
-
# message_group_id: "String",
|
1730
|
-
# }
|
1731
|
-
#
|
1732
1680
|
# @!attribute [rw] id
|
1733
1681
|
# An identifier for a message in this batch used to communicate the
|
1734
1682
|
# result.
|
@@ -1987,35 +1935,6 @@ module Aws::SQS
|
|
1987
1935
|
include Aws::Structure
|
1988
1936
|
end
|
1989
1937
|
|
1990
|
-
# @note When making an API call, you may pass SendMessageRequest
|
1991
|
-
# data as a hash:
|
1992
|
-
#
|
1993
|
-
# {
|
1994
|
-
# queue_url: "String", # required
|
1995
|
-
# message_body: "String", # required
|
1996
|
-
# delay_seconds: 1,
|
1997
|
-
# message_attributes: {
|
1998
|
-
# "String" => {
|
1999
|
-
# string_value: "String",
|
2000
|
-
# binary_value: "data",
|
2001
|
-
# string_list_values: ["String"],
|
2002
|
-
# binary_list_values: ["data"],
|
2003
|
-
# data_type: "String", # required
|
2004
|
-
# },
|
2005
|
-
# },
|
2006
|
-
# message_system_attributes: {
|
2007
|
-
# "AWSTraceHeader" => {
|
2008
|
-
# string_value: "String",
|
2009
|
-
# binary_value: "data",
|
2010
|
-
# string_list_values: ["String"],
|
2011
|
-
# binary_list_values: ["data"],
|
2012
|
-
# data_type: "String", # required
|
2013
|
-
# },
|
2014
|
-
# },
|
2015
|
-
# message_deduplication_id: "String",
|
2016
|
-
# message_group_id: "String",
|
2017
|
-
# }
|
2018
|
-
#
|
2019
1938
|
# @!attribute [rw] queue_url
|
2020
1939
|
# The URL of the Amazon SQS queue to which a message is sent.
|
2021
1940
|
#
|
@@ -2024,7 +1943,7 @@ module Aws::SQS
|
|
2024
1943
|
#
|
2025
1944
|
# @!attribute [rw] message_body
|
2026
1945
|
# The message to send. The minimum size is one character. The maximum
|
2027
|
-
# size is 256
|
1946
|
+
# size is 256 KiB.
|
2028
1947
|
#
|
2029
1948
|
# A message can include only XML, JSON, and unformatted text. The
|
2030
1949
|
# following Unicode characters are allowed:
|
@@ -2254,16 +2173,6 @@ module Aws::SQS
|
|
2254
2173
|
include Aws::Structure
|
2255
2174
|
end
|
2256
2175
|
|
2257
|
-
# @note When making an API call, you may pass SetQueueAttributesRequest
|
2258
|
-
# data as a hash:
|
2259
|
-
#
|
2260
|
-
# {
|
2261
|
-
# queue_url: "String", # required
|
2262
|
-
# attributes: { # required
|
2263
|
-
# "All" => "String",
|
2264
|
-
# },
|
2265
|
-
# }
|
2266
|
-
#
|
2267
2176
|
# @!attribute [rw] queue_url
|
2268
2177
|
# The URL of the Amazon SQS queue whose attributes are set.
|
2269
2178
|
#
|
@@ -2289,7 +2198,13 @@ module Aws::SQS
|
|
2289
2198
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
2290
2199
|
# which Amazon SQS retains a message. Valid values: An integer
|
2291
2200
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
2292
|
-
# Default: 345,600 (4 days).
|
2201
|
+
# Default: 345,600 (4 days). When you change a queue's attributes,
|
2202
|
+
# the change can take up to 60 seconds for most of the attributes to
|
2203
|
+
# propagate throughout the Amazon SQS system. Changes made to the
|
2204
|
+
# `MessageRetentionPeriod` attribute can take up to 15 minutes and
|
2205
|
+
# will impact existing messages in the queue potentially causing
|
2206
|
+
# them to be expired and deleted if the `MessageRetentionPeriod` is
|
2207
|
+
# reduced below the age of existing messages.
|
2293
2208
|
#
|
2294
2209
|
# * `Policy` – The queue's policy. A valid Amazon Web Services
|
2295
2210
|
# policy. For more information about policy structure, see [Overview
|
@@ -2301,11 +2216,16 @@ module Aws::SQS
|
|
2301
2216
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
2302
2217
|
# 0.
|
2303
2218
|
#
|
2219
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2220
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
2221
|
+
# Default: 30. For more information about the visibility timeout,
|
2222
|
+
# see [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
2223
|
+
#
|
2224
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
2225
|
+
#
|
2304
2226
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
2305
2227
|
# dead-letter queue functionality of the source queue as a JSON
|
2306
|
-
# object.
|
2307
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2308
|
-
# in the *Amazon SQS Developer Guide*.
|
2228
|
+
# object. The parameters are as follows:
|
2309
2229
|
#
|
2310
2230
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
2311
2231
|
# dead-letter queue to which Amazon SQS moves messages after the
|
@@ -2313,22 +2233,44 @@ module Aws::SQS
|
|
2313
2233
|
#
|
2314
2234
|
# * `maxReceiveCount` – The number of times a message is delivered
|
2315
2235
|
# to the source queue before being moved to the dead-letter queue.
|
2316
|
-
# When the `ReceiveCount` for a message exceeds the
|
2236
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2317
2237
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
2318
2238
|
# the dead-letter-queue.
|
2319
2239
|
#
|
2320
|
-
#
|
2321
|
-
#
|
2322
|
-
# a
|
2240
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2241
|
+
# the permissions for the dead-letter queue redrive permission and
|
2242
|
+
# which source queues can specify dead-letter queues as a JSON
|
2243
|
+
# object. The parameters are as follows:
|
2323
2244
|
#
|
2324
|
-
#
|
2245
|
+
# * `redrivePermission` – The permission type that defines which
|
2246
|
+
# source queues can specify the current queue as the dead-letter
|
2247
|
+
# queue. Valid values are:
|
2325
2248
|
#
|
2326
|
-
#
|
2327
|
-
#
|
2328
|
-
#
|
2329
|
-
#
|
2249
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
2250
|
+
# Services account in the same Region can specify this queue as
|
2251
|
+
# the dead-letter queue.
|
2252
|
+
#
|
2253
|
+
# * `denyAll` – No source queues can specify this queue as the
|
2254
|
+
# dead-letter queue.
|
2330
2255
|
#
|
2331
|
-
#
|
2256
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2257
|
+
# parameter can specify this queue as the dead-letter queue.
|
2258
|
+
#
|
2259
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the
|
2260
|
+
# source queues that can specify this queue as the dead-letter
|
2261
|
+
# queue and redrive messages. You can specify this parameter only
|
2262
|
+
# when the `redrivePermission` parameter is set to `byQueue`. You
|
2263
|
+
# can specify up to 10 source queue ARNs. To allow more than 10
|
2264
|
+
# source queues to specify dead-letter queues, set the
|
2265
|
+
# `redrivePermission` parameter to `allowAll`.
|
2266
|
+
#
|
2267
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
2268
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
2269
|
+
# standard queue.
|
2270
|
+
#
|
2271
|
+
# </note>
|
2272
|
+
#
|
2273
|
+
# The following attributes apply only to [server-side-encryption][4]:
|
2332
2274
|
#
|
2333
2275
|
# * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
|
2334
2276
|
# customer master key (CMK) for Amazon SQS or a custom CMK. For more
|
@@ -2349,11 +2291,11 @@ module Aws::SQS
|
|
2349
2291
|
#
|
2350
2292
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption
|
2351
2293
|
# using SQS owned encryption keys. Only one server-side encryption
|
2352
|
-
# option is supported per queue (
|
2294
|
+
# option is supported per queue (for example, [SSE-KMS][9] or
|
2353
2295
|
# [SSE-SQS][10]).
|
2354
2296
|
#
|
2355
2297
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
2356
|
-
# queues][11]
|
2298
|
+
# queues][11]:
|
2357
2299
|
#
|
2358
2300
|
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
2359
2301
|
# For more information, see [Exactly-once processing][12] in the
|
@@ -2388,7 +2330,7 @@ module Aws::SQS
|
|
2388
2330
|
# duplicates and only one copy of the message is delivered.
|
2389
2331
|
#
|
2390
2332
|
# The following attributes apply only to [high throughput for FIFO
|
2391
|
-
# queues][13]
|
2333
|
+
# queues][13]:
|
2392
2334
|
#
|
2393
2335
|
# * `DeduplicationScope` – Specifies whether message deduplication
|
2394
2336
|
# occurs at the message group or queue level. Valid values are
|
@@ -2416,8 +2358,8 @@ module Aws::SQS
|
|
2416
2358
|
#
|
2417
2359
|
#
|
2418
2360
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2419
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2420
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
2361
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2362
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2421
2363
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2422
2364
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2423
2365
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -2440,16 +2382,54 @@ module Aws::SQS
|
|
2440
2382
|
include Aws::Structure
|
2441
2383
|
end
|
2442
2384
|
|
2443
|
-
#
|
2444
|
-
#
|
2385
|
+
# @!attribute [rw] source_arn
|
2386
|
+
# The ARN of the queue that contains the messages to be moved to
|
2387
|
+
# another queue. Currently, only ARNs of dead-letter queues (DLQs)
|
2388
|
+
# whose sources are other Amazon SQS queues are accepted. DLQs whose
|
2389
|
+
# sources are non-SQS queues, such as Lambda or Amazon SNS topics, are
|
2390
|
+
# not currently supported.
|
2391
|
+
# @return [String]
|
2392
|
+
#
|
2393
|
+
# @!attribute [rw] destination_arn
|
2394
|
+
# The ARN of the queue that receives the moved messages. You can use
|
2395
|
+
# this field to specify the destination queue where you would like to
|
2396
|
+
# redrive messages. If this field is left blank, the messages will be
|
2397
|
+
# redriven back to their respective original source queues.
|
2398
|
+
# @return [String]
|
2399
|
+
#
|
2400
|
+
# @!attribute [rw] max_number_of_messages_per_second
|
2401
|
+
# The number of messages to be moved per second (the message movement
|
2402
|
+
# rate). You can use this field to define a fixed message movement
|
2403
|
+
# rate. The maximum value for messages per second is 500. If this
|
2404
|
+
# field is left blank, the system will optimize the rate based on the
|
2405
|
+
# queue message backlog size, which may vary throughout the duration
|
2406
|
+
# of the message movement task.
|
2407
|
+
# @return [Integer]
|
2445
2408
|
#
|
2446
|
-
#
|
2447
|
-
# queue_url: "String", # required
|
2448
|
-
# tags: { # required
|
2449
|
-
# "TagKey" => "TagValue",
|
2450
|
-
# },
|
2451
|
-
# }
|
2409
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTaskRequest AWS API Documentation
|
2452
2410
|
#
|
2411
|
+
class StartMessageMoveTaskRequest < Struct.new(
|
2412
|
+
:source_arn,
|
2413
|
+
:destination_arn,
|
2414
|
+
:max_number_of_messages_per_second)
|
2415
|
+
SENSITIVE = []
|
2416
|
+
include Aws::Structure
|
2417
|
+
end
|
2418
|
+
|
2419
|
+
# @!attribute [rw] task_handle
|
2420
|
+
# An identifier associated with a message movement task. You can use
|
2421
|
+
# this identifier to cancel a specified message movement task using
|
2422
|
+
# the `CancelMessageMoveTask` action.
|
2423
|
+
# @return [String]
|
2424
|
+
#
|
2425
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/StartMessageMoveTaskResult AWS API Documentation
|
2426
|
+
#
|
2427
|
+
class StartMessageMoveTaskResult < Struct.new(
|
2428
|
+
:task_handle)
|
2429
|
+
SENSITIVE = []
|
2430
|
+
include Aws::Structure
|
2431
|
+
end
|
2432
|
+
|
2453
2433
|
# @!attribute [rw] queue_url
|
2454
2434
|
# The URL of the queue.
|
2455
2435
|
# @return [String]
|
@@ -2479,14 +2459,6 @@ module Aws::SQS
|
|
2479
2459
|
#
|
2480
2460
|
class UnsupportedOperation < Aws::EmptyStructure; end
|
2481
2461
|
|
2482
|
-
# @note When making an API call, you may pass UntagQueueRequest
|
2483
|
-
# data as a hash:
|
2484
|
-
#
|
2485
|
-
# {
|
2486
|
-
# queue_url: "String", # required
|
2487
|
-
# tag_keys: ["TagKey"], # required
|
2488
|
-
# }
|
2489
|
-
#
|
2490
2462
|
# @!attribute [rw] queue_url
|
2491
2463
|
# The URL of the queue.
|
2492
2464
|
# @return [String]
|