@aws-sdk/client-apigatewaymanagementapi

What is @aws-sdk/client-apigatewaymanagementapi?

@aws-sdk/client-apigatewaymanagementapi is a part of the AWS SDK for JavaScript. It allows developers to interact with the Amazon API Gateway Management API, which is used to send messages to connected clients in a WebSocket-based API Gateway.

What are @aws-sdk/client-apigatewaymanagementapi's main functionalities?

PostToConnection

This feature allows you to send a message to a specific connection in a WebSocket-based API Gateway. The code sample demonstrates how to use the PostToConnectionCommand to send a message to a client identified by a connection ID.

const { ApiGatewayManagementApiClient, PostToConnectionCommand } = require('@aws-sdk/client-apigatewaymanagementapi');

const client = new ApiGatewayManagementApiClient({ region: 'us-west-2' });

const params = {
  ConnectionId: 'abc123',
  Data: Buffer.from('Hello, World!')
};

const command = new PostToConnectionCommand(params);

client.send(command).then(
  (data) => {
    console.log('Message sent:', data);
  },
  (error) => {
    console.error('Error:', error);
  }
);

DeleteConnection

This feature allows you to delete a specific connection in a WebSocket-based API Gateway. The code sample demonstrates how to use the DeleteConnectionCommand to delete a client connection identified by a connection ID.

const { ApiGatewayManagementApiClient, DeleteConnectionCommand } = require('@aws-sdk/client-apigatewaymanagementapi');

const client = new ApiGatewayManagementApiClient({ region: 'us-west-2' });

const params = {
  ConnectionId: 'abc123'
};

const command = new DeleteConnectionCommand(params);

client.send(command).then(
  (data) => {
    console.log('Connection deleted:', data);
  },
  (error) => {
    console.error('Error:', error);
  }
);

Other packages similar to @aws-sdk/client-apigatewaymanagementapi

socket.io

Socket.IO is a library that enables real-time, bidirectional and event-based communication between web clients and servers. Unlike @aws-sdk/client-apigatewaymanagementapi, which is specific to AWS API Gateway, Socket.IO can be used with any server and provides more general WebSocket functionalities.

ws

The 'ws' package is a simple to use, blazing fast, and thoroughly tested WebSocket client and server for Node.js. It provides a more general WebSocket implementation compared to @aws-sdk/client-apigatewaymanagementapi, which is specifically designed for AWS API Gateway.

faye-websocket

Faye WebSocket is a standards-compliant WebSocket client and server for Node.js. It is designed to be used in any WebSocket application, providing a more general solution compared to the AWS-specific @aws-sdk/client-apigatewaymanagementapi.

README

@aws-sdk/client-apigatewaymanagementapi

For SDK usage, please step to SDK readme.