AWS Deep Dive

Amazon API Gateway

Continued notes about the Amazon API Gateway.

Working With WebSocket APIs

Setting Up Data Transformations for WebSocket APIs in API Gateway

WebSocket API proxy integrations cannot use integration response templates - the backend response is always passed back as-is to the caller. When response templates are used, they are limited to switching on Lambda error messages or HTTP status codes (depending on the integration type).

Working With Binary Media Types for WebSocket APIs in API Gateway

Basically, WebSocket APIs in API Gateway can’t handle raw binary. Any such files need to be converted to/from base64, as appropriate, as the first step in processing.

Invoking a WebSocket API in API Gateway

Sending callback messages from the backend to the client require that those messages be SigV4 signed. Surprisingly, this can be done by calling the corresponding @connections URL in API Gateway directly - connections don’t have to be established through API Gateway first!


Given that any client can call this URL, it’s a good thing that SigV4 signing is required!

Messages can be sent to the client at connection_id using POST requests, while the client’s current status will be returned when using GET. A DELETE request will disconnect the client.

Working With Stages for WebSocket APIs in API Gateway

As with other API types, you cannot specify a Lambda function for use with the WebSockets API using stage variables if that function is in another account.

Deploy a WebSocket API in API Gateway

Each API in API Gateway is limited to ten stages.