AWS WebSocket API Gateway Template Selection Expressions examples

user_788657 0
Viewed 1725

AWS API Gateway service page says that a Template Selection Expression can be used to implement a way to transform the request body. However the documentation for these selection expressions is very light and I haven't been able to find any examples.

  1. Where can I find examples of what these expressions look like?
  2. Where can I find what variables and options are available in these expressions?
aws-api-gateway websocket
2 Answers

To add content to the integration request, you'll need to use a Request Template. The Request Template is the piece that actually generates the new request body, while the Request Selection Template is used in the process of determining which Request Template to use.

  1. Turn off HTTP Proxy Integration for your route. (You can't modify the request otherwise.)
  2. Save your changes. (the Request Templates section won't appear until you do so.)
  3. Set your Template Selection Expression. This is used to look up a value from the incoming request object. (If you want to match all incoming requests, enter \$default. Note the slash. Full documentation here.)
  4. Set your Template Key. This is compared against the value selected by the Template Selection Expression. If it's a match, the template is used. (If you want to match all incoming requests, enter $default. Note the absence of a slash.)
  5. Click your Template Key to open the template editor. This is where you enter your template that will be sent to your integration endpoint as the body of the request. For example, if you want to forward the connection ID and the incoming query parameters to the integration endpoint, you can use the following:
{
    "myConnectionIdProperty": "$context.connectionId",
    "myQueryParams": $input.params()
}

Documentation for variables available to you in the template expression can be found here.

(Note that while $request is a valid variable in the Template Selection Expression, it is not a valid variable in the template itself. Use $input instead there.)

user_117252560

Basically Template Selection Expression works same as Route Selection Expression. All examples for Route Selection Expression will work. https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-route-selection-expressions

In addition to it, TemplateSelectionExpression for integration response supports few more variables:

  • $integration.response.statuscode
  • $integration.response.header.headerName
  • $integration.response.multivalueheader.headerName
user_87978960
Related