Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 103 additions & 15 deletions menu/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -4304,23 +4304,111 @@
"slug": "queues"
},
{
"items": [
{
"label": "Overview",
"slug": "../serverless-sql-databases"
},
{
"label": "Concepts",
"slug": "concepts"
},
{
"label": "Quickstart",
"slug": "quickstart"
"items": [
{
"label": "Overview",
"slug": "../topics-and-events"
},
{
"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-topics"
},
{
"label": "Create and manage subscriptions",
"slug": "create-manage-subscriptions"
},
{
"label": "Monitor Topics and Events with Cockpit",
"slug": "monitor-topics-cockpit"
}
],
"label": "How to",
"slug": "how-to"
},
{
"items": [
{
"label": "Topics and Events API Reference",
"slug": "https://www.scaleway.com/en/developers/api/messaging-and-queuing/sns-api/"
},
{
"label": "Connecting Topics and Events to the AWS-CLI",
"slug": "connect-aws-cli"
},
{
"label": "Using Topics and Events with the AWS-CLI",
"slug": "topics-events-aws-cli"
},
{
"label": "Using Go, Python or Node.js with Topics and Events",
"slug": "python-node-topics-events"
}
],
"label": "API/CLI",
"slug": "api-cli"
},
{
"items": [
{
"label": "Topics and Events overview",
"slug": "topics-and-events-overview"
},
{
"label": "Topics and Events - supported actions",
"slug": "topics-and-events-support"
},
{
"label": "Limitations",
"slug": "limitations"
}
],
"label": "Additional Content",
"slug": "reference-content"
}
],
"label": "Topics and Events",
"slug": "topics-and-events"
},
{
"label": "FAQ",
"slug": "faq"
},
"items": [
{
"label": "Overview",
"slug": "../serverless-sql-databases"
},
{
"label": "Concepts",
"slug": "concepts"
},
{
"label": "Quickstart",
"slug": "quickstart"
},
{
"label": "FAQ",
"slug": "faq"
},
{
"items": [
{
Expand Down
128 changes: 128 additions & 0 deletions pages/topics-and-events/api-cli/connect-aws-cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
---
meta:
title: Connecting Topics and Events to the AWS-CLI
description: This page explains how to connect Scaleway Topics and Events to the AWS-CLI
content:
h1: Connecting Topics and Events to the AWS-CLI
paragraph: This page explains how to connect Scaleway Topics and Events to the AWS-CLI
tags: messaging sns aws-cli cli aws sdk python boto
categories:
- messaging
dates:
validation: 2025-04-10
posted: 2023-01-04
---

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.

This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Topics and Events.

<Macro id="requirements" />

- 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](/topics-and-events/how-to/create-credentials/) for Topics and Events

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

## How to install the AWS-CLI

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.

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 Topics and Events.

1. Create a file named `~/.aws/config` by running the following command:
```
aws configure set plugins.endpoint awscli_plugin_endpoint
```

<Message type="tip">
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.
</Message>

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).
```
[plugins]
endpoint = awscli_plugin_endpoint
[profile sns]
region = fr-par
sns =
endpoint_url = https://sns.mnq.fr-par.scaleway.com
```

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:

```
[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
```

<Message type="important">
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 = <path-to-plugin>` to the `[plugins]` section, replacing `<path-to-plugin>` with the corresponding path.
</Message>

<Message type="tip">
If you are using aws 1.29.0 or 2.13.0 without the plugin, your configuration file should be as follows:
```
[profile sns]
region = fr-par
endpoint_url = https://sns.mnq.fr-par.scaleway.com
```
</Message>


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](/topics-and-events/how-to/create-credentials/):
```
[topics_events]
aws_access_key_id=<ACCESS_KEY_FOR_SNS>
aws_secret_access_key=<SECRET_KEY_FOR_SNS>
```

If you have other profiles, you can add a block to indicate their credentials too:
```
[queues]
aws_access_key_id=<ACCESS_KEY_FOR_SQS>
aws_secret_access_key=<SECRET_KEY_FOR_SQS>

[aws]
aws_access_key_id=<ACCESS_KEY>
aws_secret_access_key=<SECRET_KEY>
```

6. Test that everything is set up correctly with the following command:
```
aws topics_events list-topics
```

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

<Message type="tip">
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.
</Message>
8 changes: 8 additions & 0 deletions pages/topics-and-events/api-cli/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
meta:
title: Topics and Events - API/CLI Documentation
description: Topics and Events API/CLI Documentation
content:
h1: Topics and Events - API/CLI Documentation
paragraph: Topics and Events API/CLI Documentation
---
Loading