diff --git a/menu/navigation.json b/menu/navigation.json index ff0ac4f441..424fef987d 100644 --- a/menu/navigation.json +++ b/menu/navigation.json @@ -4219,6 +4219,90 @@ "label": "NATS", "slug": "nats" }, + { + "items": [ + { + "label": "Overview", + "slug": "../queues" + }, + { + "label": "Concepts", + "slug": "concepts" + }, + { + "label": "Quickstart", + "slug": "quickstart" + }, + { + "label": "FAQ", + "slug": "faq" + }, + { + "items": [ + { + "label": "Create credentials", + "slug": "create-credentials" + }, + { + "label": "Manage credentials", + "slug": "manage-credentials" + }, + { + "label": "Create and manage queues", + "slug": "create-manage-queues" + }, + { + "label": "Monitor Queues with Cockpit", + "slug": "monitor-queues-cockpit" + } + ], + "label": "How to", + "slug": "how-to" + }, + { + "items": [ + { + "label": "Queues API Reference", + "slug": "https://www.scaleway.com/en/developers/api/messaging-and-queuing/sqs-api/" + }, + { + "label": "Connecting Queues to the AWS-CLI", + "slug": "connect-aws-cli" + }, + { + "label": "Using Queues with the AWS-CLI", + "slug": "queues-aws-cli" + }, + { + "label": "Using Go, Python or Node.js with Queues", + "slug": "python-node-queues" + } + ], + "label": "API/CLI", + "slug": "api-cli" + }, + { + "items": [ + { + "label": "Queues overview", + "slug": "queues-overview" + }, + { + "label": "Queues - supported actions", + "slug": "queues-support" + }, + { + "label": "Limitations", + "slug": "limitations" + } + ], + "label": "Additional Content", + "slug": "reference-content" + } + ], + "label": "Queues", + "slug": "queues" + }, { "items": [ { diff --git a/pages/nats/assets/scaleway-nats-create-account.webp b/pages/nats/assets/scaleway-nats-create-account.webp deleted file mode 100644 index 12653712c9..0000000000 Binary files a/pages/nats/assets/scaleway-nats-create-account.webp and /dev/null differ diff --git a/pages/nats/assets/scaleway-nats-creds.webp b/pages/nats/assets/scaleway-nats-creds.webp deleted file mode 100644 index eea32747f4..0000000000 Binary files a/pages/nats/assets/scaleway-nats-creds.webp and /dev/null differ diff --git a/pages/nats/assets/scaleway-nats-overview.webp b/pages/nats/assets/scaleway-nats-overview.webp deleted file mode 100644 index c2240019b0..0000000000 Binary files a/pages/nats/assets/scaleway-nats-overview.webp and /dev/null differ diff --git a/pages/nats/how-to/assets/scaleway-nats-create-account.webp b/pages/nats/how-to/assets/scaleway-nats-create-account.webp deleted file mode 100644 index 12653712c9..0000000000 Binary files a/pages/nats/how-to/assets/scaleway-nats-create-account.webp and /dev/null differ diff --git a/pages/nats/how-to/assets/scaleway-nats-creds.webp b/pages/nats/how-to/assets/scaleway-nats-creds.webp deleted file mode 100644 index eea32747f4..0000000000 Binary files a/pages/nats/how-to/assets/scaleway-nats-creds.webp and /dev/null differ diff --git a/pages/nats/how-to/assets/scaleway-nats-overview.webp b/pages/nats/how-to/assets/scaleway-nats-overview.webp deleted file mode 100644 index c2240019b0..0000000000 Binary files a/pages/nats/how-to/assets/scaleway-nats-overview.webp and /dev/null differ diff --git a/pages/queues/api-cli/connect-aws-cli.mdx b/pages/queues/api-cli/connect-aws-cli.mdx new file mode 100644 index 0000000000..251ca68d3e --- /dev/null +++ b/pages/queues/api-cli/connect-aws-cli.mdx @@ -0,0 +1,129 @@ +--- +meta: + title: Connecting Scaleway Queues to the AWS-CLI + description: This page explains how to connect Scaleway Queues to the AWS-CLI +content: + h1: Connecting Scaleway Queues to the AWS-CLI + paragraph: This page explains how to connect Scaleway Queues to the AWS-CLI +tags: messaging queues sqs aws-cli cli aws sdk python boto +categories: + - serverless +dates: + validation: 2025-04-02 + posted: 2025-04-02 +--- + +The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. With minimal configuration, you can start using the AWS-CLI with Scaleway Queues. This allows you to create, list and manage your queues, send messages and much more, all from your command line. + +This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Queues. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Valid [credentials](/queues/how-to/create-credentials/) for Scaleway Queues + + This page assumes you will use the AWS-CLI v1. + + +## How to install the AWS-CLI + +To interact with Scaleway Queues, both `aws-cli` and `awscli-plugin-endpoint` need to be installed. The `awscli-plugin-endpoint` is a useful plugin to help people more easily access third-party providers such as Scaleway. + +Install both `aws-cli` and `awscli-plugin` using `pip`. + +``` +pip3 install awscli +pip3 install awscli-plugin-endpoint +``` + +## How to configure the AWS-CLI + +Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Queues. + +1. Create a file named `~/.aws/config` by running the following command: + ``` + aws configure set plugins.endpoint awscli_plugin_endpoint + ``` + + + With the most recent versions of awscli (1.29.0 or 2.13.0), the use of a plugin is not necessary. If you are using one of those versions and wish to skip this step, you can do so. Note that this will also affect your configuration file in the next step. + + +2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the Queues (SQS) endpoint URL can be found in the console on the **Settings** page of the Queues product) + ``` + [plugins] + endpoint = awscli_plugin_endpoint + [profile sns] + region = fr-par + [profile sqs] + region = fr-par + sqs = + endpoint_url = https://sqs.mnq.fr-par.scaleway.com + ``` + + Optionally, you can also configure additional profiles by adding new blocks under `[sqs]`. For example, you can add a profile for `[sns]` if you are also using Scaleway Topics and Events, or another profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want: + + ``` + [plugins] + endpoint = awscli_plugin_endpoint + [profile sns] + region = fr-par + sns = + endpoint_url = https://sns.mnq.fr-par.scaleway.com + [profile sqs] + region = fr-par + sqs = + endpoint_url = https://sqs.mnq.fr-par.scaleway.com + [profile aws] + region=eu-west-3 + output=json + ``` + + + If you are using the AWS-CLI v2, you must include the path to the plugin in your configuration file. Add `cli_legacy_plugin_path = ` to the `[plugins]` section, replacing `` with the corresponding path. + + + + If you are using aws 1.29.0 or 2.13.0 without the plugin, your configuration file should be as follows: + ``` + [profile sqs] + region = fr-par + endpoint_url = https://sqs.mnq.fr-par.scaleway.com + ``` + + + +3. Generate a credentials file using the following command: + ``` + aws configure + ``` + +4. Open the `~/.aws/credentials` file you just created, and add the access key and secret key you saved when you generated your [credentials](/queues/how-to/create-credentials/): + ``` + [queues] + aws_access_key_id= + aws_secret_access_key= + ``` + + If you have other profiles, you can add a block to indicate their credentials too: + ``` + [topics_events] + aws_access_key_id= + aws_secret_access_key= + + [aws] + aws_access_key_id= + aws_secret_access_key= + ``` + +5. Test that everything is set up correctly with the following command: + ``` + aws queues list-queues + ``` + + Use the `--profile` option if you want to test it using a different profile. + + + Check out our dedicated documentation to find more common commands for getting started with the AWS CLI. The [Queues guide](/queues/api-cli/sqs-sns-aws-cli/#getting-started-with-scaleway-queues) walks you through creating and listing queues, sending messages to queues, and more. + diff --git a/pages/queues/api-cli/index.mdx b/pages/queues/api-cli/index.mdx new file mode 100644 index 0000000000..f81cd2808b --- /dev/null +++ b/pages/queues/api-cli/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Queues - API/CLI Documentation + description: Queues API/CLI Documentation +content: + h1: Queues - API/CLI Documentation + paragraph: Queues API/CLI Documentation +--- diff --git a/pages/queues/api-cli/python-node-queues.mdx b/pages/queues/api-cli/python-node-queues.mdx new file mode 100644 index 0000000000..5c016274f4 --- /dev/null +++ b/pages/queues/api-cli/python-node-queues.mdx @@ -0,0 +1,230 @@ +--- +meta: + title: Using Go, Python or Node.js with Scaleway Queues + description: This page explains how to use Go, Python or Node.js with Scaleway Queues and provides code samples +content: + h1: Using Go, Python or Node.js with Scaleway Queues + paragraph: This page explains how to use Go, Python or Node.js with Scaleway Queues and provides code samples +tags: messaging boto3 python nodejs sqs go +categories: + - messaging +dates: + validation: 2024-10-18 + posted: 2023-01-04 +--- + +AWS provides a number of SDKs (**S**oftware **D**evelopment **K**its) which provide language-specific APIs for AWS services, including [SQS](/queues/concepts#sqs), which is the protocol Scaleway Queues is based on. + +- AWS provides a dedicated [SDK for Go](https://aws.amazon.com/sdk-for-go/). +- The [AWS SDK for Python](https://aws.amazon.com/sdk-for-python/) is Boto3 +- For Node.js, use the [AWS SDK for JavaScript](https://aws.amazon.com/sdk-for-javascript/), which can be [installed from NPM](https://github.com/aws/aws-sdk-js-v3#getting-started) + +This guide provides code samples to show you how to start using these SDKs with Scaleway Queues. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Valid [credentials](/queues/how-to/create-credentials/) for Scaleway Queues +- Installed the relevant AWS SDK [for Go](https://aws.amazon.com/sdk-for-go/), [Python](https://aws.amazon.com/sdk-for-python/) and/or [JavaScript](https://aws.amazon.com/sdk-for-javascript/) + +## Go + +### Connect to Queues (Go) + +The following code sample shows how to connect to Scaleway Queues: + +```go +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/credentials" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/aws/aws-sdk-go/service/sqs" +) + +func main() { + awsSession := session.Must(session.NewSession(&aws.Config{ + Region: aws.String("fr-par"), + Endpoint: aws.String("http://sqs.mnq.fr-par.scaleway.com"), + Credentials: credentials.NewStaticCredentials(AwsAccessKey, AwsSecretKey, ""), + })) + + awsSqs := sqs.New(awsSession) + + [...] +} +``` + + + + The `Endpoint` for Scaleway Queues is `https://sqs.mnq.fr-par.scaleway.com`. For the access and secret key values, use the credentials you [generated](/queues/how-to/create-credentials/) for Queues. + + + +Once you are connected, you can use any functions available with the SDK. However, we recommend that you check they are [supported by Scaleway Queues](/queues/reference-content/sqs-support/). See the [official documentation](https://pkg.go.dev/github.com/aws/aws-sdk-go/service/sqs) for more details on using the SDK, or read on to see some examples. + +### Create queue (Go) + +```go +createQueueResponse, _ := awsSqs.CreateQueue(&sqs.CreateQueueInput{ + QueueName: aws.String("my-test-queue"), +}) +fmt.Println(*createQueueResponse.QueueUrl) +``` + +### Send messages to this queue (Go) + +```go +for i := 0; i < 10; i++ { + _, _ = awsSqs.SendMessage(&sqs.SendMessageInput{ + MessageBody: aws.String(fmt.Sprintf("Hello World: %d", i)), + QueueUrl: createQueueResponse.QueueUrl, + }) +} +``` + +### Receive messages from this queue (Go) + +```go +for { + receiveMessageResponse, err := awsSqs.ReceiveMessage(&sqs.ReceiveMessageInput{ + QueueUrl: createQueueResponse.QueueUrl, + }) + if err != nil || len(receiveMessageResponse.Messages) == 0 { + break + } + for _, m := range receiveMessageResponse.Messages { + fmt.Println(*m.Body) + } +} +``` + +## Python + +### Connect to Queues (Python) + +The following code sample shows how to connect to Scaleway Queues using Boto3's `resource()`. It is also possible to use `client()`, but `resource()` is more pythonesque: + +```python +sqs = boto3.resource('sqs', + endpoint_url=[], + aws_access_key_id=[], + aws_secret_access_key=[], + region_name='fr-par') +``` + + + The `endpoint_url` for Scaleway Queues is `https://sqs.mnq.fr-par.scaleway.com`. For the access and secret key values, use the credentials you [generated](/queues/how-to/create-credentials/) for Queues. + + +Once connected, you can use any functions available with the SDK - just check that they are [supported by Scaleway Queues](/queues/reference-content/sqs-support/). See the [official documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) for more details, or read on to see some examples. + +### Create queue (Python) + +```python +# Create the queue. This returns an SQS.Queue instance +queue = sqs.create_queue(QueueName='my test queue') + +# You can now access identifiers and attributes +print(queue.url) +print(queue.attributes) +``` + +### Send messages to this queue (Python) + +```python +for i in range (0,10): + queue.send_message(MessageBody="Hello World: "+str(i)) +``` + +### Receive messages from this queue (Python) + +```python +for message in queue.receive_messages(): + print(message.body) + message.delete() +``` + +## Node.js + +### Connect to Scaleway Queues (NodeJS) + +Here, we use the `@aws-sdk/client-sqs` module, which is the latest SDK available. +Import the required module: +```javascript +const { SQSClient, SendMessageCommand, CreateQueueCommand, ReceiveMessageCommand } = require("@aws-sdk/client-sqs"); +// If you use ES6 syntax +// import { SQSClient, SendMessageCommand, CreateQueueCommand, ReceiveMessageCommand } from "@aws-sdk/client-sqs"; +``` + +The following code sample shows how to connect to Scaleway Queues: + +```javascript +var sqsClient = new SQSClient({ + credentials: { + accessKeyId: SQS_ACCESS_KEY_ID, + secretAccessKey: SQS_ACCESS_KEY + }, + region: "par", + endpoint: SQS_ENDPOINT, +}) +``` + + + The `endpoint_url` for Scaleway Queues is `https://sqs.mnq.fr-par.scaleway.com`. For the access and secret key values, use the credentials you [generated](/queues/how-to/create-credentials/) for Scaleway Queues. + + +Once connected, you can use any of the SDK's functions as long as they are [supported by Scaleway Queues](/queues/reference-content/sqs-support/). Refer to AWS's [official documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html) for more information, or read on to see some examples. + +### Create queue (NodeJS) + +```javascript +const createQueueCommand = new CreateQueueCommand({ + QueueName: 'SQS_QUEUE_NAME', + Attributes: { + 'MessageRetentionPeriod': '86400' + } + }); + +const createQueue = await sqsClient.send(createQueueCommand); +console.log(createQueue.QueueUrl); +``` + +You can find all available parameters for createQueue in the AWS documentation [here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/SQS.html#createQueue-property). + +### Send messages to this queue (NodeJS) + +The following code sample demonstrates how to send a message with some `MessageAttributes`: + +```javascript +const sendMessageCommand = new SendMessageCommand({ + MessageAttributes: { + "Name": { + DataType: "String", + StringValue: "John" + }}, + MessageBody: "This is a test message to John", + QueueUrl: "SQS_QUEUE_URL" + }); + +const sendMessage = await sqsClient.send(sendMessageCommand) +console.log("Success", sendMessage.MessageId); +}); +``` + +### Receive messages from this queue (NodeJS) + +The following code sample shows how to read messages from a queue, and then delete them: + +```javascript +var queueURL= "SQS_QUEUE_URL"; + +const receiveMessageCommand = new ReceiveMessageCommand({ + MaxNumberOfMessages: 10, + QueueUrl: queueURL, + VisibilityTimeout: 20 +}); + +const receiveMessage = await sqsClient.send(receiveMessageCommand); +console.log(receiveMessage); +``` diff --git a/pages/queues/api-cli/queues-aws-cli.mdx b/pages/queues/api-cli/queues-aws-cli.mdx new file mode 100644 index 0000000000..2d7bdb15a8 --- /dev/null +++ b/pages/queues/api-cli/queues-aws-cli.mdx @@ -0,0 +1,68 @@ +--- +meta: + title: Using Scaleway Queues with the AWS-CLI + description: This page explains how to use Scaleway Queues with the AWS CLI +content: + h1: Using Scaleway Queues with the AWS-CLI + paragraph: This page explains how to use Scaleway Queues for creating queues and sending and receiving messages with the AWS CLI +tags: messaging sqs aws-cli cli aws queues messages +categories: + - messaging +dates: + validation: 2025-04-02 + posted: 2025-04-02 +--- + +The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. Once you have [connected Scaleway Queues to the AWS-CLI](/queues/api-cli/connect-aws-cli/), you can start creating, listing and managing your queues, sending messages and much more, all from your command line. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Valid [credentials](/queues/how-to/create-credentials/) for Queues +- [Connected Queues to the AWS-CLI](/queues/api-cli/connect-aws-cli/) +- [jq](https://stedolan.github.io/jq/download/) installed on your machine + +## Getting started with Scaleway Queues + +1. Use the following command to create a queue: + + ```sh + aws sqs create-queue --queue-name MyQueue | tee my-queue.json + ``` + +2. Use the following command to list existing queues: + + ```sh + aws sqs list-queues + ``` + +3. Use the following command to send messages to a queue: + + ```sh + aws sqs send-message --queue-url $(jq -r .QueueUrl my-queue.json) --message-body "Hello world!" + + aws sqs send-message --queue-url $(jq -r .QueueUrl my-queue.json) --message-body "Second Message." + ``` + +4. Use the following command to receive messages: + + ```sh + aws sqs receive-message --queue-url $(jq -r .QueueUrl my-queue.json) | tee message1.json + + aws sqs receive-message --queue-url $(jq -r .QueueUrl my-queue.json) | tee message2.json + ``` + +5. Use the following command to delete messages. This is necessary as once a message has been processed on your consumer side (typically by a worker), it will be re-queued unless it is explicitly deleted. + + ```sh + aws sqs delete-message --queue-url $(jq -r .QueueUrl my-queue.json) --receipt-handle $(jq -r .Messages[0].ReceiptHandle message1.json) + + aws sqs delete-message --queue-url $(jq -r .QueueUrl my-queue.json) --receipt-handle $(jq -r .Messages[0].ReceiptHandle message2.json) + ``` + +6. Use the following command to delete the queue itself: + + ```sh + aws sqs delete-queue --queue-url $(jq -r .QueueUrl my-queue.json) + ``` \ No newline at end of file diff --git a/pages/queues/concepts.mdx b/pages/queues/concepts.mdx new file mode 100644 index 0000000000..7a114025c8 --- /dev/null +++ b/pages/queues/concepts.mdx @@ -0,0 +1,84 @@ +--- +meta: + title: Queues - Concepts + description: Understand the core concepts of Scaleway Queues. Explore fundamental principles for efficient message handling and service optimization. +content: + h1: Queues - Concepts + paragraph: Understand the core concepts of Scaleway Queues. Explore fundamental principles for efficient message handling and service optimization. +categories: + - +tags: messaging queuing concepts queues +dates: + validation: 2025-04-02 + posted: 2025-04-02 +--- + +## Content-based deduplication + +Content-based deduplication is a setting available for [FIFO](#fifo) queues. Enable content-based deduplication if the message body is guaranteed to be unique for each message. A unique hash value is generated from the body of each message, which is used as its deduplication ID. This avoids the need to set a deduplication ID when sending messages. Read more in our dedicated documentation on [creating queues](/queues/how-to/create-manage-queues/). + +## Credentials + +Credentials give services and platforms access to Scaleway Queues, enabling them to connect to the host system. Credentials for Scaleway Queues define whether the bearer is allowed to write, and/or read, and/or manage queues. Refer to our [credentials documentation](/queues/how-to/create-credentials/) for more information. + +## Dead-letter queue + +A **D**ead-**l**etter **q**ueue (DLQ), or **undelivered-message queue**, receives and holds messages that cannot be delivered to their destination queues. A DLQ must be of the same type (FIFO or Standard), in the same Project and in the same region as the queue(s) it serves. Each DLQ also has an associated parameter: [maximum receive count](#maximum-receive-count). A single queue can serve as dead-letter queue to multiple source queues. + +If you designate a queue as a DLQ and its [storage quota](/organizations-and-projects/additional-content/organization-quotas/#queues) is reached, messages will not be re-driven to the DLQ until enough free space is available again. If your DLQ is at its full quota, free up space by receiving and deleting messages from any queue in your Project. + +## FIFO + +FIFO stands for **F**irst **I**n **F**irst **O**ut, and represents a type of queue where the exact order of messages is preserved, and duplicate messages are not tolerated. As well as these specificities, FIFO queues support all the same features as the [Standard](#standard) queue type. Consider using FIFO queues for any use cases where the order of messages is critical, such as e-commerce order management systems, systems where one action should not happen until another has been completed, or first-come-first-served ticketing systems. + +## Message broker + +A message broker is a piece of software that allows applications, systems and services to communicate with each other and send/receive data. It facilitates the exchange of information by receiving messages from a producer, and transmitting them to a consumer. Scaleway Queues is a message broker tool based on the AWS SQS messaging system. + +## Maximum receive count + +The maximum receive count is a setting that can be configured for a [dead-letter queue](#dead-letter-queue). It defines how many times a message can be received by consumers from the source queue before being moved to the dead-letter queue. This value must be between 1 and 1,000. + +## Message retention period + +The message retention period is a setting that can be configured for a queue. It represents the length of time (in seconds) that messages are kept in the queue before being deleted. Setting a longer message retention period allows for a longer interval between a message being sent and it being received. Read more in our dedicated documentation on [creating queues](/queues/how-to/create-manage-queues/). + +## Messaging and Queuing + +Previously, Scaleway Messaging and Queuing was a single product that grouped together three different messaging protocols. It has now been split into three distinct products: [NATS](/nats/), [Queues](#queues), and [Topics and Events](/topics-and-events/). + +## Queue + +Creating a queue with [Scaleway Queues](#scaleway-queues) facilitates asynchronous communication between different microservices, applications, and platforms. You can create a queue, configure its delivery and message parameters, and then start sending messages to it. Messages are stored in the queue until they are processed and delivered, and deleted once consumed. [Read more about creating and configuring queues](/queues/how-to/create-manage-queues/), or check our [tutorial on creating a serverless scraping architecture using a queue](/tutorials/create-serverless-scraping/) to get an idea of what you can do with message queues. + +## Queue types + +When creating queues with Scaleway Queues, two queue types are available. [Standard](#standard) queues provide at-least-once delivery, while [FIFO](#fifo) queues offer first-in-first-out delivery, and (unlike Standard queues) guarantee that messages are delivered in order and without duplication. [Content-based deduplication](#content-based-deduplication) is only available for FIFO queue types. Find out more about creating queues with our [dedicated documentation](/queues/how-to/create-manage-queues/). + +## Queuing + +The message queuing model used by Scaleway Queues. It provides a pattern or framework for sending messages, which contrasts with the publish/subscribe model used by NATS and Topics and Events. Queuing is a form of asynchronous service-to-service communication. Whereas with the publish/subscribe model multiple subscribers can receive each message, with the queuing model, messages have just one destination. Messages are stored in the queue until they are processed and delivered, and they are deleted once consumed. This model is used in serverless and microservices architectures. + +## Queue volume + +Queue volume is one of the factors affecting the billing of Scaleway Queues. Queue volume is calculated as the number of messages in a queue, multiplied by the message size. Or, the sum of the size of all messages in a queue. + +## Region + +Scaleway Queues is available in multiple regions. A region designates the geographical area where the service is hosted. Refer to the [product availability table](/account/reference-content/products-availability/) to check which regions are available. + +## Scaleway Queues + +Scaleway Queues is a product for creating managed messaging queues based on AWS's [SQS](#sqs) protocol. It allows you to implement your messaging queues without the hassle of managing the infrastructure, scaling or updates. + +## SQS + +The Scaleway Queues product is based on the AWS SQS protocol. **S**imple **Q**ueue **S**ervice, or SQS, is a distributed message [queuing](#queuing) service that supports programmatic sending of messages via web service applications. + +## Standard + +Standard-type queues and topics represent the default queue/topic type, and offer an at-least-once message delivery system. Unlike [FIFO](#fifo) queues and topics, standard queues provide only best-effort attempts to deliver messages in order. At-least-once delivery means that it is possible under rare circumstances that the same message may be received more than once. + +## Visibility timeout + +Visibility timeout is a setting that can be configured for a Scaleway queue. It represents the length of time (in seconds) during which, after a message is received, the queue hides it, so it cannot be received again by the same or other consumers. This is useful as the queue itself does not automatically delete messages once they are received, and so prevents consumers from receiving the same message many times before they have finished processing it. Read more in our dedicated documentation on [creating queues](/queues/how-to/create-manage-queues/). diff --git a/pages/queues/faq.mdx b/pages/queues/faq.mdx new file mode 100644 index 0000000000..0a8ec8ec05 --- /dev/null +++ b/pages/queues/faq.mdx @@ -0,0 +1,30 @@ +--- +meta: + title: Queues FAQ + description: Discover Scaleway Queues, and get answers to common questions about the capabilities of the product, how to manage your queues, billing and more. +content: + h1: Queues FAQ + paragraph: Discover Scaleway Queues, and get answers to common questions about the capabilities of the product, how to manage your queues, billing and more. +dates: + validation: 2025-04-02 + posted: 2025-04-02 +categories: + - serverless +productIcon: SqsProductIcon +--- + +## What is Scaleway Queues? + +Scaleway Queues is a product for creating managed message queues based on AWS's SQS protocol. It allows you to implement your message queues without the hassle of managing the infrastructure, scaling or updates. Message queues are ideal for facilitating asynchronous job processing and communication between microservices. + +## What is SQS? + +**S**imple **Q**ueue **S**ervice, or SQS, is AWS's distributed message [queuing](#queuing) protocol, that supports programmatic sending of messages via web service applications. + +## Is the Scaleway Queues gateway compatible with my application, framework or tool? + +We currently implement the API endpoints listed [here](/queues/reference-content/sqs-support/), which makes Scaleway Queues compatible with the AWS SDK as well as many other tools and frameworks including [KEDA](https://keda.sh/) and [Symfony](https://symfony.com/). Note that you need to specify both Regions and URL to ensure compatibility. + +## How is Scaleway Queues billed? + +Billing is based on [queue volume](/queues/concepts/#queue-volume) - the combined size of the messages travelling through queues. For full pricing details, see our [dedicated pricing page](https://www.scaleway.com/en/pricing/). \ No newline at end of file diff --git a/pages/queues/how-to/create-credentials.mdx b/pages/queues/how-to/create-credentials.mdx new file mode 100644 index 0000000000..c012078bc7 --- /dev/null +++ b/pages/queues/how-to/create-credentials.mdx @@ -0,0 +1,49 @@ +--- +meta: + title: How to create credentials for Scaleway Queues + description: Learn how to create credentials for Scaleway Queues. Securely manage access and ensure seamless integration with this step-by-step guide. +content: + h1: How to create credentials for Scaleway Queues + paragraph: Learn how to create credentials for Scaleway Queues. Securely manage access and ensure seamless integration with this step-by-step guide. +tags: credentials queues messaging queuing key token +categories: + - serverless +dates: + validation: 2025-04-02 + posted: 2025-04-02 +--- + +This page shows how to create [credentials](/queues/concepts/#credentials) for Scaleway Queues. Credentials give their bearer (e.g. services and platforms) access to your messaging queue service. + +You can create multiple sets of credentials for Scaleway Queues. Credentials for Queues are granular: you can define the level of access that they should give. Credentials give the specified level of access to all queues that you create in the [region](/queues/concepts/#region) they are scoped to. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. A list of your queues displays. + +2. Click the **Credentials** tab. + +3. Click **Generate credentials**. A pop-up displays: + + + +4. Choose a region that these credentials should be scoped to. + +5. Enter a name for these credentials. + +6. Select the required permissions for the credentials. You must choose at least one of **Write**, **Read** and **Manage**. You are free to select any combination of these permissions. + +7. Click **Generate credentials**. + + The credentials are created. The access key and secret key are displayed, and you are invited to copy them. + + + This is your only chance to view and save the secret key. Make sure that you copy it and save it somewhere securely. + + +8. Copy and save the credentials, before closing the window. + + You are returned to the **Credentials** tab. The name of your newly-generated credentials, along with the access key and access level are displayed. \ No newline at end of file diff --git a/pages/queues/how-to/create-manage-queues.mdx b/pages/queues/how-to/create-manage-queues.mdx new file mode 100644 index 0000000000..6344c6d39d --- /dev/null +++ b/pages/queues/how-to/create-manage-queues.mdx @@ -0,0 +1,102 @@ +--- +meta: + title: How to create and manage queues + description: Learn to create and manage queues with Scaleway Queues. This guide helps you efficiently handle messaging queues for seamless operations. +content: + h1: How to create and manage queues + paragraph: Learn to create and manage queues with Scaleway Queues. This guide helps you efficiently handle messaging queues for seamless operations. +tags: messaging queuing queues sqs +categories: + - serverless +dates: + validation: 2025-04-02 + posted: 2022-08-11 +--- + +This page shows how to create and manage your queues with [Scaleway Queues](/queues/concepts/#queue) (formerly part of the **Messaging and Queuing** product). + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization + +## How to create a queue + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Click **Create queue**. The queue creation wizard displays. + + + +3. Select the [region](/queues/concepts/#region) in which you want to create the queue. + +4. Enter a **name** for your queue. The name must be no more than 80 characters, and consist only of alphanumeric characters, hyphens, and underscores. Alternatively, you can go with the auto-generated name suggested for you. + +5. Choose your **Queue type**, from one of the following: + - **Standard**: Standard Queues ensure at-least-once delivery. The exact order of messages in the queue is not preserved. + - **FIFO**: FIFO Queues (**F**irst **In** **F**irst **O**ut) preserves the exact ordering of messages. + +6. Configure your queue's **parameters**. The following parameters can be defined: + - **Visibility timeout**: The length of time (in seconds) during which, after a message is received, it is hidden and cannot be received again by the same or other consumers. This is useful as the queue itself does not automatically delete messages once they are received, and so prevents consumers from receiving the same message many times before they have finished processing it. Therefore, the value set here should be informed by the expected length of time it will take consumers to process messages. The default value is 30 seconds. The value must be between 1 second and 43 200 seconds (12 hours). + - **Message retention period**: The length of time (in seconds) that messages are kept in the queue before being deleted. Setting a longer message retention period allows for a longer interval between a message being sent and it being received. The default value is 60 seconds. The value must be between 60 seconds and 1 290 600 seconds (14 days). + - **Maximum message size**: The maximum size (in kilobytes) of a message that can be sent to the queue. Messages greater than the defined size will be rejected. The default value is 256 KB. The value must be between 1 KB and 256 KB. + - **Content Based Deduplication**: This setting is only available for FIFO queues. Enable content-based deduplication if the message body is guaranteed to be unique for each message. A unique hash value is generated from the body of each message, which is used as its deduplication ID. This avoids the need to set a deduplication ID when sending messages. + - **Dead-letter queue**: Designate another queue to [receive undelivered messages](/queues/concepts/#dead-letter-queue) from this queue. If you select this option, you are prompted to select an existing queue as dead-letter queue. This queue must be of the same type, in the same Project and in the same region as the queue you are creating. You must also enter a value for the **maximum receive count**: how many times a message can be received by consumers from the source queue before being moved to the dead-letter queue. + +7. Click **Create queue** to finish. + +You are returned to the **Queues** tab, where your newly-created queue now displays. The queue's URL is also displayed here, for use in your API/CLI operations. + +Go further by clicking on the queue's name to access its **Settings** page and see additional information such as its ARN (Amazon Resource Name) and configuration parameters. + + +Remember that you need to [create credentials](/queues/how-to/create-credentials/) in order to access your queues from an API or CLI. Sending messages to queues requires that credentials have the `can_publish` permission, while receiving messages from queues requires the `can_receive` permission. You can create separate credentials if you need to isolate these two roles in your application. + + +## How to modify a queue's configuration + +You can modify the visibility timeout, message retention period and maximum message size of a queue after creation. You can also modify the content based deduplication settings for FIFO queues. However, you cannot change a queue's name or type after creation. + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Use the drop-down menu to select the [region](/queues/concepts/#region) of the queue you want to modify. + +3. Click the queue you wish to modify. The queue's **Settings** page displays: + + + +4. Modify the visibility timeout, message retention period, maximum message size, dead-letter queue settings, and (for FIFO queues) content-based deduplication values as you wish. + +5. Click **Save**. + +## How to purge a queue of messages + +You can use the **Purge** feature to delete all messages from a queue. + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Use the drop-down menu to select the [region](/queues/concepts/#region) of the queue you want to configure. + +3. Either: + - Click the queue you wish to purge. The queue's **Settings** page displays. Click the **Purge** button in the top right corner. + - Click the icon next to the queue you wish to purge, then select **Purge** from the menu that displays. + + A pop-up asks you to confirm that you understand this action will delete all your queued messages. + +4. Type **PURGE** and click **Purge queue**. + +## How to delete a queue + +When you no longer want a queue, you can delete it. This action is irreversible and deletes the queue along with any queued messages. + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Use the drop-down menu to select the [region](/queues/concepts/#region) of the queue you want to configure. + +3. Either: + - Click the queue you wish to delete. The queue's **Settings** page displays. Click the **Delete queue** button in the bottom right corner. + - Click the icon next to the queue you wish to delete, then select **Delete** from the menu that displays. + + A pop-up asks you to confirm that you understand this action will delete the queue and all your queued messages. + +4. Type **DELETE** and click **Delete queue**. \ No newline at end of file diff --git a/pages/queues/how-to/index.mdx b/pages/queues/how-to/index.mdx new file mode 100644 index 0000000000..3a24970e46 --- /dev/null +++ b/pages/queues/how-to/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Queues - How Tos + description: Queues How Tos +content: + h1: Queues - How Tos + paragraph: Queues How Tos +--- diff --git a/pages/queues/how-to/manage-credentials.mdx b/pages/queues/how-to/manage-credentials.mdx new file mode 100644 index 0000000000..6e2a01d84a --- /dev/null +++ b/pages/queues/how-to/manage-credentials.mdx @@ -0,0 +1,58 @@ +--- +meta: + title: How to manage credentials for Scaleway Queues + description: Master managing credentials for Scaleway Queues. Follow this guide to securely update, rotate, and control access to your messaging services. +content: + h1: How to manage credentials for Scaleway Queues + paragraph: Master managing credentials for Scaleway Queues. Follow this guide to securely update, rotate, and control access to your messaging services. +dates: + validation: 2025-04-03 + posted: 2025-04-03 +tags: manage credentials messaging queuing permissions update revoke +categories: + - serverless +--- + +Credentials give their bearer (e.g. services and platforms) access to your Queues service. + +This page shows how to manage [credentials](/queues/concepts/#credentials) for Scaleway Queues. Credentials can be updated to change their permissions, or revoked entirely. Once credentials are revoked, any user trying to use the credentials to connect to the service will be denied. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization +- Valid [credentials](/queues/how-to/create-credentials/) + +## How to update Queues credentials + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Click the **Credentials** tab. + +3. Use the drop-down menu to select the [region](/queues/concepts/#region) containing the credentials you want to update. + +4. Click the button next to the credentials you want to update, and select **Update credentials**. A pop-up displays, such as the one below for Queues: + + + +5. Make the required updates to your credentials. You can modify the name, and the permissions. + +6. Click **Update credentials**. + + The credentials are updated and you are returned to the product's **Credentials** listing. + +## How to revoke Queues credentials + +1. Click **Queues**in the **Serverless** section of the Scaleway console side menu. + +2. Click the **Credentials** tab. + +3. Use the drop-down menu to select the [region](/queues/concepts/#region) containing the credentials you want to revoke. + +4. Click the button next to the credentials you want to revoke and select **Revoke**. + + A pop-up displays, warning you that this action is irreversible and the key will no longer be able to access your service. + +5. Click **Revoke credentials**. + + The credentials are revoked and you are returned to the product's **Credentials** listing. \ No newline at end of file diff --git a/pages/queues/how-to/monitor-queues-cockpit.mdx b/pages/queues/how-to/monitor-queues-cockpit.mdx new file mode 100644 index 0000000000..0b42611856 --- /dev/null +++ b/pages/queues/how-to/monitor-queues-cockpit.mdx @@ -0,0 +1,42 @@ +--- +meta: + title: How to monitor Queues with Scaleway Cockpit + description: Monitor your Queues services with Scaleway Cockpit. This guide helps you track performance to manage your messaging services efficiently. +content: + h1: How to monitor Queues with Scaleway Cockpit + paragraph: Monitor your Queues services with Scaleway Cockpit. This guide helps you track performance to manage your messaging services efficiently. +tags: messaging queuing queues cockpit metrics observability +categories: + - serverless +dates: + validation: 2025-04-03 + posted: 2025-04-03 +--- + +You can view metrics for your Queues services via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your queues and messages at a glance. There are two steps to complete to view your metrics for the first time with Cockpit: + +1. Generate your Grafana credentials +2. Access the product's metrics dashboard + +These steps are described below. + + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization + +## How to generate Grafana credentials + +To view your metrics with Cockpit, you will use a Grafana dashboard which is accessible from the Scaleway console. First, you must create a user and their associated credentials (a username and password) for Grafana. This can be done directly from the Scaleway console, [by following this procedure](/cockpit/how-to/retrieve-grafana-credentials/). + +## How to access your Queues dashboard and view your metrics + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Click the **Metrics** tab. + +3. Click **Open Grafana metrics dashboard**. + +4. Enter your Grafana username and password to log in. + + You are directed to the Queues dashboard, where you can view all your metrics. \ No newline at end of file diff --git a/pages/queues/index.mdx b/pages/queues/index.mdx new file mode 100644 index 0000000000..e33c4d05ff --- /dev/null +++ b/pages/queues/index.mdx @@ -0,0 +1,73 @@ +--- +meta: + title: Queues Documentation + description: Explore Scaleway Queues. Simplify your microservice workflows with scalable, reliable, and cost-effective message handling solutions. +--- + + + +## Getting Started + + + + + + + + + +## Tutorials + + + + + + + + +## Changelog + + \ No newline at end of file diff --git a/pages/queues/quickstart.mdx b/pages/queues/quickstart.mdx new file mode 100644 index 0000000000..04ac7b32e3 --- /dev/null +++ b/pages/queues/quickstart.mdx @@ -0,0 +1,97 @@ +--- +meta: + title: Queues - Quickstart + description: Get started with Scaleway Queues. This quickstart guide helps you easily set up and manage scalable messaging solutions in minutes. +content: + h1: Queues - Quickstart + paragraph: Get started with Scaleway Queues. This quickstart guide helps you easily set up and manage scalable messaging solutions in minutes. +dates: + validation: 2025-04-01 + posted: 2025-04-01 +tags: messaging queuing queueing quickstart messaging-and-queuing sqs message-broker queues +categories: + - serverless +--- + +Scaleway Queues is a managed message broker service that allows you to transfer messages between different microservices and platforms via queues. This enables decoupled applications to "talk" to each other effectively even if they are not otherwise compatible. Scaleway Queues enables and simplifies microservices application development and allows you to build highly scalable, reliable, distributed applications. + + +- A Scaleway account logged into the [console](https://console.scaleway.com) +- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization + +## How to create credentials for Queues + +Credentials for Queues are granular: you can define the level of access that they should give. Credentials give the specified level of access to all queues that you create in the region they are scoped to. + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. A list of your queues displays. + +2. Click the **Credentials** tab. + +3. Click **Generate credentials**. A pop-up displays: + + + +4. Choose a region that these credentials should be scoped to. + +5. Enter a name for these credentials. + +6. Select the required permissions for the credentials. You must choose at least one of **Write**, **Read** and **Manage**. You are free to select any combination of these permissions. + +7. Click **Generate credentials**. + + The credentials are created. The access key and secret key are displayed, and you are invited to copy them. + + + This is your only chance to view and save the secret key. Make sure that you copy it and save it somewhere securely. + + +8. Copy and save the credentials, before closing the window. + + You are returned to the **Credentials** tab. The name of your newly-generated credentials, along with the access key and access level are displayed. + +## How to create queues + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Click **Create queue**. The queue creation wizard displays. + + + +3. Select the [region](/queues/concepts/#region) in which you want to create the queue. + +4. Enter a **name** for your queue. The name must be no more than 80 characters, and consist only of alphanumeric characters, hyphens, and underscores. Alternatively, you can go with the auto-generated name suggested for you. + +5. Choose your **Queue type**, from one of the following: + - **Standard**: Standard Queues ensure at-least-once delivery. The exact order of messages in the queue is not preserved. + - **FIFO**: FIFO Queues (**F**irst **In** **F**irst **O**ut) preserves the exact ordering of messages. + +6. Configure your queue's **parameters**. The following parameters can be defined: + - **Visibility timeout**: The length of time (in seconds) during which, after a message is received, it is hidden and cannot be received again by the same or other consumers. This is useful as the queue itself does not automatically delete messages once they are received, and so prevents consumers from receiving the same message many times before they have finished processing it. Therefore, the value set here should be informed by the expected length of time it will take consumers to process messages. The default value is 30 seconds. The value must be between 1 second and 43 200 seconds (12 hours). + - **Message retention period**: The length of time (in seconds) that messages are kept in the queue before being deleted. Setting a longer message retention period allows for a longer interval between a message being sent and it being received. The default value is 60 seconds. The value must be between 60 seconds and 1 209 600 seconds (14 days). + - **Maximum message size**: The maximum size (in kilobytes) of a message that can be sent to the queue. Messages greater than the defined size will be rejected. The default value is 256 KB. The value must be between 1 KB and 256 KB. + - **Content Based Deduplication**: This setting is only available for FIFO queues. Enable content-based deduplication if the message body is guaranteed to be unique for each message. A unique hash value is generated from the body of each message, which is used as its deduplication ID. This avoids the need to set a deduplication ID when sending messages. + - **Dead-letter queue**: Designate another queue to receive undelivered messages from this queue. If you select this option, you are prompted to select an existing queue as dead-letter queue. This queue must be of the same type, in the same Project and in the same region as the queue you are creating. You must also enter a value for the **maximum receive count** (how many times a message can be received from the source queue before being moved to the dead-letter queue). + +7. Click **Create queue** to finish. + +You are returned to the **Queues** tab, where your newly-created queue now displays. The queue's URL is also displayed here, for use in your API/CLI operations. + +## How to send and receive messages + +All further actions related to sending messages to queues can be done via a supported CLI or SDK. See our documentation on the [SQS CLI and SDKs](/queues/reference-content/sqs-overview#further-actions) for more information. You can also check out [our tutorial](/tutorials/create-serverless-scraping/) on creating a serverless scraping architecture with Scaleway Queues. + +## How to delete a queue + +When you no longer want a queue, you can delete it. This action is irreversible and deletes the queue along with any queued messages. + +1. Click **Queues** in the **Serverless** section of the Scaleway console side menu. + +2. Use the drop-down menu to select the [region](/queues/concepts/#region) of the queue you want to configure. + +3. Either: + - Click the queue you wish to delete. The queue's **Settings** page displays. Click the **Delete queue** button in the bottom right corner. + - Click the icon next to the queue you wish to delete, then select **Delete** from the menu that displays. + + A pop-up asks you to confirm that you understand this action will delete the queue and all your queued messages. + +4. Type **DELETE** and click **Delete queue**. \ No newline at end of file diff --git a/pages/queues/reference-content/index.mdx b/pages/queues/reference-content/index.mdx new file mode 100644 index 0000000000..005f2eb239 --- /dev/null +++ b/pages/queues/reference-content/index.mdx @@ -0,0 +1,8 @@ +--- +meta: + title: Queues - Additional content + description: Queues additional content +content: + h1: Queues - Additional content + paragraph: Queues additional content +--- diff --git a/pages/queues/reference-content/limitations.mdx b/pages/queues/reference-content/limitations.mdx new file mode 100644 index 0000000000..f4808c382f --- /dev/null +++ b/pages/queues/reference-content/limitations.mdx @@ -0,0 +1,22 @@ +--- +meta: + title: Queues Limitations + description: Learn about the current limitations of Scaleway Queues +content: + h1: Queues Limitations + paragraph: Learn about the current limitations of Scaleway Queues +tags: messaging limitations space size storage payload max-streams max-consumers max-subscribers max-topics max-queues visibility-timeout +dates: + validation: 2025-04-02 + posted: 2025-04-02 +categories: + - serverless +--- + +## Usage limits + +For the usage limits that apply when using Scaleway Queues, see the dedicated sections on our [Organization quotas](/organizations-and-projects/additional-content/organization-quotas/) page. Limits (quotas) apply to, for example, the maximum number of queues and consumers/subscribers, as well as to message retention duration and storage. + +## VPC + +Queues is not currently compatible with [Scaleway VPC](/vpc/quickstart/). diff --git a/pages/queues/reference-content/queues-overview.mdx b/pages/queues/reference-content/queues-overview.mdx new file mode 100644 index 0000000000..47aaea736c --- /dev/null +++ b/pages/queues/reference-content/queues-overview.mdx @@ -0,0 +1,57 @@ +--- +meta: + title: Scaleway Queues Overview + description: Learn about the Scaleway Queues messaging system +content: + h1: Scaleway Queues Overview + paragraph: Learn about the Scaleway Queues messaging system +tags: messaging sqs aws queuing publish-subscribe message-queue +categories: + - serverless +dates: + validation: 2024-10-18 + posted: 2023-01-04 +--- + +## What is Scaleway Queues? + +Scaleway Queues is a managed message queuing service that enables decoupling of components within distributed applications. It allows applications to send, queue, store and receive messages between each other asynchronously. Scaleway Queues leverages the SQS protocol. + +## What is SQS? + +SQS is a managed messaging service developed by AWS and leveraged by Scaleway Queues. + +SQS (Simple Queue Service) became generally available in 2006. It is a highly scalable [queuing](/queues/concepts#queuing) service that facilitates the decoupling of software systems. Scaleway Queues provides a gateway that enables you to connect your existing applications without having to significantly modify your code baseline. + + + Some SQS features are not yet supported. Refer to our [dedicated documentation page](/queues/reference-content/sqs-support/) for more information. + + +## Credentials + +You must [create credentials](/queues/how-to/create-credentials/) to give your applications permission to connect to the Scaleway Queues service. + +Credentials are scoped to your Scaleway Queues service at [Project](/organizations-and-projects/concepts/#project)-level. You can choose to give each set of credentials the required level of permissions: + + - **Read**: receive messages from queues and topics. + - **Write**: send messages to queues and publish in topics. + - **Manage**: create or edit resources (such as queues and topics). + +## Creating queues + +You can [create queues](/queues/how-to/create-manage-queues/) via the Scaleway console. You can choose to create either a Standard or FIFO queue, and tweak parameters such as visibility timeout, message retention period, maximum message size and content based deduplication. + +## Further actions + +All further actions such as sending messages can be done using the AWS CLI or AWS SDKs. Check out our documentation to help you get started with the [AWS CLI](/queues/api-cli/connect-aws-cli/) or [AWS SDKs](/queues/api-cli/python-node-sqs/). + +## Queues resources + +The following resources may be helpful: + + - [How to create a serverless scraping architecture, with Scaleway Queues, Serverless Functions and Managed Databases](/tutorials/create-serverless-scraping/) + - [Official SQS Documentation](https://docs.aws.amazon.com/sqs/index.html) + - Further information on supported API features: + - [SQS](/queues/reference-content/queues-support/) + - [Official AWS CLI Documentation](https://aws.amazon.com/cli/) + - [Official AWS SDK Documentation](https://aws.amazon.com/developer/tools/) \ No newline at end of file diff --git a/pages/queues/reference-content/queues-support.mdx b/pages/queues/reference-content/queues-support.mdx new file mode 100644 index 0000000000..c7f310df70 --- /dev/null +++ b/pages/queues/reference-content/queues-support.mdx @@ -0,0 +1,291 @@ +--- +meta: + title: Scaleway Queues - Supported Actions + description: Discover which SQS AWS API actions are supported by Scaleway Queues +content: + h1: Scaleway Queues - Supported Actions + paragraph: Discover which SQS AWS API actions are supported by Scaleway Queues +tags: messaging supported actions sqs aws api +categories: + - serverless +dates: + validation: 2024-10-18 + posted: 2023-01-04 +--- + +This page lists all actions described in the AWS SQS documentation, and states whether they are supported by Scaleway Queues. + +- **Y** means the parameter is fully supported +- **N** means the parameter is not supported +- **P** means the parameter is partially supported (see associated comments for more details) + +## CreateQueue + +CreateQueue requires the `CanManage` permission. + +### CreateQueue Request + +| Parameters | Support | Comments | +|:----------------|:---------:|:--------------------------------------------------------------------------------------------------| +| Attribute (map) | **P** | See supported attributes in the [SQS Queue Attributes](#sqs-api-support-queue-attributes) section | +| QueueName | **Y** | See AWS documentation for naming conventions (FIFO queues are supported) | +| Tag | **N** | | + +### CreateQueue Response + +| Elements | Support | Comments | +|:-----------|:---------:|:-----------| +| QueueUrl | **Y** | | + +## ReceiveMessage + +ReceiveMessage requires the `CanReceive` permission. + +### ReceiveMessage Request + +| Parameters | Support | Comments | +|:------------------------|:---------:|:------------------------------------------------------------------------------------------------------| +| AttributeName.N (array) | **P** | See supported attributes in the [SQS Message Attributes](#sqs-api-support-message-attributes) section | +| MaxNumberOfMessages | **Y** | | +| MessageAttributeName.N | **Y** | | +| QueueUrl | **Y** | | +| ReceiveRequestAttemptId | **N** | | +| VisibilityTimeout | **N** | | +| WaitTimeSeconds | **Y** | | + +### ReceiveMessage Response + +| Elements | Support | Comments | +|:---------------------------------|:---------:|:------------------------------------------------------------------------------------------------------| +| Message.N.Attribute | **P** | See supported attributes in the [SQS Message Attributes](#sqs-api-support-message-attributes) section | +| Message.N.Body | **Y** | | +| Message.N.MD5OfBody | **Y** | | +| Message.N.MD5OfMessageAttributes | **Y** | | +| Message.N.MessageAttribute | **Y** | | +| Message.N.MessageId | **Y** | | +| Message.N.ReceiptHandle | **Y** | | + +## SendMessage + +SendMessage requires the `CanPublish` permission. + +### SendMessage Request + +| Parameters | Support | Comments | +|:-----------------------|:---------:|:-----------| +| DelaySeconds | **N** | | +| MessageAttribute (map) | **Y** | | +| MessageBody | **Y** | | +| MessageDeduplicationId | **Y** | | +| MessageGroupId | **N** | | +| MessageSystemAttribute | **N** | | +| QueueUrl | **Y** | | + +### SendMessage Response + +| Elements | Support | Comments | +|:-----------------------------|:---------:|:-----------| +| MD5OfMessageAttributes | **Y** | | +| MD5OfMessageBody | **Y** | | +| MD5OfMessageSystemAttributes | **N** | | +| MessageId | **Y** | | +| SequenceNumber | **Y** | | + +## SendMessageBatch + +SendMessageBatch requires the `CanPublish` permission. + +### SendMessageBatch Request + +| Parameters | Support | Comments | +|:---------------------------------------|:---------:|:-------------------------------------------------------------------------------------------------------------------------| +| QueueUrl | **Y** | | +| SendMessageBatchRequestEntry.N (array) | **P** | As with the SendMessage action, the DelaySeconds, MessageGroupId and MessageSystemAttribute parameters are not supported | + +### SendMessageBatch Response + +| Elements | Support | Comments | +|:--------------------------------------|:---------:|:-------------------------------------------------------------| +| BatchResultErrorEntry.N (array) | **Y** | | +| SendMessageBatchResultEntry.N (array) | **P** | All fields are supported except MD5OfMessageSystemAttributes | + +## ListQueues + +ListQueues requires the `CanManage` permission. + +### ListQueues Request + +| Parameters | Support | Comments | +|:----------------|:---------:|:-----------| +| MaxResults | **N** | | +| NextToken | **N** | | +| QueueNamePrefix | **Y** | | + +### ListQueues Response + +| Elements | Support | Comments | +|:-------------------|:---------:|:-----------| +| NextToken | **N** | | +| QueueUrl.N (array) | **Y** | | + +## DeleteMessage + +DeleteMessage requires the `CanReceive` permission. + +### DeleteMessage Request + +| Parameters | Support | Comments | +|:--------------|:---------:|:-----------| +| QueueUrl | **Y** | | +| ReceiptHandle | **Y** | | + +## DeleteMessageBatch + +DeleteMessageBatch requires the `CanReceive` permission. + +### DeleteMessageBatch Request + +| Parameters | Support | Comments | +|:-----------------------------------------|:---------:|:-----------| +| DeleteMessageBatchRequestEntry.N (array) | **Y** | | +| QueueUrl | **Y** | | + +### DeleteMessageBatch Response + +| Elements | Support | Comments | +|:----------------------------------------|:---------:|:-----------| +| BatchResultErrorEntry.N (array) | **Y** | | +| DeleteMessageBatchResultEntry.N (array) | **Y** | | + +## DeleteQueue + +DeleteQueue requires the `CanManage` permission. + +### DeleteQueue Request + +| Parameters | Support | Comments | +|:-------------|:---------:|:-----------| +| QueueUrl | **Y** | | + +## GetQueueUrl + +GetQueueUrl requires the `CanPublish, CanReceive or CanManage` permission. + +### GetQueueUrl Request + +| Parameters | Support | Comments | +|:-----------------------|:---------:|:-----------| +| QueueName | **Y** | | +| QueueOwnerAWSAccountId | **Y** | | + +### GetQueueUrl Response + +| Elements | Support | Comments | +|:-----------|:---------:|:-----------| +| QueueUrl | **Y** | | + +## GetQueueAttributes + +GetQueueAttributes requires the `CanPublish`, `CanReceive` or `CanManage` permission. + +### GetQueueAttributes Request + +| Parameters | Support | Comments | +|:------------------------|:---------:|:--------------------------------------------------------------------------------------------------| +| AttributeName.N (array) | **P** | See supported attributes in the [SQS Queue Attributes](#sqs-api-support-queue-attributes) section | +| QueueUrl | **Y** | | + +### GetQueueAttributes Response + +| Elements | Support | Comments | +|:----------------|:---------:|:--------------------------------------------------------------------------------------------------| +| Attribute (map) | **P** | See supported attributes in the [SQS Queue Attributes](#sqs-api-support-queue-attributes) section | + +## SetQueueAttributes + +SetQueueAttributes requires the `CanManage` permission. + +### SetQueueAttributes Request + +| Parameters | Support | Comments | +|:----------------|:---------:|:--------------------------------------------------------------------------------------------------| +| Attribute (map) | **P** | See supported attributes in the [SQS Queue Attributes](#sqs-api-support-queue-attributes) section | +| QueueUrl | **Y** | | + +## ChangeMessageVisibility + +ChangeMessageVisibility requires the `CanReceive` or `CanManage` permission. + +### ChangeMessageVisibility Request + +| Parameters | Support | Comments | +|:------------------|:---------:|:----------------------------------------------------------------| +| QueueUrl | **Y** | | +| ReceiptHandle | **Y** | | +| VisibilityTimeout | **P** | Only '0' and the current queue visibility timeout are supported | + +## ChangeMessageVisibilityBatch + +ChangeMessageVisibilityBatch requires the `CanReceive` or `CanManage` permission. + +### ChangeMessageVisibilityBatch Request + +| Parameters | Support | Comments | +|:--------------------------------------------------|:---------:|:-----------------------------------------------------------------------------------------------------------| +| QueueUrl | **Y** | | +| ChangeMessageVisibilityBatchResultEntry.N (array) | **P** | The same VisibilityTimeout values are supported as for [ChangeMessageVisibility](#changemessagevisibility) | + +## PurgeQueue + +PurgeQueue requires the `CanManage` permission. + +### PurgeQueue Request + +| Parameters | Support | Comments | +|:-------------|:---------:|:-----------| +| QueueUrl | **Y** | | + +### SQS API support - Queue attributes + +The Scaleway Queues API (currently named the SQS API) supports the following queue attributes: + +| Attribute Name | Support | Comments | +|:--------------------------------------|:---------:|:-----------| +| All | **Y** | | +| ApproximateNumberOfMessages | **Y** | | +| ApproximateNumberOfMessagesDelayed | **N** | | +| ApproximateNumberOfMessagesNotVisible | **Y** | When a message has been delivered once, it will be counted here until it is deleted, even if its VisibilityTimeout expires. | +| ContentBasedDeduplication | **Y** | | +| CreatedTimestamp | **Y** | | +| DeduplicationScope | **N** | | +| DelaySeconds | **N** | | +| FifoQueue | **Y** | | +| FifoThroughputLimit | **N** | | +| KmsDataKeyReusePeriodSeconds | **N** | | +| KmsMasterKeyId | **N** | | +| LastModifiedTimestamp | **N** | | +| MaximumMessageSize | **Y** | | +| MessageRetentionPeriod | **Y** | | +| Policy | **N** | | +| QueueArn | **Y** | | +| ReceiveMessageWaitTimeSeconds | **Y** | | +| RedriveAllowPolicy | **N** | | +| RedrivePolicy | **Y** | | +| SqsManagedSseEnabled | **N** | | +| VisibilityTimeout | **Y** | | + +### SQS API support - Message attributes + +The Scaleway Queues API (currently named the SQS API) supports the following queue attributes: + +| Attribute Name | Support | Comments | +|:---------------------------------|:---------:|:-----------| +| All | **Y** | | +| ApproximateFirstReceiveTimestamp | **N** | | +| ApproximateReceiveCount | **Y** | | +| AWSTraceHeader | **N** | | +| MessageDeduplicationId | **Y** | | +| MessageGroupId | **N** | | +| SequenceNumber | **Y** | | +| SenderId | **Y** | | +| SentTimestamp | **Y** | | \ No newline at end of file