Search code examples
amazon-web-servicesamazon-snsaws-api-gateway

AWS API-Gateway communicating to SNS


I am building an API which will be serviced by Lambda functions but I need these to be asynchronous so rather than connecting the API-Gateway directly to the Lambda function I'm using the "AWS Service Proxy" to publish SNS messages and then have the Lambda function subscribe to the relevant SNS topic so it receives delivery of the requests. Here's a picture which illustrates the flow:

enter image description here

I have tested both the Lambda function in isolation as well pub/sub messaging between SNS and Lambda but I am struggling with the API-Gateway to SNS handoff. Documentation is quite light but what I am assuming right now is that the following attributes must be sent in the POST request:

  1. Action: the API-Gateway offers to set this in the UI and I have put in the Publish action which is the appropriate SNS action

  2. Message: the body of the POST message should be a JSON document. It would be passed by the web client and proxied through the gateway to SNS.

  3. TopicArn: indicates the SNS topic that we're publishing to. In my design this would be a static value/endpoint so I'd prefer that the web-client not have to pass this too but if it were easier to do this that would be fine too.

I have tried lots of things but am just stuck. Would love to find a good code example somewhere but any help at all would be appreciated.


Wanted to add a little more context on my current attempt:

I have tried publishing my API and using Postman to try and get a valid response. Here's the postman screens(one for header vars, one for JSON body):

header variables json body

This results in the following error message:

{
   "Error": {
     "Code": "InvalidParameter",
     "Message": "Invalid parameter: TopicArn or TargetArn Reason: no value for required parameter",
     "Type": "Sender"
  },
  "RequestId": "b33b7700-e8a3-58f7-8ebe-39e4e62b02d0"
}

the error seems to indicate that the TopicArn parameter is not being sent to SNS but I have included the following in API-Gateway:

enter image description here


Solution

  • I did eventually get this to work after working with AWS support. Here's my solution:

    • First of all even though you're sending a POST you will not be able to send a JSON message in the body of the message as you might expect
    • Instead you must URL Encode the JSON and pass it as query parameter
    • Also remember that the JSON you send should start with a root object of default which in SNS-world means the "default channel"
    • Then, eventually Lambda picks up the SNS event you must also abstract away a lot of the noise to get at your JSON message. For this I created the following function that I use within my Lambda function:

    /**
     * When this is run in AWS it is run "through" a SNS
     * event wconfig.ich adds a lot of clutter to the event data,
     * this tests for SNS data and normalizes when necessary
     */
    function abstractSNS(e) {
      if (e.Records) {
        return JSON.parse(decodeURIComponent(e.Records[0].Sns.Message)).default;
      } else {
        return e;
      }
    }
    
    /**
     * HANDLER
     * This is the entry point for the lambda function
     */
    exports.handler = function handler(event, context) {
      parent.event = abstractSNS(event);