Skip to content

Commit 8b09cf1

Browse files
committed
feat(topics): continue to add content
1 parent fa8f7bd commit 8b09cf1

20 files changed

+208
-710
lines changed
Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
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 Topics and Events to the AWS-CLI
4+
description: This page explains how to connect Scaleway Topics and Events 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 Topics and Events to the AWS-CLI
7+
paragraph: This page explains how to connect Scaleway Topics and Events to the AWS-CLI
8+
tags: messaging sns aws-cli cli aws sdk python boto
99
categories:
1010
- messaging
1111
dates:
12-
validation: 2024-10-18
12+
validation: 2025-04-10
1313
posted: 2023-01-04
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 Topics and Events. This allows you to create, list and manage your topics, 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 Topics and Events.
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
24+
- Valid [credentials](/topics-and-events/how-to/create-credentials/) for Topics and Events
2525

2626
<Message type="note">
2727
This page assumes you will use the AWS-CLI v1.
2828
</Message>
2929

3030
## How to install the AWS-CLI
3131

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.
32+
To interact with 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.
3333

3434
Install both `aws-cli` and `awscli-plugin` using `pip`.
3535

@@ -40,7 +40,7 @@ pip3 install awscli-plugin-endpoint
4040

4141
## How to configure the AWS-CLI
4242

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

4545
1. Create a file named `~/.aws/config` by running the following command:
4646
```
@@ -51,21 +51,17 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
5151
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.
5252
</Message>
5353

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)
54+
2. Open the `~/.aws/config` file you just created in a text editor and edit it as follows (the Topics and Events (SNS) endpoint URLs can be found in the console on the **Settings** page for your Topics and Events service).
5555
```
5656
[plugins]
5757
endpoint = awscli_plugin_endpoint
5858
[profile sns]
5959
region = fr-par
6060
sns =
6161
endpoint_url = https://sns.mnq.fr-par.scaleway.com
62-
[profile sqs]
63-
region = fr-par
64-
sqs =
65-
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
6662
```
6763

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:
64+
Optionally, you can also configure additional profiles by adding new blocks under `[sns]`. For example, you can add a profile for `[sqs]` if you are also using Scaleway Queues, or another profile, `[profile aws]`, to connect to the AWS SQS/SNS service if you want:
6965

7066
```
7167
[plugins]
@@ -93,9 +89,6 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
9389
[profile sns]
9490
region = fr-par
9591
endpoint_url = https://sns.mnq.fr-par.scaleway.com
96-
[profile sqs]
97-
region = fr-par
98-
endpoint_url = https://sqs.mnq.fr-par.scaleway.com
9992
```
10093
</Message>
10194

@@ -105,33 +98,31 @@ Now you have installed the AWS-CLI, you need to configure it for use with Scalew
10598
aws configure
10699
```
107100
**
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/):
101+
4. Open the `~/.aws/credentials` file you just created, and add the access key and secret key you saved when you generated your [credentials](/topics-and-events/how-to/create-credentials/):
109102
```
110103
[topics_events]
111104
aws_access_key_id=<ACCESS_KEY_FOR_SNS>
112105
aws_secret_access_key=<SECRET_KEY_FOR_SNS>
106+
```
113107

108+
If you have other profiles, you can add a block to indicate their credentials too:
109+
```
114110
[queues]
115111
aws_access_key_id=<ACCESS_KEY_FOR_SQS>
116112
aws_secret_access_key=<SECRET_KEY_FOR_SQS>
117-
```
118113
119-
If you have other profiles, you can add a block to indicate their credentials too:
120-
```
121114
[aws]
122115
aws_access_key_id=<ACCESS_KEY>
123116
aws_secret_access_key=<SECRET_KEY>
124117
```
125118

126119
6. Test that everything is set up correctly with the following command:
127120
```
128-
aws queues list-queues
121+
aws topics_events list-topics
129122
```
130123

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

133126
<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.
127+
Check out our dedicated documentation to find more common commands for getting started with the AWS CLI. The [Topics and EVents guide](/queues/api-cli/topics-events-aws-cli/) walks you through creating and listing topics, sending messages.
137128
</Message>
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: Topics and Events - API/CLI Documentation
4+
description: Topics and Events 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: Topics and Events - API/CLI Documentation
7+
paragraph: Topics and Events API/CLI Documentation
88
---

pages/topics-and-events/api-cli/python-node-sns.mdx renamed to pages/topics-and-events/api-cli/python-node-topics-events.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ dates:
1313
posted: 2023-01-04
1414
---
1515

