Connecting Topics and Events to the AWS-CLI

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.

Before you startLink to this anchor

To complete the actions presented below, you must have:

• A Scaleway account logged into the console
• Owner status or IAM permissions allowing you to perform actions in the intended Organization
• Valid credentials for Topics and Events

How to install the AWS-CLILink to this anchor

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-CLILink to this anchor

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
   

   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.

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
   

   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.

   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
   

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_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>
   

5. 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.