Topics and Events API

Introduction

Topics and Events is a managed messaging service provided by Scaleway. It supports the API developed by Amazon with its Simple Notification Service, or Amazon SNS. If you're new to Topics and Events, you can learn more about it on our Topics and Events overview page.

Concepts

Refer to our dedicated concepts page to find definitions of all terminology related to NATS, Queues, and Topics and Events.

Quickstart

1. Configure your environment variables

   Note

   This is an optional step that seeks to simplify your usage of the API.

   export SCW_SECRET_KEY="<API secret key>"
   export SCW_PROJECT_ID="<Scaleway Project ID>"
   

2. Activate Topics and Events on your Scaleway Project:

   curl --silent -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/mnq/v1beta1/regions/fr-par/activate-sns" \
       -d '{
         "project_id": "'$SCW_PROJECT_ID'"
       }' | jq
   curl --silent -X GET \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/mnq/v1beta1/regions/fr-par/sns-info?project_id=$SCW_PROJECT_ID" \
       | tee my-sns-account.json | jq
   

   Tip

   • | tee my-sns-account.json saves the JSON object returned by the API to a file (used by next steps)
   • | jq displays the output nicely

3. Create credentials. Credentials are necessary to authenticate a client to your Topics and Events service. Their permissions should be specified and adapted according to your needs, using true or false for each type of permission.

   curl --silent -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     "https://api.scaleway.com/mnq/v1beta1/regions/fr-par/sns-credentials" \
       -d '{
         "name": "my-credentials",
         "permissions": {
           "can_publish": true,
           "can_receive": true,
           "can_manage": true
         },
         "project_id": "'$SCW_PROJECT_ID'"
       }' | tee my-sns-credentials.json | jq
   

4. Export credentials: Export the credentials to your environment:

   export AWS_ENDPOINT_URL=$(jq -r .sns_endpoint_url my-sns-account.json)
   export AWS_ACCESS_KEY_ID=$(jq -r .access_key my-sns-credentials.json)
   export AWS_SECRET_ACCESS_KEY=$(jq -r .secret_key my-sns-credentials.json)
   

5. Start creating topics and publishing messages. The following commands show you how to create a topic, subscribe to a Scaleway Serverless function, and send, receive and delete a message.

   aws sns create-topic --name my-topic | tee my-topic.json
   

   aws sns subscribe --topic-arn "$(jq -r .TopicArn my-topic.json)" \
     --protocol lambda --notification-endpoint <YOUR-FUNCTION-ENDPOINT>
   

   aws sns publish --topic-arn "$(jq -r .TopicArn my-topic.json)" \
     --message 'Hello world!'
   

6. Disable Topics and Events

   Important

   Disabling Topics and Events deletes all topics and messages stored in your Topics and Events service.

   curl --silent -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
       "https://api.scaleway.com/mnq/v1beta1/regions/fr-par/deactivate-sns" \
       -d '{
         "project_id": "'$SCW_PROJECT_ID'"
       }' | jq
   

Technical limitations

Scaleway Topics and Events does not support the entire set of AWS SNS actions or parameters. See the compatibility matrix for more information.

Also note that:

• The maximum message size is 256 kB.
• The maximum storage capacity for all topics of a project is 100 MB.

Technical information

Regional availability

Scaleway Topics and Events is currently available in the following regions:

• Paris, France (fr-par)
• Amsterdam, Netherlands (nl-ams)

Topics and Events credentials

Credentials use a simplified permissions system with 3 permissions:

• can_publish : allows to publish messages to a Topic.
• can_receive : allows to subscribe to a topic.
• can_manage : allows all other actions (Creating, Listing, Updating, Deleting Topics).

Each set of credentials gives access to all topics. Isolation can be handled by using several Scaleway Projects.

Going further

For more help using Scaleway Topics and Events, check out the following resources:

• Our main documentation
• The #messaging-queuing channel on our Slack community
• Our support ticketing system

You can also read the AWS SNS documentation.