16-
AWS provides a number of **S**oftware **D**evelopment **K**its (SDKs) which provide language-specific APIs for AWS services, including [SNS](/messaging/concepts/#sns), which is the protocol that Scaleway Topics and Events is based on.
16+
AWS provides a number of **S**oftware **D**evelopment **K**its (SDKs) which provide language-specific APIs for AWS services, including [SNS](/topics-and-events/concepts/#sns), which is the protocol that Scaleway Topics and Events is based on.
1717

1818
- AWS provides a dedicated [SDK for Go](https://aws.amazon.com/sdk-for-go/).
1919
- The [AWS SDK for Python](https://aws.amazon.com/sdk-for-python/) is Boto3.
@@ -25,7 +25,7 @@ This page provides code samples to show you how to get started using these SDKs
2525

2626
- A Scaleway account logged into the [console](https://console.scaleway.com)
2727
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
28-
- Valid [credentials](/messaging/how-to/create-credentials/) for Topics and Events
28+
- Valid [credentials](/topics-and-events/how-to/create-credentials/) for Topics and Events
2929
- 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/)
3030

3131
## Go
@@ -57,11 +57,11 @@ func main() {
5757

5858
<Message type="note">
5959

60-
The `Endpoint` for Scaleway Topics and Events is `https://sns.mnq.fr-par.scaleway.com`. The values for the access and secret keys should be the credentials you [generated](/messaging/how-to/create-credentials/) for Topics and Events.
60+
The `Endpoint` for Scaleway Topics and Events is `https://sns.mnq.fr-par.scaleway.com`. The values for the access and secret keys should be the credentials you [generated](/topics-and-events/how-to/create-credentials/) for Topics and Events.
6161

6262
</Message>
6363

64-
Once connected, you can use any of the SDK's available functions. Be aware though that some functions are not [supported by Scaleway Topics and Events](/messaging/reference-content/sns-support/), so make sure to check the link for more details on these. See the [official SDK documentation](https://pkg.go.dev/github.com/aws/aws-sdk-go/service/sns) for more information on getting started with the SDK, or keep reading for some code examples.
64+
Once connected, you can use any of the SDK's available functions. Be aware though that some functions are not [supported by Scaleway Topics and Events](/topics-and-events/reference-content/sns-support/), so make sure to check the link for more details on these. See the [official SDK documentation](https://pkg.go.dev/github.com/aws/aws-sdk-go/service/sns) for more information on getting started with the SDK, or keep reading for some code examples.
6565

6666
### Create topic (Go)
6767

@@ -159,10 +159,10 @@ sns = boto3.resource('sns',
159159
```
160160
161161
<Message type="note">
162-
The `endpoint_url` for Scaleway Topics and Events (based on SNS) is `https://sns.mnq.fr-par.scaleway.com`. The values for the access and secret keys should be the credentials you [generated](/messaging/how-to/create-credentials/) for Topics and Events.
162+
The `endpoint_url` for Scaleway Topics and Events (based on SNS) is `https://sns.mnq.fr-par.scaleway.com`. The values for the access and secret keys should be the credentials you [generated](/topics-and-events/how-to/create-credentials/) for Topics and Events.
163163
</Message>
164164
165-
Once connected to, you can use any of the SDK's available functions. However, some functions are not [supported by Scaleway Topics and Events](/messaging/reference-content/sns-support/), so do check the link to make sure. See the [official SDK documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) for more information, or keep reading for some code examples.
165+
Once connected to, you can use any of the SDK's available functions. However, some functions are not [supported by Scaleway Topics and Events](/topics-and-events/reference-content/sns-support/), so do check the link to make sure. See the [official SDK documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) for more information, or keep reading for some code examples.
166166

167167
### Create topic (Python)
168168

@@ -276,10 +276,10 @@ var snsClient = new SNSClient({
276276
```
277277

278278
<Message type="note">
279-
The `endpoint_url` for Scaleway Topics and Events is `https://sns.mnq.fr-par.scaleway.com`. For the access and secret key values, use the credentials you [generated](/messaging/how-to/create-credentials/) for Topics and Events.
279+
The `endpoint_url` for Scaleway Topics and Events is `https://sns.mnq.fr-par.scaleway.com`. For the access and secret key values, use the credentials you [generated](/topics-and-events/how-to/create-credentials/) for Topics and Events.
280280
</Message>
281281

282-
Once connected, you can use any of the SDK's available functions. However, some functions are not [supported by Scaleway Topics and Events](/messaging/reference-content/sns-support), so do check the link to make sure. See the [official SDK documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sns/) for more information, or keep reading for some code examples.
282+
Once connected, you can use any of the SDK's available functions. However, some functions are not [supported by Scaleway Topics and Events](/topics-and-events/reference-content/sns-support), so do check the link to make sure. See the [official SDK documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sns/) for more information, or keep reading for some code examples.
283283
284284
### Create topic (NodeJS)
285285

pages/topics-and-events/api-cli/sqs-sns-aws-cli.mdx renamed to pages/topics-and-events/api-cli/topics-events-aws-cli.mdx

Lines changed: 11 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,28 @@
11
---
22
meta:
3-
title: Using Scaleway Queues and Scaleway Topics and Events with the AWS-CLI
4-
description: This page explains how to use Scaleway Queues and Scaleway Topics and Events for creating queues and sending and receiving messages with the AWS CLI
3+
title: Using Scaleway Topics and Events with the AWS-CLI
4+
description: This page explains how to use Scaleway Topics and Events for creating topics and sending and receiving messages with the AWS CLI
55
content:
6-
h1: Using Scaleway Queues and Scaleway Topics and Events with the AWS-CLI
7-
paragraph: This page explains how to use Scaleway Queues and Scaleway Topics and Events for creating queues and sending and receiving messages with the AWS CLI
8-
tags: messaging sns sqs aws-cli cli aws queues messages subscribe publish
6+
h1: Using Scaleway Topics and Events with the AWS-CLI
7+
paragraph: This page explains how to use Scaleway Topics and Events for creating topics and sending and receiving messages with the AWS CLI
8+
tags: messaging sns aws-cli cli aws messages subscribe publish topics
99
categories:
1010
- messaging
1111
dates:
12-
validation: 2024-10-18
12+
validation: 2025-04-10
1313
posted: 2023-04-04
14-
validation_frequency: 8
1514
---
1615

17-
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 and/or Topics and Events to the AWS-CLI](/messaging/api-cli/connect-aws-cli/), you can start creating, listing and managing your queues and topics, sending 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. Once you have [connected Scaleway Topics and Events to the AWS-CLI](/topics-and-events/api-cli/connect-aws-cli/), you can start creating, listing and managing your topics, sending messages and much more, all from your command line.
1817

1918
<Macro id="requirements" />
2019

2120
- A Scaleway account logged into the [console](https://console.scaleway.com)
2221
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
23-
- Valid [credentials](/messaging/how-to/create-credentials/) for Queues and/or Topics and Events
24-
- [Connected Queues and/or Topics and Events to the AWS-CLI](/messaging/api-cli/connect-aws-cli/)
22+
- Valid [credentials](/topics-and-events/how-to/create-credentials/) for Topics and Events
23+
- [Connected Topics and Events to the AWS-CLI](/topics-and-events/api-cli/connect-aws-cli/)
2524
- [jq](https://stedolan.github.io/jq/download/) installed on your machine
2625

27-
## Getting started with Scaleway Queues
28-
29-
1. Use the following command to create a queue:
30-
31-
```sh
32-
aws sqs create-queue --queue-name MyQueue | tee my-queue.json
33-
```
34-
35-
2. Use the following command to list existing queues:
36-
37-
```sh
38-
aws sqs list-queues
39-
```
40-
41-
3. Use the following command to send messages to a queue:
42-
43-
```sh
44-
aws sqs send-message --queue-url $(jq -r .QueueUrl my-queue.json) --message-body "Hello world!"
45-
46-
aws sqs send-message --queue-url $(jq -r .QueueUrl my-queue.json) --message-body "Second Message."
47-
```
48-
49-
4. Use the following command to receive messages:
50-
51-
```sh
52-
aws sqs receive-message --queue-url $(jq -r .QueueUrl my-queue.json) | tee message1.json
53-
54-
aws sqs receive-message --queue-url $(jq -r .QueueUrl my-queue.json) | tee message2.json
55-
```
56-
57-
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.
58-
59-
```sh
60-
aws sqs delete-message --queue-url $(jq -r .QueueUrl my-queue.json) --receipt-handle $(jq -r .Messages[0].ReceiptHandle message1.json)
61-
62-
aws sqs delete-message --queue-url $(jq -r .QueueUrl my-queue.json) --receipt-handle $(jq -r .Messages[0].ReceiptHandle message2.json)
63-
```
64-
65-
6. Use the following command to delete the queue itself:
66-
67-
```sh
68-
aws sqs delete-queue --queue-url $(jq -r .QueueUrl my-queue.json)
69-
```
7026

7127
## Getting started with Topics and Events
7228

@@ -82,7 +38,7 @@ The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto)
8238
aws sns list-topics
8339
```
8440

85-
### Preparing and subscribing to an HTTP/HTTPS target for Topics and Events messages
41+
## Preparing and subscribing to an HTTP/HTTPS target for Topics and Events messages
8642

8743
1. Get the public endpoint of the HTTP server you want to forward your messages to.
8844

@@ -115,7 +71,7 @@ The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto)
11571
curl "<THE-CONFIRMATION-LINK>"
11672
```
11773

118-
### Preparing and subscribing to a lambda (Scaleway Serverless Functions) target for Topics and Events messages
74+
## Preparing and subscribing to a lambda (Scaleway Serverless Functions) target for Topics and Events messages
11975

12076
1. Create the function following the steps detailed in the [Scaleway Functions Quickstart](/serverless-functions/quickstart/).
12177

0 commit comments

Comments
 (0)