@aws-lite/apigatewaymanagementapi

Official aws-lite plugin for API Gateway WebSocket Management API

Maintained by: @architect

Install

npm i @aws-lite/apigatewaymanagementapi

Optionally install types:

npm i -D @aws-lite/apigatewaymanagementapi-types

Reference

Reference documentation with examples at aws-lite.org

Methods

PostToConnection

Canonical AWS API doc

Properties:

• ConnectionId (string) [required]
  • WebSocket connection ID
• ApiUrl (string)
  • Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
• ApiId (string)
  • API Gateway ID
• Stage (string)
  • API Gateway stage; example: $default
• Data (string, object)
  • Data to send to WebSocket client

DeleteConnection

Canonical AWS API doc

Properties:

• ConnectionId (string) [required]
  • WebSocket connection ID
• ApiUrl (string)
  • Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
• ApiId (string)
  • API Gateway ID
• Stage (string)
  • API Gateway stage; example: $default

GetConnection

Canonical AWS API doc

Properties:

• ConnectionId (string) [required]
  • WebSocket connection ID
• ApiUrl (string)
  • Full API Gateway WebSocket URL, including stage; if using this, do not use ApiId and Stage; example: wss://abc123.execute-api.us-west-1.amazonaws.com/$default
• ApiId (string)
  • API Gateway ID
• Stage (string)
  • API Gateway stage; example: $default

Learn more

• More information about the aws-lite plugin API
• Learn about contributing to this and other aws-lite plugins