Skip to content

Commit 9860710

Browse files
RoRoJRoRoJ
committed
feat(queues): add queues doc
1 parent 06b268b commit 9860710

22 files changed

+286
-980
lines changed

‎menu/navigation.json‎

Lines changed: 11 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -4147,7 +4147,7 @@
41474147
"items": [
41484148
{
41494149
"label": "Overview",
4150-
"slug": "../messaging"
4150+
"slug": "../queues"
41514151
},
41524152
{
41534153
"label": "Concepts",
@@ -4163,10 +4163,6 @@
41634163
},
41644164
{
41654165
"items": [
4166-
{
4167-
"label": "Get started with NATS, Queues, or Topics and Events",
4168-
"slug": "get-started"
4169-
},
41704166
{
41714167
"label": "Create credentials",
41724168
"slug": "create-credentials"
@@ -4180,58 +4176,30 @@
41804176
"slug": "create-manage-queues"
41814177
},
41824178
{
4183-
"label": "Create and manage topics",
4184-
"slug": "create-manage-topics"
4185-
},
4186-
{
4187-
"label": "Create and manage subscriptions",
4188-
"slug": "create-manage-subscriptions"
4189-
},
4190-
{
4191-
"label": "Monitor NATS, Queues, and Topics and Events with Cockpit",
4192-
"slug": "monitor-mnq-cockpit"
4193-
},
4194-
{
4195-
"label": "Delete a NATS, Queues, or Topics and Events service",
4196-
"slug": "deactivate-delete-messaging"
4179+
"label": "Monitor Queues with Cockpit",
4180+
"slug": "monitor-queues-cockpit"
41974181
}
41984182
],
41994183
"label": "How to",
42004184
"slug": "how-to"
42014185
},
42024186
{
42034187
"items": [
4204-
{
4205-
"label": "NATS API Reference",
4206-
"slug": "https://www.scaleway.com/en/developers/api/messaging-and-queuing/nats-api/"
4207-
},
42084188
{
42094189
"label": "Queues API Reference",
42104190
"slug": "https://www.scaleway.com/en/developers/api/messaging-and-queuing/sqs-api/"
42114191
},
42124192
{
4213-
"label": "Topics and Events API Reference",
4214-
"slug": "https://www.scaleway.com/en/developers/api/messaging-and-queuing/sns-api/"
4215-
},
4216-
{
4217-
"label": "Connecting Queues or Topics and Events to the AWS-CLI",
4193+
"label": "Connecting Queues to the AWS-CLI",
42184194
"slug": "connect-aws-cli"
42194195
},
42204196
{
4221-
"label": "Using Queues or Topics and Events with the AWS-CLI",
4222-
"slug": "sqs-sns-aws-cli"
4223-
},
4224-
{
4225-
"label": "Using Go, Python or Node.js with Topics and Events",
4226-
"slug": "python-node-sns"
4197+
"label": "Using Queues with the AWS-CLI",
4198+
"slug": "queues-aws-cli"
42274199
},
42284200
{
42294201
"label": "Using Go, Python or Node.js with Queues",
4230-
"slug": "python-node-sqs"
4231-
},
4232-
{
4233-
"label": "Using the NATS CLI",
4234-
"slug": "nats-cli"
4202+
"slug": "python-node-queues"
42354203
}
42364204
],
42374205
"label": "API/CLI",
@@ -4241,23 +4209,11 @@
42414209
"items": [
42424210
{
42434211
"label": "Queues overview",
4244-
"slug": "sqs-overview"
4245-
},
4246-
{
4247-
"label": "Topics and Events overview",
4248-
"slug": "sns-overview"
4249-
},
4250-
{
4251-
"label": "NATS overview",
4252-
"slug": "nats-overview"
4253-
},
4254-
{
4255-
"label": "Topics and Events - supported actions",
4256-
"slug": "sns-support"
4212+
"slug": "queues-overview"
42574213
},
42584214
{
42594215
"label": "Queues - supported actions",
4260-
"slug": "sqs-support"
4216+
"slug": "queues-support"
42614217
},
42624218
{
42634219
"label": "Limitations",
@@ -4268,8 +4224,8 @@
42684224
"slug": "reference-content"
42694225
}
42704226
],
4271-
"label": "NATS, Queues, Topics and Events",
4272-
"slug": "messaging"
4227+
"label": "Queues",
4228+
"slug": "queues"
42734229
},
42744230
{
42754231
"items": [

‎pages/queues/api-cli/connect-aws-cli.mdx‎

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,34 @@
11
---
22
meta:
3-
title: Connecting Queues or Topics and Events to the AWS-CLI
4-
description: This page explains how to connect Scaleway Queues and/or Topics and Events to the AWS-CLI
3+
title: Connecting Scaleway Queues to the AWS-CLI
4+
description: This page explains how to connect Scaleway Queues to the AWS-CLI
55
content:
6-
h1: Connecting Queues or Topics and Events to the AWS-CLI
7-
paragraph: This page explains how to connect Scaleway Queues and/or Topics and Events to the AWS-CLI
8-
tags: messaging sns sqs aws-cli cli aws sdk python boto
6+
h1: Connecting Scaleway Queues to the AWS-CLI
7+
paragraph: This page explains how to connect Scaleway Queues to the AWS-CLI
8+
tags: messaging queues sqs aws-cli cli aws sdk python boto
99
categories:
10-
- messaging
10+
- serverless
1111
dates:
12-
validation: 2024-10-18
13-
posted: 2023-01-04
12+
validation: 2025-04-02
13+
posted: 2025-04-02
1414
---
1515

16-
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 or Scaleway Topics and Events. This allows you to create, list and manage your queues and topics, send messages and much more, all from your command line.
16+
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.
1717

18-
This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Queues or Scaleway Topics and Events.
18+
This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Queues.
1919

2020
<Macro id="requirements" />
2121

2222
- A Scaleway account logged into the [console](https://console.scaleway.com)
2323
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
24-
- Valid [credentials](/messaging/how-to/create-credentials/) for Queues and/or Topics and Events
25-
24+
- Valid [credentials](/queues/how-to/create-credentials/) for Scaleway Queues
2625
<Message type="note">
2726
This page assumes you will use the AWS-CLI v1.
2827
</Message>
2928

3029
## How to install the AWS-CLI
3130

32-
To interact with Scaleway Queues and Scaleway Topics and Events, 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.
31+
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.
3332

3433
Install both `aws-cli` and `awscli-plugin` using `pip`.
3534

@@ -40,7 +39,7 @@ pip3 install awscli-plugin-endpoint
4039

4140
## How to configure the AWS-CLI
4241

43-
Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Queues / Topics and Events.
42+
Now you have installed the AWS-CLI, you need to configure it for use with Scaleway Queues.
4443

4544
1. Create a file named `~/.aws/config` by running the following command:
4645
```
@@ -51,21 +50,19 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
5150
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.
5251
</Message>
5352

54-
2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the Queues (SQS) or Topics and Events (SNS) endpoint URLs can be found in the console on the **Settings** page for the relevant product)
53+
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)
5554
```
5655
[plugins]
5756
endpoint = awscli_plugin_endpoint
5857
[profile sns]
5958
region = fr-par
60-
sns =
61-
endpoint_url = https://sns.mnq.fr-par.scaleway.com
6259
[profile sqs]
6360
region = fr-par
6461
sqs =
6562
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
6663
```
6764

68-
Optionally, you can also configure additional profiles by adding new blocks under `[sqs]` and `[sns]`. For example, you can add a third profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want:
65+
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:
6966

7067
```
7168
[plugins]
@@ -90,9 +87,6 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
9087
<Message type="tip">
9188
If you are using aws 1.29.0 or 2.13.0 without the plugin, your configuration file should be as follows:
9289
```
93-
[profile sns]
94-
region = fr-par
95-
endpoint_url = https://sns.mnq.fr-par.scaleway.com
9690
[profile sqs]
9791
region = fr-par
9892
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
@@ -104,34 +98,32 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
10498
```
10599
aws configure
106100
```
107-
**
108-
4. Open the `~/.aws/credentials` file you just created, and for each product (out of **Queues** and **Topics and Events**) you want to use, add the access key and secret key you saved when you generated your [credentials](/messaging/how-to/create-credentials/):
109-
```
110-
[topics_events]
111-
aws_access_key_id=<ACCESS_KEY_FOR_SNS>
112-
aws_secret_access_key=<SECRET_KEY_FOR_SNS>
113101

102+
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/):
103+
```
114104
[queues]
115105
aws_access_key_id=<ACCESS_KEY_FOR_SQS>
116106
aws_secret_access_key=<SECRET_KEY_FOR_SQS>
117107
```
118108

119109
If you have other profiles, you can add a block to indicate their credentials too:
120110
```
111+
[topics_events]
112+
aws_access_key_id=<ACCESS_KEY_FOR_SNS>
113+
aws_secret_access_key=<SECRET_KEY_FOR_SNS>
114+
121115
[aws]
122116
aws_access_key_id=<ACCESS_KEY>
123117
aws_secret_access_key=<SECRET_KEY>
124118
```
125119

126-
6. Test that everything is set up correctly with the following command:
120+
5. Test that everything is set up correctly with the following command:
127121
```
128122
aws queues list-queues
129123
```
130124

131125
Use the `--profile` option if you want to test it using a different profile.
132126

133127
<Message type="tip">
134-
Check out our dedicated documentation to find more common commands for getting started with the AWS CLI:
135-
- The [Queues guide](/messaging/api-cli/sqs-sns-aws-cli/#getting-started-with-scaleway-queues) walks you through creating and listing queues, sending messages to queues, and more.
136-
- The [Topics and Events guide](/messaging/api-cli/sqs-sns-aws-cli/#getting-started-with-topics-and-events) shows you how to create and list topics and subscriptions, send messages to topics, and more.
128+
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.
137129
</Message>

‎pages/queues/api-cli/index.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
meta:
3-
title: NATS, Queues, and Topics and Events - API/CLI Documentation
4-
description: NATS, Queues, and Topics and Events API/CLI Documentation
3+
title: Queues - API/CLI Documentation
4+
description: Queues API/CLI Documentation
55
content:
6-
h1: NATS, Queues, and Topics and Events - API/CLI Documentation
7-
paragraph: NATS, Queues, and Topics and Events API/CLI Documentation
6+
h1: Queues - API/CLI Documentation
7+
paragraph: Queues API/CLI Documentation
88
---

‎pages/queues/api-cli/python-node-sqs.mdx‎ renamed to ‎pages/queues/api-cli/python-node-queues.mdx‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ categories:
1111
dates:
1212
validation: 2024-10-18
1313
posted: 2023-01-04
14-
validation_frequency: 8
1514
---
1615

17-
AWS provides a number of SDKs (**S**oftware **D**evelopment **K**its) which provide language-specific APIs for AWS services, including [SQS](/messaging/concepts#sqs), which is the protocol Scaleway Queues is based on.
16+
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.
1817

1918
- AWS provides a dedicated [SDK for Go](https://aws.amazon.com/sdk-for-go/).
2019
- The [AWS SDK for Python](https://aws.amazon.com/sdk-for-python/) is Boto3
@@ -26,7 +25,7 @@ This guide provides code samples to show you how to start using these SDKs with
2625

2726
- A Scaleway account logged into the [console](https://console.scaleway.com)
2827
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
29-
- Valid [credentials](/messaging/how-to/create-credentials/) for Scaleway Queues
28+
- Valid [credentials](/queues/how-to/create-credentials/) for Scaleway Queues
3029
- 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/)
3130

3231
## Go
@@ -58,11 +57,11 @@ func main() {
5857

5958
<Message type="note">
6059

61-
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](/messaging/how-to/create-credentials/) for Queues.
60+
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.
6261

6362
</Message>
6463

65-
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](/messaging/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.
64+
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.
6665

6766
### Create queue (Go)
6867

@@ -115,10 +114,10 @@ sqs = boto3.resource('sqs',
115114
```
116115

117116
<Message type="note">
118-
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](/messaging/how-to/create-credentials/) for Queues.
117+
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.
119118
</Message>
120119

121-
Once connected, you can use any functions available with the SDK - just check that they are [supported by Scaleway Queues](/messaging/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.
120+
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.
122121

123122
### Create queue (Python)
124123

@@ -172,10 +171,10 @@ var sqsClient = new SQSClient({
172171
```
173172

174173
<Message type="note">
175-
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](/messaging/how-to/create-credentials/) for Scaleway Queues.
174+
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.
176175
</Message>
177176

178-
Once connected, you can use any of the SDK's functions as long as they're [supported by Scaleway Queues](/messaging/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.
177+
Once connected, you can use any of the SDK's functions as long as they're [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.
179178

180179
### Create queue (NodeJS)
181180

0 commit comments

Comments
 (0)