AWS AmazonApiGatewayManagementApi
Browse all Amazonaws APIs60
AI ReadinessAI-Aware (B-)60/100
Agent-ready OpenAPI document · curated by JenticCommunicationsChat MessagingapiKey3 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Send messages to and disconnect specific WebSocket clients connected to an API Gateway WebSocket API, plus fetch connection metadata, via three @connections operations.
Use for: I want to send a message to a specific WebSocket connection, Get the metadata for a connected WebSocket client, Disconnect a misbehaving WebSocket client, Push a real-time event to a single user via WebSocket
Not supported: Does not handle creating or deploying WebSocket APIs, defining routes, or configuring authorisers - use for sending messages to and managing live WebSocket connections only.
Jentic publishes the only available OpenAPI specification for the API Gateway Management API, keeping it validated and agent-ready. The Amazon API Gateway Management API is the runtime companion to API Gateway WebSocket APIs. It exposes three operations on the @connections resource that let backends send messages to a connected WebSocket client, inspect connection metadata, and force a disconnect. Real-time chat services, live dashboards, and collaborative apps use it to push server-initiated messages to clients without client polling.
Install Jentic One Beta
Connect the AmazonApiGatewayManagementApi to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AmazonApiGatewayManagementApi, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Fapigatewaymanagementapi" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Fapigatewaymanagementapi" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with AmazonApiGatewayManagementApi API.
Send a server-initiated message to a specific WebSocket connection by connection id
Inspect the source ip, identity, and last active timestamp for a connected WebSocket client
Force-disconnect a specific WebSocket client from a deployed API
Drive fan-out patterns by iterating over stored connection ids and posting to each one
Pair with Lambda backends to deliver server-side push without long polling on the client
Use Cases
Patterns agents use AmazonApiGatewayManagementApi API for, with concrete tasks.
★ Real-Time Chat Message Delivery
Real-time chat services use API Gateway WebSocket APIs to keep persistent client connections, store the resulting connectionId values when clients join a room, then call POST @connections/{connectionId} with the message payload as bytes when a peer sends a chat message. The endpoint targets the deployed API's invoke URL and lets the backend deliver server-initiated messages without long polling.
Call POST /@connections/{connectionId} on the deployed API's invoke URL with a JSON body containing the chat message
Connection Hygiene and Disconnection
Backends managing WebSocket connections use GET /@connections/{connectionId} to confirm a stored connection is still active before attempting to send to it, and DELETE /@connections/{connectionId} to disconnect clients that exceed quota or violate policy. Combining a GoneException response on send with cleanup of stale connection ids in DynamoDB keeps the connection table consistent.
Call GET /@connections/{connectionId} to confirm the connection is active, otherwise remove the stored connection id from the connections table
Live Dashboard Push Notifications
Live dashboard backends fan out a single update to many connected clients by storing their connectionId values in DynamoDB and iterating with POST /@connections/{connectionId} per client. The Lambda backend handles individual GoneException responses by deleting stale ids, so dashboards stay current even as users navigate away and reconnect.
Iterate over the connection ids stored in DynamoDB and call POST /@connections/{connectionId} for each, deleting any id that returns 410 Gone
AI Agent WebSocket Notifier
An AI agent invoked through Jentic notifies a specific user over a WebSocket when a long-running task finishes. The agent retrieves the user's connectionId from a backing store, searches Jentic for the post-to-connection operation, and executes it with the message payload. Jentic handles the SigV4 signing required by the @connections endpoint, so the agent only deals with the structured payload.
Search Jentic for post message to websocket connection, execute it for the stored connectionId, and handle GoneException by removing the connection id from the store
Key Endpoints
3 endpoints — jentic publishes the only available openapi specification for the api gateway management api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/@connections/{connectionId}
Send a message to a specific connected WebSocket client
GET
/@connections/{connectionId}
Retrieve metadata about a connected WebSocket client
DELETE
/@connections/{connectionId}
Force-disconnect a specific WebSocket client
POST
/@connections/{connectionId}
Send a message to a specific connected WebSocket client
GET
/@connections/{connectionId}
Retrieve metadata about a connected WebSocket client
DELETE
/@connections/{connectionId}
Force-disconnect a specific WebSocket client
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
AmazonApiGatewayManagementApi
- AI-Aware (B-)60/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility37
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
37
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
47%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the API Gateway Management API by hand means signing every request with AWS Signature Version 4 and constructing the deployed WebSocket API's execute-api.{region}.amazonaws.com invoke URL yourself. Through Jentic you install once, import AmazonApiGatewayManagementApi from the API Directory, store your AWS access key and secret once, and your agent calls it.
Permission scoping
This API puts the connection id in the URL path (/@connections/{connectionId}), so a rule can pin the agent to messaging a specific WebSocket connection. You choose the operations it may call, so the force-disconnect at DELETE /@connections/{connectionId} is not included unless you add it, leaving the agent to POST messages and GET connection metadata.
Credential isolation
Your AWS access key and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'post a message to a WebSocket connection' or 'disconnect a WebSocket client', and Jentic returns the matching @connections operation with its input schema so the agent does not have to construct the deployed API's invoke URL by hand.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using AmazonApiGatewayManagementApi API through Jentic.
Why is there no official OpenAPI spec for the API Gateway Management API?
AWS does not publish an OpenAPI specification for the API Gateway Management API; the official surface is the AWS SDKs and the Smithy model. Jentic generates and maintains this spec so that AI agents and developers can call AmazonApiGatewayManagementApi via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the API Gateway Management API use?
The API uses AWS Signature Version 4 (SigV4) signed with an IAM access key id and secret access key, optionally with an STS session token. Through Jentic these credentials are stored encrypted in the vault and SigV4 signing is performed server side, so the agent never sees the raw secret access key.
Can I broadcast a single message to all WebSocket connections with the API Gateway Management API?
No. The API operates per connection only. To broadcast, the backend must store every active connectionId (typically in DynamoDB) and iterate, calling POST /@connections/{connectionId} for each. Connections that return 410 Gone should be removed from the store.
What are the rate limits for the API Gateway Management API?
Throttling on the API Gateway Management API is governed by the deployed WebSocket API's per-account and per-stage limits. Sustained high-volume fan-out can hit the per-second message rate of the underlying API; back off on ThrottlingException and consider sharding fan-out across Lambda invocations.
How do I send a WebSocket message with the API Gateway Management API through Jentic?
Install the SDK with pip install jentic, search Jentic for post message to websocket connection, load the PostToConnection operation schema, and execute it with the connectionId and message payload. Jentic handles SigV4 signing against the deployed API's invoke URL and returns success or GoneException.
How do I get the invoke URL my backend needs to call?
The endpoint is of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or the custom domain configured on the WebSocket API stage. The base URL is the same one your client connects to, with the wss:// scheme replaced by https:// - your backend must explicitly target this endpoint when calling @connections.
Can I limit what my agent is allowed to do with the API Gateway Management API?
Yes. Jentic One is self-hosted, so your own rules decide which of the three @connections operations the agent may call and which AWS credentials it may use. Because the connection id lives in the URL path (/@connections/{connectionId}), a rule can pin the agent to a specific WebSocket connection, and you can grant only POST for sending messages and GET for reading connection metadata while withholding DELETE so the agent cannot force-disconnect clients. The operator chooses each operation explicitly, and anything you do not add stays out of the agent's reach.
GET STARTED