How can I send a response body back to a client from an AWS Lambda function through API Gateway WebSocket

Question

API gateway configured to call a lambda application for $default messages.

The Java Lambda application where I return an APIGatewayV2WebSocketResponse object as a response. Before returning, I set the response code and response body.

However, the client does not receive these responses. How can I ensure that the client receives the response code and body.

Accepted Answer

Hi, you need to post the message using the Api Gateway Management API, indicating the Connection Id where you need to send your message to and your API url.  You can use the aws sdk to do this, you can use the postToConnection method in the AmazonApiGatewayManagementApiClient class.
Please check 
* https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/apigatewaymanagementapi/AmazonApiGatewayManagementApiClient.html
* Documentation of management API, includes an example using python, https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-how-to-call-websocket-api-connections.html

Answer

Hi,
You could enable 2-way communication on API Gateway websocket to send the response back to client. 
After 2-way communication is enabled,
- For proxy integrations, API Gateway automatically passes the backend output to the caller as the complete payload. There is no integration response.
- For non-proxy integrations, you must set up at least one integration response:

Kindly [refer this doc](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-integration-responses.html#apigateway-websocket-api-integration-response-overview) for more details.

Additionally, you could also use "postToConnection" as explained in [post](https://repost.aws/questions/QUvgqfnwBkS22EnkRG__vkAg/how-can-i-send-a-response-body-back-to-a-client-from-an-aws-lambda-function-through-api-gateway-websocket#ANHI8s5BAoS4WfKthAIBI8Rg), However this requires additional code to be written on the integration side to Post the message back to client

How can I send a response body back to a client from an AWS Lambda function through API Gateway WebSocket

関連するコンテンツ