aws-sdk-sqs 1.55.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +367 -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/message.rb +9 -3
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +6 -0
- data/lib/aws-sdk-sqs/queue.rb +95 -37
- data/lib/aws-sdk-sqs/resource.rb +67 -27
- data/lib/aws-sdk-sqs/types.rb +347 -75
- data/lib/aws-sdk-sqs.rb +1 -1
- metadata +4 -4
@@ -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
|
data/lib/aws-sdk-sqs/message.rb
CHANGED
@@ -163,7 +163,9 @@ module Aws::SQS
|
|
163
163
|
queue_url: @queue_url,
|
164
164
|
receipt_handle: @receipt_handle
|
165
165
|
)
|
166
|
-
resp =
|
166
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
167
|
+
@client.change_message_visibility(options)
|
168
|
+
end
|
167
169
|
resp.data
|
168
170
|
end
|
169
171
|
|
@@ -177,7 +179,9 @@ module Aws::SQS
|
|
177
179
|
queue_url: @queue_url,
|
178
180
|
receipt_handle: @receipt_handle
|
179
181
|
)
|
180
|
-
resp =
|
182
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
183
|
+
@client.delete_message(options)
|
184
|
+
end
|
181
185
|
resp.data
|
182
186
|
end
|
183
187
|
|
@@ -242,7 +246,9 @@ module Aws::SQS
|
|
242
246
|
receipt_handle: item.receipt_handle
|
243
247
|
}
|
244
248
|
end
|
245
|
-
|
249
|
+
Aws::Plugins::UserAgent.feature('resource') do
|
250
|
+
batch[0].client.delete_message_batch(params)
|
251
|
+
end
|
246
252
|
end
|
247
253
|
nil
|
248
254
|
end
|
@@ -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
@@ -54,10 +54,12 @@ module Aws::SQS
|
|
54
54
|
#
|
55
55
|
# @return [self]
|
56
56
|
def load
|
57
|
-
resp =
|
57
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
58
|
+
@client.get_queue_attributes(
|
58
59
|
queue_url: @url,
|
59
60
|
attribute_names: ["All"]
|
60
61
|
)
|
62
|
+
end
|
61
63
|
@data = resp.data
|
62
64
|
self
|
63
65
|
end
|
@@ -123,7 +125,9 @@ module Aws::SQS
|
|
123
125
|
# @return [EmptyStructure]
|
124
126
|
def add_permission(options = {})
|
125
127
|
options = options.merge(queue_url: @url)
|
126
|
-
resp =
|
128
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
129
|
+
@client.add_permission(options)
|
130
|
+
end
|
127
131
|
resp.data
|
128
132
|
end
|
129
133
|
|
@@ -140,12 +144,14 @@ module Aws::SQS
|
|
140
144
|
# })
|
141
145
|
# @param [Hash] options ({})
|
142
146
|
# @option options [required, Array<Types::ChangeMessageVisibilityBatchRequestEntry>] :entries
|
143
|
-
#
|
147
|
+
# Lists the receipt handles of the messages for which the visibility
|
144
148
|
# timeout must be changed.
|
145
149
|
# @return [Types::ChangeMessageVisibilityBatchResult]
|
146
150
|
def change_message_visibility_batch(options = {})
|
147
151
|
options = options.merge(queue_url: @url)
|
148
|
-
resp =
|
152
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
153
|
+
@client.change_message_visibility_batch(options)
|
154
|
+
end
|
149
155
|
resp.data
|
150
156
|
end
|
151
157
|
|
@@ -156,7 +162,9 @@ module Aws::SQS
|
|
156
162
|
# @return [EmptyStructure]
|
157
163
|
def delete(options = {})
|
158
164
|
options = options.merge(queue_url: @url)
|
159
|
-
resp =
|
165
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
166
|
+
@client.delete_queue(options)
|
167
|
+
end
|
160
168
|
resp.data
|
161
169
|
end
|
162
170
|
|
@@ -172,11 +180,13 @@ module Aws::SQS
|
|
172
180
|
# })
|
173
181
|
# @param [Hash] options ({})
|
174
182
|
# @option options [required, Array<Types::DeleteMessageBatchRequestEntry>] :entries
|
175
|
-
#
|
183
|
+
# Lists the receipt handles for the messages to be deleted.
|
176
184
|
# @return [Types::DeleteMessageBatchResult]
|
177
185
|
def delete_messages(options = {})
|
178
186
|
options = options.merge(queue_url: @url)
|
179
|
-
resp =
|
187
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
188
|
+
@client.delete_message_batch(options)
|
189
|
+
end
|
180
190
|
resp.data
|
181
191
|
end
|
182
192
|
|
@@ -187,7 +197,9 @@ module Aws::SQS
|
|
187
197
|
# @return [EmptyStructure]
|
188
198
|
def purge(options = {})
|
189
199
|
options = options.merge(queue_url: @url)
|
190
|
-
resp =
|
200
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
201
|
+
@client.purge_queue(options)
|
202
|
+
end
|
191
203
|
resp.data
|
192
204
|
end
|
193
205
|
|
@@ -218,7 +230,7 @@ module Aws::SQS
|
|
218
230
|
#
|
219
231
|
# * `SenderId`
|
220
232
|
#
|
221
|
-
# * For
|
233
|
+
# * For a user, returns the user ID, for example
|
222
234
|
# `ABCDEFGHI1JKLMNOPQ23R`.
|
223
235
|
#
|
224
236
|
# * For an IAM role, returns the IAM role ID, for example
|
@@ -229,7 +241,7 @@ module Aws::SQS
|
|
229
241
|
#
|
230
242
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
231
243
|
# SQS owned encryption keys. Only one server-side encryption option is
|
232
|
-
# supported per queue (
|
244
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
233
245
|
#
|
234
246
|
# * `MessageDeduplicationId` – Returns the value provided by the
|
235
247
|
# producer that calls the ` SendMessage ` action.
|
@@ -359,7 +371,9 @@ module Aws::SQS
|
|
359
371
|
def receive_messages(options = {})
|
360
372
|
batch = []
|
361
373
|
options = options.merge(queue_url: @url)
|
362
|
-
resp =
|
374
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
375
|
+
@client.receive_message(options)
|
376
|
+
end
|
363
377
|
resp.data.messages.each do |m|
|
364
378
|
batch << Message.new(
|
365
379
|
queue_url: @url,
|
@@ -383,7 +397,9 @@ module Aws::SQS
|
|
383
397
|
# @return [EmptyStructure]
|
384
398
|
def remove_permission(options = {})
|
385
399
|
options = options.merge(queue_url: @url)
|
386
|
-
resp =
|
400
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
401
|
+
@client.remove_permission(options)
|
402
|
+
end
|
387
403
|
resp.data
|
388
404
|
end
|
389
405
|
|
@@ -416,7 +432,7 @@ module Aws::SQS
|
|
416
432
|
# @param [Hash] options ({})
|
417
433
|
# @option options [required, String] :message_body
|
418
434
|
# The message to send. The minimum size is one character. The maximum
|
419
|
-
# size is 256
|
435
|
+
# size is 256 KiB.
|
420
436
|
#
|
421
437
|
# A message can include only XML, JSON, and unformatted text. The
|
422
438
|
# following Unicode characters are allowed:
|
@@ -555,7 +571,9 @@ module Aws::SQS
|
|
555
571
|
# @return [Types::SendMessageResult]
|
556
572
|
def send_message(options = {})
|
557
573
|
options = options.merge(queue_url: @url)
|
558
|
-
resp =
|
574
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
575
|
+
@client.send_message(options)
|
576
|
+
end
|
559
577
|
resp.data
|
560
578
|
end
|
561
579
|
|
@@ -596,7 +614,9 @@ module Aws::SQS
|
|
596
614
|
# @return [Types::SendMessageBatchResult]
|
597
615
|
def send_messages(options = {})
|
598
616
|
options = options.merge(queue_url: @url)
|
599
|
-
resp =
|
617
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
618
|
+
@client.send_message_batch(options)
|
619
|
+
end
|
600
620
|
resp.data
|
601
621
|
end
|
602
622
|
|
@@ -626,7 +646,13 @@ module Aws::SQS
|
|
626
646
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
627
647
|
# Amazon SQS retains a message. Valid values: An integer representing
|
628
648
|
# seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
|
629
|
-
# (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.
|
630
656
|
#
|
631
657
|
# * `Policy` – The queue's policy. A valid Amazon Web Services policy.
|
632
658
|
# For more information about policy structure, see [Overview of Amazon
|
@@ -637,31 +663,59 @@ module Aws::SQS
|
|
637
663
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
638
664
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
639
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
|
+
#
|
640
673
|
# * `RedrivePolicy` – The string that includes the parameters for the
|
641
674
|
# dead-letter queue functionality of the source queue as a JSON
|
642
|
-
# object.
|
643
|
-
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
644
|
-
# the *Amazon SQS Developer Guide*.
|
675
|
+
# object. The parameters are as follows:
|
645
676
|
#
|
646
677
|
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
647
678
|
# dead-letter queue to which Amazon SQS moves messages after the
|
648
679
|
# value of `maxReceiveCount` is exceeded.
|
649
680
|
#
|
650
681
|
# * `maxReceiveCount` – The number of times a message is delivered to
|
651
|
-
# the source queue before being moved to the dead-letter queue.
|
652
|
-
# the `ReceiveCount` for a message exceeds the
|
653
|
-
# a queue, Amazon SQS moves the message to the
|
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.
|
654
717
|
#
|
655
|
-
#
|
656
|
-
# Similarly, the dead-letter queue of a standard queue must also be a
|
657
|
-
# standard queue.
|
658
|
-
#
|
659
|
-
# </note>
|
660
|
-
#
|
661
|
-
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
662
|
-
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
663
|
-
# Default: 30. For more information about the visibility timeout, see
|
664
|
-
# [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
|
718
|
+
# </note>
|
665
719
|
#
|
666
720
|
# The following attributes apply only to [server-side-encryption][4]:
|
667
721
|
#
|
@@ -683,7 +737,7 @@ module Aws::SQS
|
|
683
737
|
#
|
684
738
|
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
685
739
|
# SQS owned encryption keys. Only one server-side encryption option is
|
686
|
-
# supported per queue (
|
740
|
+
# supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
|
687
741
|
#
|
688
742
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
689
743
|
# queues][11]:
|
@@ -749,8 +803,8 @@ module Aws::SQS
|
|
749
803
|
#
|
750
804
|
#
|
751
805
|
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
752
|
-
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-
|
753
|
-
# [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
|
754
808
|
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
755
809
|
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
756
810
|
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
@@ -765,7 +819,9 @@ module Aws::SQS
|
|
765
819
|
# @return [EmptyStructure]
|
766
820
|
def set_attributes(options = {})
|
767
821
|
options = options.merge(queue_url: @url)
|
768
|
-
resp =
|
822
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
823
|
+
@client.set_queue_attributes(options)
|
824
|
+
end
|
769
825
|
resp.data
|
770
826
|
end
|
771
827
|
|
@@ -779,7 +835,9 @@ module Aws::SQS
|
|
779
835
|
def dead_letter_source_queues(options = {})
|
780
836
|
batches = Enumerator.new do |y|
|
781
837
|
options = options.merge(queue_url: @url)
|
782
|
-
resp =
|
838
|
+
resp = Aws::Plugins::UserAgent.feature('resource') do
|
839
|
+
@client.list_dead_letter_source_queues(options)
|
840
|
+
end
|
783
841
|
resp.each_page do |page|
|
784
842
|
batch = []
|
785
843
|
page.data.queue_urls.each do |q|
|