aws-sdk-sqs 1.56.0 → 1.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +362 -141
- data/lib/aws-sdk-sqs/client_api.rb +76 -0
- data/lib/aws-sdk-sqs/endpoints.rb +42 -0
- data/lib/aws-sdk-sqs/errors.rb +11 -0
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-sqs/queue.rb +59 -25
- data/lib/aws-sdk-sqs/resource.rb +58 -24
- data/lib/aws-sdk-sqs/types.rb +347 -75
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +2 -2
@@ -25,6 +25,8 @@ module Aws::SQS
|
|
25
25
|
BinaryList = Shapes::ListShape.new(name: 'BinaryList', flattened: true)
|
26
26
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
27
27
|
BoxedInteger = Shapes::IntegerShape.new(name: 'BoxedInteger')
|
28
|
+
CancelMessageMoveTaskRequest = Shapes::StructureShape.new(name: 'CancelMessageMoveTaskRequest')
|
29
|
+
CancelMessageMoveTaskResult = Shapes::StructureShape.new(name: 'CancelMessageMoveTaskResult')
|
28
30
|
ChangeMessageVisibilityBatchRequest = Shapes::StructureShape.new(name: 'ChangeMessageVisibilityBatchRequest')
|
29
31
|
ChangeMessageVisibilityBatchRequestEntry = Shapes::StructureShape.new(name: 'ChangeMessageVisibilityBatchRequestEntry')
|
30
32
|
ChangeMessageVisibilityBatchRequestEntryList = Shapes::ListShape.new(name: 'ChangeMessageVisibilityBatchRequestEntryList', flattened: true)
|
@@ -54,10 +56,15 @@ module Aws::SQS
|
|
54
56
|
InvalidMessageContents = Shapes::StructureShape.new(name: 'InvalidMessageContents')
|
55
57
|
ListDeadLetterSourceQueuesRequest = Shapes::StructureShape.new(name: 'ListDeadLetterSourceQueuesRequest')
|
56
58
|
ListDeadLetterSourceQueuesResult = Shapes::StructureShape.new(name: 'ListDeadLetterSourceQueuesResult')
|
59
|
+
ListMessageMoveTasksRequest = Shapes::StructureShape.new(name: 'ListMessageMoveTasksRequest')
|
60
|
+
ListMessageMoveTasksResult = Shapes::StructureShape.new(name: 'ListMessageMoveTasksResult')
|
61
|
+
ListMessageMoveTasksResultEntry = Shapes::StructureShape.new(name: 'ListMessageMoveTasksResultEntry')
|
62
|
+
ListMessageMoveTasksResultEntryList = Shapes::ListShape.new(name: 'ListMessageMoveTasksResultEntryList', flattened: true)
|
57
63
|
ListQueueTagsRequest = Shapes::StructureShape.new(name: 'ListQueueTagsRequest')
|
58
64
|
ListQueueTagsResult = Shapes::StructureShape.new(name: 'ListQueueTagsResult')
|
59
65
|
ListQueuesRequest = Shapes::StructureShape.new(name: 'ListQueuesRequest')
|
60
66
|
ListQueuesResult = Shapes::StructureShape.new(name: 'ListQueuesResult')
|
67
|
+
Long = Shapes::IntegerShape.new(name: 'Long')
|
61
68
|
Message = Shapes::StructureShape.new(name: 'Message')
|
62
69
|
MessageAttributeName = Shapes::StringShape.new(name: 'MessageAttributeName')
|
63
70
|
MessageAttributeNameList = Shapes::ListShape.new(name: 'MessageAttributeNameList', flattened: true)
|
@@ -83,6 +90,7 @@ module Aws::SQS
|
|
83
90
|
ReceiveMessageRequest = Shapes::StructureShape.new(name: 'ReceiveMessageRequest')
|
84
91
|
ReceiveMessageResult = Shapes::StructureShape.new(name: 'ReceiveMessageResult')
|
85
92
|
RemovePermissionRequest = Shapes::StructureShape.new(name: 'RemovePermissionRequest')
|
93
|
+
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
86
94
|
SendMessageBatchRequest = Shapes::StructureShape.new(name: 'SendMessageBatchRequest')
|
87
95
|
SendMessageBatchRequestEntry = Shapes::StructureShape.new(name: 'SendMessageBatchRequestEntry')
|
88
96
|
SendMessageBatchRequestEntryList = Shapes::ListShape.new(name: 'SendMessageBatchRequestEntryList', flattened: true)
|
@@ -92,6 +100,8 @@ module Aws::SQS
|
|
92
100
|
SendMessageRequest = Shapes::StructureShape.new(name: 'SendMessageRequest')
|
93
101
|
SendMessageResult = Shapes::StructureShape.new(name: 'SendMessageResult')
|
94
102
|
SetQueueAttributesRequest = Shapes::StructureShape.new(name: 'SetQueueAttributesRequest')
|
103
|
+
StartMessageMoveTaskRequest = Shapes::StructureShape.new(name: 'StartMessageMoveTaskRequest')
|
104
|
+
StartMessageMoveTaskResult = Shapes::StructureShape.new(name: 'StartMessageMoveTaskResult')
|
95
105
|
String = Shapes::StringShape.new(name: 'String')
|
96
106
|
StringList = Shapes::ListShape.new(name: 'StringList', flattened: true)
|
97
107
|
TagKey = Shapes::StringShape.new(name: 'TagKey')
|
@@ -130,6 +140,12 @@ module Aws::SQS
|
|
130
140
|
|
131
141
|
BinaryList.member = Shapes::ShapeRef.new(shape: Binary, location_name: "BinaryListValue")
|
132
142
|
|
143
|
+
CancelMessageMoveTaskRequest.add_member(:task_handle, Shapes::ShapeRef.new(shape: String, required: true, location_name: "TaskHandle"))
|
144
|
+
CancelMessageMoveTaskRequest.struct_class = Types::CancelMessageMoveTaskRequest
|
145
|
+
|
146
|
+
CancelMessageMoveTaskResult.add_member(:approximate_number_of_messages_moved, Shapes::ShapeRef.new(shape: Long, location_name: "ApproximateNumberOfMessagesMoved"))
|
147
|
+
CancelMessageMoveTaskResult.struct_class = Types::CancelMessageMoveTaskResult
|
148
|
+
|
133
149
|
ChangeMessageVisibilityBatchRequest.add_member(:queue_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "QueueUrl"))
|
134
150
|
ChangeMessageVisibilityBatchRequest.add_member(:entries, Shapes::ShapeRef.new(shape: ChangeMessageVisibilityBatchRequestEntryList, required: true, location_name: "Entries"))
|
135
151
|
ChangeMessageVisibilityBatchRequest.struct_class = Types::ChangeMessageVisibilityBatchRequest
|
@@ -222,6 +238,26 @@ module Aws::SQS
|
|
222
238
|
ListDeadLetterSourceQueuesResult.add_member(:next_token, Shapes::ShapeRef.new(shape: Token, location_name: "NextToken"))
|
223
239
|
ListDeadLetterSourceQueuesResult.struct_class = Types::ListDeadLetterSourceQueuesResult
|
224
240
|
|
241
|
+
ListMessageMoveTasksRequest.add_member(:source_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceArn"))
|
242
|
+
ListMessageMoveTasksRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxResults"))
|
243
|
+
ListMessageMoveTasksRequest.struct_class = Types::ListMessageMoveTasksRequest
|
244
|
+
|
245
|
+
ListMessageMoveTasksResult.add_member(:results, Shapes::ShapeRef.new(shape: ListMessageMoveTasksResultEntryList, location_name: "Results"))
|
246
|
+
ListMessageMoveTasksResult.struct_class = Types::ListMessageMoveTasksResult
|
247
|
+
|
248
|
+
ListMessageMoveTasksResultEntry.add_member(:task_handle, Shapes::ShapeRef.new(shape: String, location_name: "TaskHandle"))
|
249
|
+
ListMessageMoveTasksResultEntry.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "Status"))
|
250
|
+
ListMessageMoveTasksResultEntry.add_member(:source_arn, Shapes::ShapeRef.new(shape: String, location_name: "SourceArn"))
|
251
|
+
ListMessageMoveTasksResultEntry.add_member(:destination_arn, Shapes::ShapeRef.new(shape: String, location_name: "DestinationArn"))
|
252
|
+
ListMessageMoveTasksResultEntry.add_member(:max_number_of_messages_per_second, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxNumberOfMessagesPerSecond"))
|
253
|
+
ListMessageMoveTasksResultEntry.add_member(:approximate_number_of_messages_moved, Shapes::ShapeRef.new(shape: Long, location_name: "ApproximateNumberOfMessagesMoved"))
|
254
|
+
ListMessageMoveTasksResultEntry.add_member(:approximate_number_of_messages_to_move, Shapes::ShapeRef.new(shape: Long, location_name: "ApproximateNumberOfMessagesToMove"))
|
255
|
+
ListMessageMoveTasksResultEntry.add_member(:failure_reason, Shapes::ShapeRef.new(shape: String, location_name: "FailureReason"))
|
256
|
+
ListMessageMoveTasksResultEntry.add_member(:started_timestamp, Shapes::ShapeRef.new(shape: Long, location_name: "StartedTimestamp"))
|
257
|
+
ListMessageMoveTasksResultEntry.struct_class = Types::ListMessageMoveTasksResultEntry
|
258
|
+
|
259
|
+
ListMessageMoveTasksResultEntryList.member = Shapes::ShapeRef.new(shape: ListMessageMoveTasksResultEntry, location_name: "ListMessageMoveTasksResultEntry")
|
260
|
+
|
225
261
|
ListQueueTagsRequest.add_member(:queue_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "QueueUrl"))
|
226
262
|
ListQueueTagsRequest.struct_class = Types::ListQueueTagsRequest
|
227
263
|
|
@@ -311,6 +347,8 @@ module Aws::SQS
|
|
311
347
|
RemovePermissionRequest.add_member(:label, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Label"))
|
312
348
|
RemovePermissionRequest.struct_class = Types::RemovePermissionRequest
|
313
349
|
|
350
|
+
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
351
|
+
|
314
352
|
SendMessageBatchRequest.add_member(:queue_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "QueueUrl"))
|
315
353
|
SendMessageBatchRequest.add_member(:entries, Shapes::ShapeRef.new(shape: SendMessageBatchRequestEntryList, required: true, location_name: "Entries"))
|
316
354
|
SendMessageBatchRequest.struct_class = Types::SendMessageBatchRequest
|
@@ -360,6 +398,14 @@ module Aws::SQS
|
|
360
398
|
SetQueueAttributesRequest.add_member(:attributes, Shapes::ShapeRef.new(shape: QueueAttributeMap, required: true, location_name: "Attribute"))
|
361
399
|
SetQueueAttributesRequest.struct_class = Types::SetQueueAttributesRequest
|
362
400
|
|
401
|
+
StartMessageMoveTaskRequest.add_member(:source_arn, Shapes::ShapeRef.new(shape: String, required: true, location_name: "SourceArn"))
|
402
|
+
StartMessageMoveTaskRequest.add_member(:destination_arn, Shapes::ShapeRef.new(shape: String, location_name: "DestinationArn"))
|
403
|
+
StartMessageMoveTaskRequest.add_member(:max_number_of_messages_per_second, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxNumberOfMessagesPerSecond"))
|
404
|
+
StartMessageMoveTaskRequest.struct_class = Types::StartMessageMoveTaskRequest
|
405
|
+
|
406
|
+
StartMessageMoveTaskResult.add_member(:task_handle, Shapes::ShapeRef.new(shape: String, location_name: "TaskHandle"))
|
407
|
+
StartMessageMoveTaskResult.struct_class = Types::StartMessageMoveTaskResult
|
408
|
+
|
363
409
|
StringList.member = Shapes::ShapeRef.new(shape: String, location_name: "StringListValue")
|
364
410
|
|
365
411
|
TagKeyList.member = Shapes::ShapeRef.new(shape: TagKey, location_name: "TagKey")
|
@@ -407,6 +453,16 @@ module Aws::SQS
|
|
407
453
|
o.errors << Shapes::ShapeRef.new(shape: OverLimit)
|
408
454
|
end)
|
409
455
|
|
456
|
+
api.add_operation(:cancel_message_move_task, Seahorse::Model::Operation.new.tap do |o|
|
457
|
+
o.name = "CancelMessageMoveTask"
|
458
|
+
o.http_method = "POST"
|
459
|
+
o.http_request_uri = "/"
|
460
|
+
o.input = Shapes::ShapeRef.new(shape: CancelMessageMoveTaskRequest)
|
461
|
+
o.output = Shapes::ShapeRef.new(shape: CancelMessageMoveTaskResult)
|
462
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
463
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperation)
|
464
|
+
end)
|
465
|
+
|
410
466
|
api.add_operation(:change_message_visibility, Seahorse::Model::Operation.new.tap do |o|
|
411
467
|
o.name = "ChangeMessageVisibility"
|
412
468
|
o.http_method = "POST"
|
@@ -502,6 +558,16 @@ module Aws::SQS
|
|
502
558
|
)
|
503
559
|
end)
|
504
560
|
|
561
|
+
api.add_operation(:list_message_move_tasks, Seahorse::Model::Operation.new.tap do |o|
|
562
|
+
o.name = "ListMessageMoveTasks"
|
563
|
+
o.http_method = "POST"
|
564
|
+
o.http_request_uri = "/"
|
565
|
+
o.input = Shapes::ShapeRef.new(shape: ListMessageMoveTasksRequest)
|
566
|
+
o.output = Shapes::ShapeRef.new(shape: ListMessageMoveTasksResult)
|
567
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
568
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperation)
|
569
|
+
end)
|
570
|
+
|
505
571
|
api.add_operation(:list_queue_tags, Seahorse::Model::Operation.new.tap do |o|
|
506
572
|
o.name = "ListQueueTags"
|
507
573
|
o.http_method = "POST"
|
@@ -584,6 +650,16 @@ module Aws::SQS
|
|
584
650
|
o.errors << Shapes::ShapeRef.new(shape: InvalidAttributeName)
|
585
651
|
end)
|
586
652
|
|
653
|
+
api.add_operation(:start_message_move_task, Seahorse::Model::Operation.new.tap do |o|
|
654
|
+
o.name = "StartMessageMoveTask"
|
655
|
+
o.http_method = "POST"
|
656
|
+
o.http_request_uri = "/"
|
657
|
+
o.input = Shapes::ShapeRef.new(shape: StartMessageMoveTaskRequest)
|
658
|
+
o.output = Shapes::ShapeRef.new(shape: StartMessageMoveTaskResult)
|
659
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
660
|
+
o.errors << Shapes::ShapeRef.new(shape: UnsupportedOperation)
|
661
|
+
end)
|
662
|
+
|
587
663
|
api.add_operation(:tag_queue, Seahorse::Model::Operation.new.tap do |o|
|
588
664
|
o.name = "TagQueue"
|
589
665
|
o.http_method = "POST"
|
@@ -25,6 +25,20 @@ module Aws::SQS
|
|
25
25
|
end
|
26
26
|
end
|
27
27
|
|
28
|
+
class CancelMessageMoveTask
|
29
|
+
def self.build(context)
|
30
|
+
unless context.config.regional_endpoint
|
31
|
+
endpoint = context.config.endpoint.to_s
|
32
|
+
end
|
33
|
+
Aws::SQS::EndpointParameters.new(
|
34
|
+
region: context.config.region,
|
35
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
36
|
+
use_fips: context.config.use_fips_endpoint,
|
37
|
+
endpoint: endpoint,
|
38
|
+
)
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
28
42
|
class ChangeMessageVisibility
|
29
43
|
def self.build(context)
|
30
44
|
unless context.config.regional_endpoint
|
@@ -151,6 +165,20 @@ module Aws::SQS
|
|
151
165
|
end
|
152
166
|
end
|
153
167
|
|
168
|
+
class ListMessageMoveTasks
|
169
|
+
def self.build(context)
|
170
|
+
unless context.config.regional_endpoint
|
171
|
+
endpoint = context.config.endpoint.to_s
|
172
|
+
end
|
173
|
+
Aws::SQS::EndpointParameters.new(
|
174
|
+
region: context.config.region,
|
175
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
176
|
+
use_fips: context.config.use_fips_endpoint,
|
177
|
+
endpoint: endpoint,
|
178
|
+
)
|
179
|
+
end
|
180
|
+
end
|
181
|
+
|
154
182
|
class ListQueueTags
|
155
183
|
def self.build(context)
|
156
184
|
unless context.config.regional_endpoint
|
@@ -263,6 +291,20 @@ module Aws::SQS
|
|
263
291
|
end
|
264
292
|
end
|
265
293
|
|
294
|
+
class StartMessageMoveTask
|
295
|
+
def self.build(context)
|
296
|
+
unless context.config.regional_endpoint
|
297
|
+
endpoint = context.config.endpoint.to_s
|
298
|
+
end
|
299
|
+
Aws::SQS::EndpointParameters.new(
|
300
|
+
region: context.config.region,
|
301
|
+
use_dual_stack: context.config.use_dualstack_endpoint,
|
302
|
+
use_fips: context.config.use_fips_endpoint,
|
303
|
+
endpoint: endpoint,
|
304
|
+
)
|
305
|
+
end
|
306
|
+
end
|
307
|
+
|
266
308
|
class TagQueue
|
267
309
|
def self.build(context)
|
268
310
|
unless context.config.regional_endpoint
|
data/lib/aws-sdk-sqs/errors.rb
CHANGED
@@ -41,6 +41,7 @@ module Aws::SQS
|
|
41
41
|
# * {QueueDoesNotExist}
|
42
42
|
# * {QueueNameExists}
|
43
43
|
# * {ReceiptHandleIsInvalid}
|
44
|
+
# * {ResourceNotFoundException}
|
44
45
|
# * {TooManyEntriesInBatchRequest}
|
45
46
|
# * {UnsupportedOperation}
|
46
47
|
#
|
@@ -190,6 +191,16 @@ module Aws::SQS
|
|
190
191
|
end
|
191
192
|
end
|
192
193
|
|
194
|
+
class ResourceNotFoundException < ServiceError
|
195
|
+
|
196
|
+
# @param [Seahorse::Client::RequestContext] context
|
197
|
+
# @param [String] message
|
198
|
+
# @param [Aws::SQS::Types::ResourceNotFoundException] data
|
199
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
200
|
+
super(context, message, data)
|
201
|
+
end
|
202
|
+
end
|
203
|
+
|
193
204
|
class TooManyEntriesInBatchRequest < ServiceError
|
194
205
|
|
195
206
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -58,6 +58,8 @@ module Aws::SQS
|
|
58
58
|
case context.operation_name
|
59
59
|
when :add_permission
|
60
60
|
Aws::SQS::Endpoints::AddPermission.build(context)
|
61
|
+
when :cancel_message_move_task
|
62
|
+
Aws::SQS::Endpoints::CancelMessageMoveTask.build(context)
|
61
63
|
when :change_message_visibility
|
62
64
|
Aws::SQS::Endpoints::ChangeMessageVisibility.build(context)
|
63
65
|
when :change_message_visibility_batch
|
@@ -76,6 +78,8 @@ module Aws::SQS
|
|
76
78
|
Aws::SQS::Endpoints::GetQueueUrl.build(context)
|
77
79
|
when :list_dead_letter_source_queues
|
78
80
|
Aws::SQS::Endpoints::ListDeadLetterSourceQueues.build(context)
|
81
|
+
when :list_message_move_tasks
|
82
|
+
Aws::SQS::Endpoints::ListMessageMoveTasks.build(context)
|
79
83
|
when :list_queue_tags
|
80
84
|
Aws::SQS::Endpoints::ListQueueTags.build(context)
|
81
85
|
when :list_queues
|
@@ -92,6 +96,8 @@ module Aws::SQS
|
|
92
96
|
Aws::SQS::Endpoints::SendMessageBatch.build(context)
|
93
97
|
when :set_queue_attributes
|
94
98
|
Aws::SQS::Endpoints::SetQueueAttributes.build(context)
|
99
|
+
when :start_message_move_task
|
100
|
+
Aws::SQS::Endpoints::StartMessageMoveTask.build(context)
|
95
101
|
when :tag_queue
|
96
102
|
Aws::SQS::Endpoints::TagQueue.build(context)
|
97
103
|
when :untag_queue
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
@@ -144,7 +144,7 @@ module Aws::SQS
|
|
144
144
|
# })
|
145
145
|
# @param [Hash] options ({})
|
146
146
|
# @option options [required, Array<Types::ChangeMessageVisibilityBatchRequestEntry>] :entries
|
147
|
-
#
|
147
|
+
# Lists the receipt handles of the messages for which the visibility
|
148
148
|
# timeout must be changed.
|
149
149
|
# @return [Types::ChangeMessageVisibilityBatchResult]
|
150
150
|
def change_message_visibility_batch(options = {})
|
@@ -180,7 +180,7 @@ module Aws::SQS
|
|
180
180
|
# })
|
181
181
|
# @param [Hash] options ({})
|
182
182
|
# @option options [required, Array<Types::DeleteMessageBatchRequestEntry>] :entries
|
183
|
-
#
|
183
|
+
# Lists the receipt handles for the messages to be deleted.
|
184
184
|
# @return [Types::DeleteMessageBatchResult]
|
185
185
|
def delete_messages(options = {})
|
186
186
|
options = options.merge(queue_url: @url)
|
@@ -230,7 +230,7 @@ module Aws::SQS
|
|
230
230
|
#
|
231
231
|
# * `SenderId`
|
232
232
|
#
|
233
|
-
# * For
|
233
|
+
# * For a user, returns the user ID, for example
|
234
234
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
235
235
|
#
|
236
236
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -241,7 +241,7 @@ module Aws::SQS
|
|
241
241
|
#
|
242
242
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
243
243
|
# SQS owned encryption keys. Only one server-side encryption option is
|
244
|
-
# supported per queue (
|
244
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
245
245
|
#
|
246
246
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
247
247
|
# producer that calls the ` SendMessage ` action.
|
@@ -432,7 +432,7 @@ module Aws::SQS
|
|
432
432
|
# @param [Hash] options ({})
|
433
433
|
# @option options [required, String] :message_body
|
434
434
|
# The message to send. The minimum size is one character. The maximum
|
435
|
-
# size is 256
|
435
|
+
# size is 256 KiB.
|
436
436
|
#
|
437
437
|
# A message can include only XML, JSON, and unformatted text. The
|
438
438
|
# following Unicode characters are allowed:
|
@@ -646,7 +646,13 @@ module Aws::SQS
|
|
646
646
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
647
647
|
# Amazon SQS retains a message. Valid values: An integer representing
|
648
648
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
649
|
-
# (4 days).
|
649
|
+
# (4 days). When you change a queue's attributes, the change can take
|
650
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
651
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
652
|
+
# attribute can take up to 15 minutes and will impact existing
|
653
|
+
# messages in the queue potentially causing them to be expired and
|
654
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
655
|
+
# existing messages.
|
650
656
|
#
|
651
657
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
652
658
|
# For more information about policy structure, see [Overview of Amazon
|
@@ -657,31 +663,59 @@ module Aws::SQS
|
|
657
663
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
658
664
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
659
665
|
#
|
666
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
667
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
668
|
+
# Default: 30. For more information about the visibility timeout, see
|
669
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
670
|
+
#
|
671
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
672
|
+
#
|
660
673
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
661
674
|
# dead-letter queue functionality of the source queue as a JSON
|
662
|
-
# object.
|
663
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
664
|
-
# the *Amazon SQS Developer Guide*.
|
675
|
+
# object. The parameters are as follows:
|
665
676
|
#
|
666
677
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
667
678
|
# dead-letter queue to which Amazon SQS moves messages after the
|
668
679
|
# value of `maxReceiveCount` is exceeded.
|
669
680
|
#
|
670
681
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
671
|
-
# the source queue before being moved to the dead-letter queue.
|
672
|
-
# the `ReceiveCount` for a message exceeds the
|
673
|
-
# a queue, Amazon SQS moves the message to the
|
674
|
-
#
|
675
|
-
#
|
676
|
-
#
|
677
|
-
#
|
682
|
+
# the source queue before being moved to the dead-letter queue.
|
683
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
684
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
685
|
+
# dead-letter-queue.
|
686
|
+
#
|
687
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
688
|
+
# the permissions for the dead-letter queue redrive permission and
|
689
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
690
|
+
# The parameters are as follows:
|
691
|
+
#
|
692
|
+
# * `redrivePermission` – The permission type that defines which
|
693
|
+
# source queues can specify the current queue as the dead-letter
|
694
|
+
# queue. Valid values are:
|
695
|
+
#
|
696
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
697
|
+
# Services account in the same Region can specify this queue as
|
698
|
+
# the dead-letter queue.
|
699
|
+
#
|
700
|
+
# * `denyAll` – No source queues can specify this queue as the
|
701
|
+
# dead-letter queue.
|
702
|
+
#
|
703
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
704
|
+
# parameter can specify this queue as the dead-letter queue.
|
705
|
+
#
|
706
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
707
|
+
# queues that can specify this queue as the dead-letter queue and
|
708
|
+
# redrive messages. You can specify this parameter only when the
|
709
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
710
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
711
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
712
|
+
# to `allowAll`.
|
713
|
+
#
|
714
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
715
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
716
|
+
# standard queue.
|
678
717
|
#
|
679
|
-
#
|
680
|
-
#
|
681
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
682
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
683
|
-
# Default: 30. For more information about the visibility timeout, see
|
684
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
718
|
+
# </note>
|
685
719
|
#
|
686
720
|
# The following attributes apply only to [server-side-encryption][4]:
|
687
721
|
#
|
@@ -703,7 +737,7 @@ module Aws::SQS
|
|
703
737
|
#
|
704
738
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
705
739
|
# SQS owned encryption keys. Only one server-side encryption option is
|
706
|
-
# supported per queue (
|
740
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
707
741
|
#
|
708
742
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
709
743
|
# queues][11]:
|
@@ -769,8 +803,8 @@ module Aws::SQS
|
|
769
803
|
#
|
770
804
|
#
|
771
805
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
772
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
773
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
806
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
807
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
774
808
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
775
809
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
776
810
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -76,41 +76,75 @@ module Aws::SQS
|
|
76
76
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
77
77
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
78
78
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
79
|
-
# (4 days).
|
79
|
+
# (4 days). When you change a queue's attributes, the change can take
|
80
|
+
# up to 60 seconds for most of the attributes to propagate throughout
|
81
|
+
# the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
|
82
|
+
# attribute can take up to 15 minutes and will impact existing
|
83
|
+
# messages in the queue potentially causing them to be expired and
|
84
|
+
# deleted if the `MessageRetentionPeriod` is reduced below the age of
|
85
|
+
# existing messages.
|
80
86
|
#
|
81
87
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
82
88
|
# For more information about policy structure, see [Overview of Amazon
|
83
|
-
# Web Services IAM Policies][1] in the *
|
89
|
+
# Web Services IAM Policies][1] in the *IAM User Guide*.
|
84
90
|
#
|
85
91
|
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
86
92
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
87
93
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
88
94
|
#
|
95
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
96
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
97
|
+
# Default: 30. For more information about the visibility timeout, see
|
98
|
+
# [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
|
99
|
+
#
|
100
|
+
# The following attributes apply only to [dead-letter queues:][3]
|
101
|
+
#
|
89
102
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
90
103
|
# dead-letter queue functionality of the source queue as a JSON
|
91
|
-
# object.
|
92
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
93
|
-
# the *Amazon SQS Developer Guide*.
|
104
|
+
# object. The parameters are as follows:
|
94
105
|
#
|
95
106
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
96
107
|
# dead-letter queue to which Amazon SQS moves messages after the
|
97
108
|
# value of `maxReceiveCount` is exceeded.
|
98
109
|
#
|
99
110
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
100
|
-
# the source queue before being moved to the dead-letter queue.
|
101
|
-
# the `ReceiveCount` for a message exceeds the
|
102
|
-
# a queue, Amazon SQS moves the message to the
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
111
|
+
# the source queue before being moved to the dead-letter queue.
|
112
|
+
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
113
|
+
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
114
|
+
# dead-letter-queue.
|
115
|
+
#
|
116
|
+
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
117
|
+
# the permissions for the dead-letter queue redrive permission and
|
118
|
+
# which source queues can specify dead-letter queues as a JSON object.
|
119
|
+
# The parameters are as follows:
|
120
|
+
#
|
121
|
+
# * `redrivePermission` – The permission type that defines which
|
122
|
+
# source queues can specify the current queue as the dead-letter
|
123
|
+
# queue. Valid values are:
|
124
|
+
#
|
125
|
+
# * `allowAll` – (Default) Any source queues in this Amazon Web
|
126
|
+
# Services account in the same Region can specify this queue as
|
127
|
+
# the dead-letter queue.
|
128
|
+
#
|
129
|
+
# * `denyAll` – No source queues can specify this queue as the
|
130
|
+
# dead-letter queue.
|
131
|
+
#
|
132
|
+
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
133
|
+
# parameter can specify this queue as the dead-letter queue.
|
134
|
+
#
|
135
|
+
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
136
|
+
# queues that can specify this queue as the dead-letter queue and
|
137
|
+
# redrive messages. You can specify this parameter only when the
|
138
|
+
# `redrivePermission` parameter is set to `byQueue`. You can specify
|
139
|
+
# up to 10 source queue ARNs. To allow more than 10 source queues to
|
140
|
+
# specify dead-letter queues, set the `redrivePermission` parameter
|
141
|
+
# to `allowAll`.
|
142
|
+
#
|
143
|
+
# <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
|
144
|
+
# Similarly, the dead-letter queue of a standard queue must also be a
|
145
|
+
# standard queue.
|
107
146
|
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
111
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
112
|
-
# Default: 30. For more information about the visibility timeout, see
|
113
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
147
|
+
# </note>
|
114
148
|
#
|
115
149
|
# The following attributes apply only to [server-side-encryption][4]:
|
116
150
|
#
|
@@ -129,11 +163,11 @@ module Aws::SQS
|
|
129
163
|
# Default: 300 (5 minutes). A shorter time period provides better
|
130
164
|
# security but results in more calls to KMS which might incur charges
|
131
165
|
# after Free Tier. For more information, see [How Does the Data Key
|
132
|
-
# Reuse Period Work?][8]
|
166
|
+
# Reuse Period Work?][8]
|
133
167
|
#
|
134
168
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
135
169
|
# SQS owned encryption keys. Only one server-side encryption option is
|
136
|
-
# supported per queue (
|
170
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
137
171
|
#
|
138
172
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
139
173
|
# queues][11]:
|
@@ -210,8 +244,8 @@ module Aws::SQS
|
|
210
244
|
#
|
211
245
|
#
|
212
246
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
213
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
214
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
247
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
248
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
215
249
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
216
250
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
217
251
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -248,8 +282,8 @@ module Aws::SQS
|
|
248
282
|
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
249
283
|
#
|
250
284
|
# Cross-account permissions don't apply to this action. For more
|
251
|
-
# information, see [Grant cross-account permissions to a role and a
|
252
|
-
#
|
285
|
+
# information, see [Grant cross-account permissions to a role and a
|
286
|
+
# username][3] in the *Amazon SQS Developer Guide*.
|
253
287
|
#
|
254
288
|
# </note>
|
255
289
|
#
|