JSPM

@aws-lite/apigatewaymanagementapi

0.0.10
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 581
  • Score
    100M100P100Q109101F
  • License Apache-2.0

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

Package Exports

  • @aws-lite/apigatewaymanagementapi
  • @aws-lite/apigatewaymanagementapi/src/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-lite/apigatewaymanagementapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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

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