Socket
Socket
Sign inDemoInstall

@aws-lite/apigatewaymanagementapi

Package Overview
Dependencies
0
Maintainers
3
Versions
9
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @aws-lite/apigatewaymanagementapi

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


Version published
Maintainers
3
Install size
6.28 kB
Created

Readme

Source

@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

FAQs

Last updated on 06 Feb 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc