Amazon SNS notifications for SaaS products - AWS Marketplace

Amazon SNS notifications for SaaS products

To receive notifications, you subscribe to the AWS Marketplace Amazon Simple Notification Service (Amazon SNS) topic provided to you during product creation. The topic provides notifications about changes to customers’ subscription and contract entitlement statuses. This enables you to know when to provide and revoke access for specific customers.

The following Amazon SNS topics are specific to software as a service (SaaS) products:

  • aws-mp-entitlement-notification – This Amazon SNS topic is for SaaS contracts.

  • aws-mp-subscription-notification – This Amazon SNS topic is for SaaS subscriptions and contracts with additional consumption.

Note

If your product is priced for SaaS contracts with consumption, you must use both of these topics.

SaaS product Amazon SNS message body

Each message for the SaaS product Amazon SNS notifications has the following format.

{ "action": "action-name", "customer-identifier": " X01EXAMPLEX", "product-code": "n0123EXAMPLEXXXXXXXXXXXX" }

The action-name will vary depending on the message. Possible actions are listed in the following topic.

SaaS product Amazon SNS actions

As a SaaS contract provider, you'll receive messages with the entitlement-updated action. When you get one of these messages, a subsequent call to the GetEntitlement AWS Marketplace Entitlement Service action is required to discover the content of the update.

If you provide a SaaS subscription product (or a SaaS contract with consumption product), you'll receive messages with the following actions:

  • subscribe-success

  • subscribe-fail

  • unsubscribe-pending

  • unsubscribe-success

Subscribing an SQS queue to the SNS topic

We recommend subscribing an Amazon SQS queue to the provided SNS topic. For detailed instructions on creating an SQS queue and subscribing the queue to the provided topic, see Subscribing an Amazon SQS queue to an Amazon SNS topic in the Amazon Simple Notification Service Developer Guide.

Note

You can only subscribe to the SNS topic from the AWS account used to sell the products. However, you can forward the messages to a different account. For more information, see Sending Amazon SNS messages to an Amazon SQS queue in a different account in the Amazon Simple Notification Service Developer Guide.

Polling the SQS queue for notifications

Finally, you need to define a service that continually polls the queue, looks for messages, and handles them accordingly.