@aws-lite/apigatewaymanagementapi

> Official aws-lite plugin for API Gateway WebSocket Management API

> Maintained by: @architect

Install

``sh
npm i @aws-lite/apigatewaymanagementapi
`

Optionally install types:

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

Reference

Reference documentation with examples at aws-lite.org

Methods

$3

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

$3

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

$3

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