aws-sdk-sqs 1.88.0 → 1.107.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 +95 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +228 -156
- data/lib/aws-sdk-sqs/client_api.rb +4 -4
- data/lib/aws-sdk-sqs/customizations.rb +0 -1
- data/lib/aws-sdk-sqs/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-sqs/endpoint_provider.rb +14 -18
- data/lib/aws-sdk-sqs/queue.rb +91 -46
- data/lib/aws-sdk-sqs/queue_poller.rb +1 -1
- data/lib/aws-sdk-sqs/resource.rb +9 -12
- data/lib/aws-sdk-sqs/types.rb +167 -96
- data/lib/aws-sdk-sqs.rb +1 -1
- data/sig/client.rbs +3 -0
- data/sig/resource.rbs +3 -0
- metadata +6 -9
|
@@ -293,7 +293,7 @@ module Aws::SQS
|
|
|
293
293
|
ListMessageMoveTasksRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "MaxResults"))
|
|
294
294
|
ListMessageMoveTasksRequest.struct_class = Types::ListMessageMoveTasksRequest
|
|
295
295
|
|
|
296
|
-
ListMessageMoveTasksResult.add_member(:results, Shapes::ShapeRef.new(shape: ListMessageMoveTasksResultEntryList, location_name: "Results", metadata: {"flattened"=>true}))
|
|
296
|
+
ListMessageMoveTasksResult.add_member(:results, Shapes::ShapeRef.new(shape: ListMessageMoveTasksResultEntryList, location_name: "Results", metadata: {"flattened" => true}))
|
|
297
297
|
ListMessageMoveTasksResult.struct_class = Types::ListMessageMoveTasksResult
|
|
298
298
|
|
|
299
299
|
ListMessageMoveTasksResultEntry.add_member(:task_handle, Shapes::ShapeRef.new(shape: String, location_name: "TaskHandle"))
|
|
@@ -359,8 +359,8 @@ module Aws::SQS
|
|
|
359
359
|
|
|
360
360
|
MessageSystemAttributeValue.add_member(:string_value, Shapes::ShapeRef.new(shape: String, location_name: "StringValue"))
|
|
361
361
|
MessageSystemAttributeValue.add_member(:binary_value, Shapes::ShapeRef.new(shape: Binary, location_name: "BinaryValue"))
|
|
362
|
-
MessageSystemAttributeValue.add_member(:string_list_values, Shapes::ShapeRef.new(shape: StringList, location_name: "StringListValues", metadata: {"flattened"=>true}))
|
|
363
|
-
MessageSystemAttributeValue.add_member(:binary_list_values, Shapes::ShapeRef.new(shape: BinaryList, location_name: "BinaryListValues", metadata: {"flattened"=>true}))
|
|
362
|
+
MessageSystemAttributeValue.add_member(:string_list_values, Shapes::ShapeRef.new(shape: StringList, location_name: "StringListValues", metadata: {"flattened" => true}))
|
|
363
|
+
MessageSystemAttributeValue.add_member(:binary_list_values, Shapes::ShapeRef.new(shape: BinaryList, location_name: "BinaryListValues", metadata: {"flattened" => true}))
|
|
364
364
|
MessageSystemAttributeValue.add_member(:data_type, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DataType"))
|
|
365
365
|
MessageSystemAttributeValue.struct_class = Types::MessageSystemAttributeValue
|
|
366
366
|
|
|
@@ -391,7 +391,7 @@ module Aws::SQS
|
|
|
391
391
|
ReceiptHandleIsInvalid.struct_class = Types::ReceiptHandleIsInvalid
|
|
392
392
|
|
|
393
393
|
ReceiveMessageRequest.add_member(:queue_url, Shapes::ShapeRef.new(shape: String, required: true, location_name: "QueueUrl"))
|
|
394
|
-
ReceiveMessageRequest.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNameList, deprecated: true, location_name: "AttributeNames", metadata: {"deprecatedMessage"=>"AttributeNames has been replaced by MessageSystemAttributeNames"}))
|
|
394
|
+
ReceiveMessageRequest.add_member(:attribute_names, Shapes::ShapeRef.new(shape: AttributeNameList, deprecated: true, location_name: "AttributeNames", metadata: {"deprecatedMessage" => "AttributeNames has been replaced by MessageSystemAttributeNames"}))
|
|
395
395
|
ReceiveMessageRequest.add_member(:message_system_attribute_names, Shapes::ShapeRef.new(shape: MessageSystemAttributeList, location_name: "MessageSystemAttributeNames"))
|
|
396
396
|
ReceiveMessageRequest.add_member(:message_attribute_names, Shapes::ShapeRef.new(shape: MessageAttributeNameList, location_name: "MessageAttributeNames"))
|
|
397
397
|
ReceiveMessageRequest.add_member(:max_number_of_messages, Shapes::ShapeRef.new(shape: NullableInteger, location_name: "MaxNumberOfMessages"))
|
|
@@ -13,22 +13,22 @@ module Aws::SQS
|
|
|
13
13
|
# @!attribute region
|
|
14
14
|
# The AWS region used to dispatch the request.
|
|
15
15
|
#
|
|
16
|
-
# @return [
|
|
16
|
+
# @return [string]
|
|
17
17
|
#
|
|
18
18
|
# @!attribute use_dual_stack
|
|
19
19
|
# When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
|
|
20
20
|
#
|
|
21
|
-
# @return [
|
|
21
|
+
# @return [boolean]
|
|
22
22
|
#
|
|
23
23
|
# @!attribute use_fips
|
|
24
24
|
# When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
|
|
25
25
|
#
|
|
26
|
-
# @return [
|
|
26
|
+
# @return [boolean]
|
|
27
27
|
#
|
|
28
28
|
# @!attribute endpoint
|
|
29
29
|
# Override the endpoint used to send this request
|
|
30
30
|
#
|
|
31
|
-
# @return [
|
|
31
|
+
# @return [string]
|
|
32
32
|
#
|
|
33
33
|
EndpointParameters = Struct.new(
|
|
34
34
|
:region,
|
|
@@ -10,43 +10,39 @@
|
|
|
10
10
|
module Aws::SQS
|
|
11
11
|
class EndpointProvider
|
|
12
12
|
def resolve_endpoint(parameters)
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
use_fips = parameters.use_fips
|
|
16
|
-
endpoint = parameters.endpoint
|
|
17
|
-
if Aws::Endpoints::Matchers.set?(endpoint)
|
|
18
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
13
|
+
if Aws::Endpoints::Matchers.set?(parameters.endpoint)
|
|
14
|
+
if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_fips, true)
|
|
19
15
|
raise ArgumentError, "Invalid Configuration: FIPS and custom endpoint are not supported"
|
|
20
16
|
end
|
|
21
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
17
|
+
if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_dual_stack, true)
|
|
22
18
|
raise ArgumentError, "Invalid Configuration: Dualstack and custom endpoint are not supported"
|
|
23
19
|
end
|
|
24
|
-
return Aws::Endpoints::Endpoint.new(url: endpoint, headers: {}, properties: {})
|
|
20
|
+
return Aws::Endpoints::Endpoint.new(url: parameters.endpoint, headers: {}, properties: {})
|
|
25
21
|
end
|
|
26
|
-
if Aws::Endpoints::Matchers.set?(region)
|
|
27
|
-
if (partition_result = Aws::Endpoints::Matchers.aws_partition(region))
|
|
28
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
22
|
+
if Aws::Endpoints::Matchers.set?(parameters.region)
|
|
23
|
+
if (partition_result = Aws::Endpoints::Matchers.aws_partition(parameters.region))
|
|
24
|
+
if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_fips, true) && Aws::Endpoints::Matchers.boolean_equals?(parameters.use_dual_stack, true)
|
|
29
25
|
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS")) && Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
30
|
-
return Aws::Endpoints::Endpoint.new(url: "https://sqs-fips.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
26
|
+
return Aws::Endpoints::Endpoint.new(url: "https://sqs-fips.#{parameters.region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
31
27
|
end
|
|
32
28
|
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
|
33
29
|
end
|
|
34
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
|
30
|
+
if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_fips, true)
|
|
35
31
|
if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
|
|
36
32
|
if Aws::Endpoints::Matchers.string_equals?(Aws::Endpoints::Matchers.attr(partition_result, "name"), "aws-us-gov")
|
|
37
|
-
return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{region}.amazonaws.com", headers: {}, properties: {})
|
|
33
|
+
return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{parameters.region}.amazonaws.com", headers: {}, properties: {})
|
|
38
34
|
end
|
|
39
|
-
return Aws::Endpoints::Endpoint.new(url: "https://sqs-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
35
|
+
return Aws::Endpoints::Endpoint.new(url: "https://sqs-fips.#{parameters.region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
40
36
|
end
|
|
41
37
|
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
|
42
38
|
end
|
|
43
|
-
if Aws::Endpoints::Matchers.boolean_equals?(use_dual_stack, true)
|
|
39
|
+
if Aws::Endpoints::Matchers.boolean_equals?(parameters.use_dual_stack, true)
|
|
44
40
|
if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsDualStack"))
|
|
45
|
-
return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
41
|
+
return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{parameters.region}.#{partition_result['dualStackDnsSuffix']}", headers: {}, properties: {})
|
|
46
42
|
end
|
|
47
43
|
raise ArgumentError, "DualStack is enabled but this partition does not support DualStack"
|
|
48
44
|
end
|
|
49
|
-
return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
45
|
+
return Aws::Endpoints::Endpoint.new(url: "https://sqs.#{parameters.region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
|
50
46
|
end
|
|
51
47
|
end
|
|
52
48
|
raise ArgumentError, "Invalid Configuration: Missing Region"
|
data/lib/aws-sdk-sqs/queue.rb
CHANGED
|
@@ -216,9 +216,9 @@ module Aws::SQS
|
|
|
216
216
|
# })
|
|
217
217
|
# @param [Hash] options ({})
|
|
218
218
|
# @option options [Array<String>] :attribute_names
|
|
219
|
-
# This parameter has been
|
|
220
|
-
# compatibility. To provide attribute names, you are encouraged
|
|
221
|
-
# `MessageSystemAttributeNames`.
|
|
219
|
+
# This parameter has been discontinued but will be supported for
|
|
220
|
+
# backward compatibility. To provide attribute names, you are encouraged
|
|
221
|
+
# to use `MessageSystemAttributeNames`.
|
|
222
222
|
#
|
|
223
223
|
# A list of attributes that need to be returned along with each message.
|
|
224
224
|
# These attributes include:
|
|
@@ -240,7 +240,6 @@ module Aws::SQS
|
|
|
240
240
|
#
|
|
241
241
|
# * For an IAM role, returns the IAM role ID, for example
|
|
242
242
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
|
243
|
-
#
|
|
244
243
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
|
245
244
|
# ([epoch time][1] in milliseconds).
|
|
246
245
|
#
|
|
@@ -252,8 +251,7 @@ module Aws::SQS
|
|
|
252
251
|
# producer that calls the ` SendMessage ` action.
|
|
253
252
|
#
|
|
254
253
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
|
255
|
-
# calls the ` SendMessage ` action.
|
|
256
|
-
# `MessageGroupId` are returned in sequence.
|
|
254
|
+
# calls the ` SendMessage ` action.
|
|
257
255
|
#
|
|
258
256
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
|
259
257
|
#
|
|
@@ -283,7 +281,6 @@ module Aws::SQS
|
|
|
283
281
|
#
|
|
284
282
|
# * For an IAM role, returns the IAM role ID, for example
|
|
285
283
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
|
286
|
-
#
|
|
287
284
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
|
288
285
|
# ([epoch time][1] in milliseconds).
|
|
289
286
|
#
|
|
@@ -295,8 +292,7 @@ module Aws::SQS
|
|
|
295
292
|
# producer that calls the ` SendMessage ` action.
|
|
296
293
|
#
|
|
297
294
|
# * `MessageGroupId` – Returns the value provided by the producer that
|
|
298
|
-
# calls the ` SendMessage ` action.
|
|
299
|
-
# `MessageGroupId` are returned in sequence.
|
|
295
|
+
# calls the ` SendMessage ` action.
|
|
300
296
|
#
|
|
301
297
|
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
|
302
298
|
#
|
|
@@ -333,13 +329,46 @@ module Aws::SQS
|
|
|
333
329
|
# @option options [Integer] :visibility_timeout
|
|
334
330
|
# The duration (in seconds) that the received messages are hidden from
|
|
335
331
|
# subsequent retrieve requests after being retrieved by a
|
|
336
|
-
# `ReceiveMessage` request.
|
|
332
|
+
# `ReceiveMessage` request. If not specified, the default visibility
|
|
333
|
+
# timeout for the queue is used, which is 30 seconds.
|
|
334
|
+
#
|
|
335
|
+
# Understanding `VisibilityTimeout`:
|
|
336
|
+
#
|
|
337
|
+
# * When a message is received from a queue, it becomes temporarily
|
|
338
|
+
# invisible to other consumers for the duration of the visibility
|
|
339
|
+
# timeout. This prevents multiple consumers from processing the same
|
|
340
|
+
# message simultaneously. If the message is not deleted or its
|
|
341
|
+
# visibility timeout is not extended before the timeout expires, it
|
|
342
|
+
# becomes visible again and can be retrieved by other consumers.
|
|
343
|
+
#
|
|
344
|
+
# * Setting an appropriate visibility timeout is crucial. If it's too
|
|
345
|
+
# short, the message might become visible again before processing is
|
|
346
|
+
# complete, leading to duplicate processing. If it's too long, it
|
|
347
|
+
# delays the reprocessing of messages if the initial processing fails.
|
|
348
|
+
#
|
|
349
|
+
# * You can adjust the visibility timeout using the
|
|
350
|
+
# `--visibility-timeout` parameter in the `receive-message` command to
|
|
351
|
+
# match the processing time required by your application.
|
|
352
|
+
#
|
|
353
|
+
# * A message that isn't deleted or a message whose visibility isn't
|
|
354
|
+
# extended before the visibility timeout expires counts as a failed
|
|
355
|
+
# receive. Depending on the configuration of the queue, the message
|
|
356
|
+
# might be sent to the dead-letter queue.
|
|
357
|
+
#
|
|
358
|
+
# For more information, see [Visibility Timeout][1] in the *Amazon SQS
|
|
359
|
+
# Developer Guide*.
|
|
360
|
+
#
|
|
361
|
+
#
|
|
362
|
+
#
|
|
363
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
|
337
364
|
# @option options [Integer] :wait_time_seconds
|
|
338
365
|
# The duration (in seconds) for which the call waits for a message to
|
|
339
366
|
# arrive in the queue before returning. If a message is available, the
|
|
340
367
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
|
341
368
|
# available and the wait time expires, the call does not return a
|
|
342
|
-
# message list.
|
|
369
|
+
# message list. If you are using the Java SDK, it returns a
|
|
370
|
+
# `ReceiveMessageResponse` object, which has a empty list instead of a
|
|
371
|
+
# Null object.
|
|
343
372
|
#
|
|
344
373
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
345
374
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
|
@@ -391,7 +420,8 @@ module Aws::SQS
|
|
|
391
420
|
# * While messages with a particular `MessageGroupId` are invisible, no
|
|
392
421
|
# more messages belonging to the same `MessageGroupId` are returned
|
|
393
422
|
# until the visibility timeout expires. You can still receive messages
|
|
394
|
-
# with another `MessageGroupId` as long as
|
|
423
|
+
# with another `MessageGroupId` from your FIFO queue as long as they
|
|
424
|
+
# are visible.
|
|
395
425
|
#
|
|
396
426
|
# * If a caller of `ReceiveMessage` can't track the
|
|
397
427
|
# `ReceiveRequestAttemptId`, no retries work until the original
|
|
@@ -476,7 +506,7 @@ module Aws::SQS
|
|
|
476
506
|
# @param [Hash] options ({})
|
|
477
507
|
# @option options [required, String] :message_body
|
|
478
508
|
# The message to send. The minimum size is one character. The maximum
|
|
479
|
-
# size is
|
|
509
|
+
# size is 1 MiB or 1,048,576 bytes
|
|
480
510
|
#
|
|
481
511
|
# A message can include only XML, JSON, and unformatted text. The
|
|
482
512
|
# following Unicode characters are allowed. For more information, see
|
|
@@ -485,11 +515,10 @@ module Aws::SQS
|
|
|
485
515
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
|
|
486
516
|
# \| `#x10000` to `#x10FFFF`
|
|
487
517
|
#
|
|
488
|
-
#
|
|
489
|
-
# message
|
|
490
|
-
#
|
|
491
|
-
#
|
|
492
|
-
# character.
|
|
518
|
+
# If a message contains characters outside the allowed set, Amazon SQS
|
|
519
|
+
# rejects the message and returns an InvalidMessageContents error.
|
|
520
|
+
# Ensure that your message body includes only valid characters to avoid
|
|
521
|
+
# this exception.
|
|
493
522
|
#
|
|
494
523
|
#
|
|
495
524
|
#
|
|
@@ -548,7 +577,6 @@ module Aws::SQS
|
|
|
548
577
|
#
|
|
549
578
|
# * If the queue has `ContentBasedDeduplication` set, your
|
|
550
579
|
# `MessageDeduplicationId` overrides the generated one.
|
|
551
|
-
#
|
|
552
580
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
|
553
581
|
# identical content sent within the deduplication interval are treated
|
|
554
582
|
# as duplicates and only one copy of the message is delivered.
|
|
@@ -585,34 +613,54 @@ module Aws::SQS
|
|
|
585
613
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
|
|
586
614
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
|
587
615
|
# @option options [String] :message_group_id
|
|
588
|
-
#
|
|
589
|
-
#
|
|
590
|
-
#
|
|
591
|
-
#
|
|
592
|
-
#
|
|
593
|
-
# processed
|
|
594
|
-
#
|
|
595
|
-
#
|
|
596
|
-
#
|
|
597
|
-
#
|
|
598
|
-
#
|
|
599
|
-
#
|
|
600
|
-
#
|
|
601
|
-
#
|
|
602
|
-
#
|
|
616
|
+
# `MessageGroupId` is an attribute used in Amazon SQS FIFO
|
|
617
|
+
# (First-In-First-Out) and standard queues. In FIFO queues,
|
|
618
|
+
# `MessageGroupId` organizes messages into distinct groups. Messages
|
|
619
|
+
# within the same message group are always processed one at a time, in
|
|
620
|
+
# strict order, ensuring that no two messages from the same group are
|
|
621
|
+
# processed simultaneously. In standard queues, using `MessageGroupId`
|
|
622
|
+
# enables fair queues. It is used to identify the tenant a message
|
|
623
|
+
# belongs to, helping maintain consistent message dwell time across all
|
|
624
|
+
# tenants during noisy neighbor events. Unlike FIFO queues, messages
|
|
625
|
+
# with the same `MessageGroupId` can be processed in parallel,
|
|
626
|
+
# maintaining the high throughput of standard queues.
|
|
627
|
+
#
|
|
628
|
+
# * **FIFO queues:** `MessageGroupId` acts as the tag that specifies
|
|
629
|
+
# that a message belongs to a specific message group. Messages that
|
|
630
|
+
# belong to the same message group are processed in a FIFO manner
|
|
631
|
+
# (however, messages in different message groups might be processed
|
|
632
|
+
# out of order). To interleave multiple ordered streams within a
|
|
633
|
+
# single queue, use `MessageGroupId` values (for example, session data
|
|
634
|
+
# for multiple users). In this scenario, multiple consumers can
|
|
635
|
+
# process the queue, but the session data of each user is processed in
|
|
636
|
+
# a FIFO fashion.
|
|
637
|
+
#
|
|
638
|
+
# If you do not provide a `MessageGroupId` when sending a message to a
|
|
639
|
+
# FIFO queue, the action fails.
|
|
640
|
+
#
|
|
641
|
+
# `ReceiveMessage` might return messages with multiple
|
|
603
642
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
|
604
|
-
# sorted by time sent.
|
|
605
|
-
#
|
|
606
|
-
#
|
|
607
|
-
#
|
|
643
|
+
# sorted by time sent.
|
|
644
|
+
#
|
|
645
|
+
# * **Standard queues:**Use `MessageGroupId` in standard queues to
|
|
646
|
+
# enable fair queues. The `MessageGroupId` identifies the tenant a
|
|
647
|
+
# message belongs to. A tenant can be any entity that shares a queue
|
|
648
|
+
# with others, such as your customer, a client application, or a
|
|
649
|
+
# request type. When one tenant sends a disproportionately large
|
|
650
|
+
# volume of messages or has messages that require longer processing
|
|
651
|
+
# time, fair queues ensure other tenants' messages maintain low dwell
|
|
652
|
+
# time. This preserves quality of service for all tenants while
|
|
653
|
+
# maintaining the scalability and throughput of standard queues. We
|
|
654
|
+
# recommend that you include a `MessageGroupId` in all messages when
|
|
655
|
+
# using fair queues.
|
|
656
|
+
#
|
|
657
|
+
# The length of `MessageGroupId` is 128 characters. Valid values:
|
|
658
|
+
# alphanumeric characters and punctuation ``
|
|
608
659
|
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
|
609
660
|
#
|
|
610
661
|
# For best practices of using `MessageGroupId`, see [Using the
|
|
611
662
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
|
612
663
|
#
|
|
613
|
-
# `MessageGroupId` is required for FIFO queues. You can't use it for
|
|
614
|
-
# Standard queues.
|
|
615
|
-
#
|
|
616
664
|
#
|
|
617
665
|
#
|
|
618
666
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
|
@@ -688,8 +736,8 @@ module Aws::SQS
|
|
|
688
736
|
#
|
|
689
737
|
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
|
690
738
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
|
691
|
-
# 1,024 bytes (1 KiB) up to
|
|
692
|
-
# (
|
|
739
|
+
# 1,024 bytes (1 KiB) up to 1,048,576 bytes (1 MiB). Default:
|
|
740
|
+
# 1,048,576 bytes (1 MiB).
|
|
693
741
|
#
|
|
694
742
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
|
695
743
|
# Amazon SQS retains a message. Valid values: An integer representing
|
|
@@ -731,7 +779,6 @@ module Aws::SQS
|
|
|
731
779
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
|
732
780
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
|
733
781
|
# dead-letter-queue.
|
|
734
|
-
#
|
|
735
782
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
|
736
783
|
# the permissions for the dead-letter queue redrive permission and
|
|
737
784
|
# which source queues can specify dead-letter queues as a JSON object.
|
|
@@ -750,7 +797,6 @@ module Aws::SQS
|
|
|
750
797
|
#
|
|
751
798
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
|
752
799
|
# parameter can specify this queue as the dead-letter queue.
|
|
753
|
-
#
|
|
754
800
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
|
755
801
|
# queues that can specify this queue as the dead-letter queue and
|
|
756
802
|
# redrive messages. You can specify this parameter only when the
|
|
@@ -810,7 +856,6 @@ module Aws::SQS
|
|
|
810
856
|
#
|
|
811
857
|
# * If the queue has `ContentBasedDeduplication` set, your
|
|
812
858
|
# `MessageDeduplicationId` overrides the generated one.
|
|
813
|
-
#
|
|
814
859
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
|
815
860
|
# identical content sent within the deduplication interval are
|
|
816
861
|
# treated as duplicates and only one copy of the message is
|
|
@@ -134,7 +134,7 @@ module Aws
|
|
|
134
134
|
# ### `:idle_timeout` Option
|
|
135
135
|
#
|
|
136
136
|
# This is a configurable, maximum number of seconds to wait for a
|
|
137
|
-
# new message before the polling loop
|
|
137
|
+
# new message before the polling loop exits. By default, there is
|
|
138
138
|
# no idle timeout.
|
|
139
139
|
#
|
|
140
140
|
# # stops polling after a minute of no received messages
|
data/lib/aws-sdk-sqs/resource.rb
CHANGED
|
@@ -70,8 +70,8 @@ module Aws::SQS
|
|
|
70
70
|
#
|
|
71
71
|
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
|
72
72
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
|
73
|
-
# 1,024 bytes (1 KiB) to
|
|
74
|
-
# (
|
|
73
|
+
# 1,024 bytes (1 KiB) to 1,048,576 bytes (1 MiB). Default: 1,048,576
|
|
74
|
+
# bytes (1 MiB).
|
|
75
75
|
#
|
|
76
76
|
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
|
77
77
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
|
@@ -112,7 +112,6 @@ module Aws::SQS
|
|
|
112
112
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
|
113
113
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
|
114
114
|
# dead-letter-queue.
|
|
115
|
-
#
|
|
116
115
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
|
117
116
|
# the permissions for the dead-letter queue redrive permission and
|
|
118
117
|
# which source queues can specify dead-letter queues as a JSON object.
|
|
@@ -131,7 +130,6 @@ module Aws::SQS
|
|
|
131
130
|
#
|
|
132
131
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
|
133
132
|
# parameter can specify this queue as the dead-letter queue.
|
|
134
|
-
#
|
|
135
133
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
|
136
134
|
# queues that can specify this queue as the dead-letter queue and
|
|
137
135
|
# redrive messages. You can specify this parameter only when the
|
|
@@ -203,7 +201,6 @@ module Aws::SQS
|
|
|
203
201
|
#
|
|
204
202
|
# * If the queue has `ContentBasedDeduplication` set, your
|
|
205
203
|
# `MessageDeduplicationId` overrides the generated one.
|
|
206
|
-
#
|
|
207
204
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
|
208
205
|
# identical content sent within the deduplication interval are
|
|
209
206
|
# treated as duplicates and only one copy of the message is
|
|
@@ -311,14 +308,14 @@ module Aws::SQS
|
|
|
311
308
|
# })
|
|
312
309
|
# @param [Hash] options ({})
|
|
313
310
|
# @option options [required, String] :queue_name
|
|
314
|
-
# The name of the queue
|
|
315
|
-
#
|
|
316
|
-
# underscores (
|
|
317
|
-
#
|
|
318
|
-
# Queue URLs and names are case-sensitive.
|
|
311
|
+
# (Required) The name of the queue for which you want to fetch the URL.
|
|
312
|
+
# The name can be up to 80 characters long and can include alphanumeric
|
|
313
|
+
# characters, hyphens (-), and underscores (\_). Queue URLs and names
|
|
314
|
+
# are case-sensitive.
|
|
319
315
|
# @option options [String] :queue_owner_aws_account_id
|
|
320
|
-
# The Amazon Web Services account ID of the account that
|
|
321
|
-
# queue.
|
|
316
|
+
# (Optional) The Amazon Web Services account ID of the account that
|
|
317
|
+
# created the queue. This is only required when you are attempting to
|
|
318
|
+
# access a queue owned by another Amazon Web Services account.
|
|
322
319
|
# @return [Queue]
|
|
323
320
|
def get_queue_by_name(options = {})
|
|
324
321
|
resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do
|