From 0e4ced1406fca0ddccdac6f3405837885079bc79 Mon Sep 17 00:00:00 2001 From: "adam.gloyne" Date: Thu, 26 Oct 2023 09:48:24 +0100 Subject: [PATCH] docs: Add high throughput properties for fifo --- sqs/README.md | 2 ++ sqs/json_schemas/channel.json | 12 ++++++++++++ sqs/json_schemas/operation.json | 10 ++++++++++ 3 files changed, 24 insertions(+) diff --git a/sqs/README.md b/sqs/README.md index f632b66d..d62db3a2 100644 --- a/sqs/README.md +++ b/sqs/README.md @@ -48,6 +48,8 @@ An SQS queue can set up a Dead Letter Queue as part of a Redelivery Policy. To s |---|:---:|---| | `name` | string | **Required.** The name of the queue. When an [SNS Operation Binding Object]() references an SQS queue by name, the identifier should be the one in this field.| | `fifoQueue` | boolean | **Required.** Is this a FIFO queue? | +| `deduplicationScope` | string | **Optional.** Specifies whether message deduplication occurs at the message group or queue level. Valid values are `messageGroup` and `queue`. **This property applies only to high throughput for FIFO queues.** | +| `fifoThroughputLimit` | string | **Optional.** Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are `perQueue` and `perMessageGroupId`. **The `perMessageGroupId` value is allowed only when the value for DeduplicationScope is `messageGroup`. Setting both these values as such will enable high throughput on a FIFO queue. As above, this property applies only to high throughput for FIFO queues.** | | `deliveryDelay` | integer | **Optional.** The number of seconds to delay before a message sent to the queue can be received. Used to create a *delay queue*. Range is 0 to 15 minutes. Defaults to 0. | | `visibilityTimeout` |integer| **Optional.** The length of time, in seconds, that a consumer locks a message - hiding it from reads - before it is unlocked and can be read again. Range from 0 to 12 hours (43200 seconds). Defaults to 30 seconds. | | `receiveMessageWaitTime` |integer| **Optional.** Determines if the queue uses [short polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html) or [long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html). Set to zero (the default) the queue reads available messages and returns immediately. Set to a non-zero integer, long polling waits the specified number of seconds for messages to arrive before returning. | diff --git a/sqs/json_schemas/channel.json b/sqs/json_schemas/channel.json index 3930780a..fd8d4460 100644 --- a/sqs/json_schemas/channel.json +++ b/sqs/json_schemas/channel.json @@ -47,6 +47,16 @@ "description": "Is this a FIFO queue?", "default": false }, + "deduplicationScope": { + "type": "string", + "description": "Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue (default).", + "default": "queue" + }, + "fifoThroughputLimit": { + "type": "string", + "description": "Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue (default) and perMessageGroupId.", + "default": "perQueue" + }, "deliveryDelay": { "type": "integer", "description": "The number of seconds to delay before a message sent to the queue can be received. used to create a delay queue.", @@ -207,6 +217,8 @@ "queue": { "name": "myQueue", "fifoQueue": true, + "deduplicationScope": "messageGroup", + "fifoThroughputLimit": "perMessageGroupId", "deliveryDelay": 15, "visibilityTimeout": 60, "receiveMessageWaitTime": 0, diff --git a/sqs/json_schemas/operation.json b/sqs/json_schemas/operation.json index 9f26e977..0320c7de 100644 --- a/sqs/json_schemas/operation.json +++ b/sqs/json_schemas/operation.json @@ -50,6 +50,16 @@ "description": "Is this a FIFO queue?", "default": false }, + "deduplicationScope": { + "type": "string", + "description": "Specifies whether message deduplication occurs at the message group or queue level. Valid values are messageGroup and queue (default).", + "default": "queue" + }, + "fifoThroughputLimit": { + "type": "string", + "description": "Specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are perQueue (default) and perMessageGroupId.", + "default": "perQueue" + }, "deliveryDelay": { "type": "integer", "description": "The number of seconds to delay before a message sent to the queue can be received. Used to create a delay queue.",