AsyncAPI channel · Amazon API Gateway · Amazon API Gateway WebSocket API

@connections/{connectionId}

The @connections endpoint allows backend services to send messages to specific connected clients, retrieve connection information, or disconnect clients. This is accessed via HTTPS POST, GET, or DELETE from the backend.

Open source AsyncAPI → All Amazon API Gateway channels Amazon API Gateway provider profile
Provider: Amazon API Gateway AsyncAPI: v3.0.0 Spec: Amazon API Gateway WebSocket API Operations: 2 Messages: 2

Channel address

@connections/{connectionId}

Parameters

Operations

send
sendToClient
Sends a message to a specific connected WebSocket client using the @connections management API. The backend service posts the message payload to the connection-specific URL.
receive
getConnectionStatus
Retrieves information about a specific WebSocket connection including the connected date, identity, and last active date.

Messages

PostToConnectionMessage
A message sent from the backend to a specific connected WebSocket client via the @connections management API.
Content-Type: application/json
ConnectionStatusResponse
Connection information returned when querying the @connections management endpoint for a specific connection ID.
Content-Type: application/json

About AsyncAPI

The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.

Browse every event-driven channel on the APIs.io network or compare with the broader Agent Skill and MCP server surfaces of the same providers.