@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

Description

AWS SDK for JavaScript ApiGatewayManagementApi Client for Node.js, Browser and React Native.

The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.

Installing

To install this package, simply type add or install @aws-sdk/client-apigatewaymanagementapi using your favorite package manager:

• npm install @aws-sdk/client-apigatewaymanagementapi
• yarn add @aws-sdk/client-apigatewaymanagementapi
• pnpm add @aws-sdk/client-apigatewaymanagementapi

Getting Started

Import

The AWS SDK is modulized by clients and commands. To send a request, you only need to import the ApiGatewayManagementApiClient and the commands you need, for example GetConnectionCommand:

// ES5 example
const { ApiGatewayManagementApiClient, GetConnectionCommand } = require("@aws-sdk/client-apigatewaymanagementapi");

// ES6+ example
import { ApiGatewayManagementApiClient, GetConnectionCommand } from "@aws-sdk/client-apigatewaymanagementapi";

Usage

To send a request, you:

• Initiate client with configuration (e.g. credentials, region).
• Initiate command with input parameters.
• Call send operation on client with command object as input.
• If you are using a custom http handler, you may call destroy() to close open connections.

// a client can be shared by different commands.
const client = new ApiGatewayManagementApiClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new GetConnectionCommand(params);

Async/await

We recommend using await operator to wait for the promise returned by send operation as follows:

// async/await.
try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

Promises

You can also use Promise chaining to execute send operation.

client.send(command).then(
  (data) => {
    // process data.
  },
  (error) => {
    // error handling.
  }
);

Promises can also be called using .catch() and .finally() as follows:

client
  .send(command)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  })
  .finally(() => {
    // finally.
  });

Callbacks

We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

// callbacks.
client.send(command, (err, data) => {
  // process err and data.
});

v2 compatible style

The client can also send requests using v2 compatible style. However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post on modular packages in AWS SDK for JavaScript

import * as AWS from "@aws-sdk/client-apigatewaymanagementapi";
const client = new AWS.ApiGatewayManagementApi({ region: "REGION" });

// async/await.
try {
  const data = await client.getConnection(params);
  // process data.
} catch (error) {
  // error handling.
}

// Promises.
client
  .getConnection(params)
  .then((data) => {
    // process data.
  })
  .catch((error) => {
    // error handling.
  });

// callbacks.
client.getConnection(params, (err, data) => {
  // process err and data.
});

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by specifying exception names:
   * if (error.name === 'SomeServiceException') {
   *     const value = error.specialKeyInException;
   * }
   */
}

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

• Visit Developer Guide or API Reference.
• Check out the blog posts tagged with aws-sdk-js on AWS Developer Blog.
• Ask a question on StackOverflow and tag it with aws-sdk-js.
• Join the AWS JavaScript community on gitter.
• If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments, visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-apigatewaymanagementapi package is updated. To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

DeleteConnection

Command API Reference / Input / Output

GetConnection

Command API Reference / Input / Output

PostToConnection

Command API Reference / Input / Output

Changelog

3.723.0 (2025-01-06)

Features

• client-iotsecuretunneling: Adds dualstack endpoint support for IoT Secure Tunneling (513f9c4)
• client-supplychain: Allow vanity DNS domain when creating a new ASC instance (0cdf2e3)
• clients: update client endpoints as of 2025-01-06 (db366a2)