@aws-lite/apigatewaymanagementapi
v0.0.10
Published
Official `aws-lite` plugin for API Gateway WebSocket Management API
Downloads
2,171
Readme
@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
Properties:
ConnectionId
(string) [required]- WebSocket connection ID
ApiUrl
(string)- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
andStage
; example:wss://abc123.execute-api.us-west-1.amazonaws.com/$default
- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
(string)- API Gateway ID
Stage
(string)- API Gateway stage; example:
$default
- API Gateway stage; example:
Data
(string, object)- Data to send to WebSocket client
DeleteConnection
Properties:
ConnectionId
(string) [required]- WebSocket connection ID
ApiUrl
(string)- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
andStage
; example:wss://abc123.execute-api.us-west-1.amazonaws.com/$default
- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
(string)- API Gateway ID
Stage
(string)- API Gateway stage; example:
$default
- API Gateway stage; example:
GetConnection
Properties:
ConnectionId
(string) [required]- WebSocket connection ID
ApiUrl
(string)- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
andStage
; example:wss://abc123.execute-api.us-west-1.amazonaws.com/$default
- Full API Gateway WebSocket URL, including stage; if using this, do not use
ApiId
(string)- API Gateway ID
Stage
(string)- API Gateway stage; example:
$default
- API Gateway stage; example: