AmazonApiGatewayManagementApi
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…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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.
Endpoints 3
- GETGet connection
/@connections/:ConnectionIdGet information about the connection with the provided id. - POSTPost to connection
/@connections/:ConnectionIdSends the provided data to the specified connection. - DELETEDelete connection
/@connections/:ConnectionIdDelete the connection with the provided id.
API details
- Base URL
https://execute-api.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 3 operations on 1 pathGET 1POST 1DELETE 1
- Description format
- AWS Smithy model, API version
2018-11-29 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AmazonApiGatewayManagementApi in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AmazonApiGatewayManagementApi collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get connection” (GET /@connections/:ConnectionId), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AmazonApiGatewayManagementApi?
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… It is listed under Developer tools and has 3 endpoints.
Who publishes the AmazonApiGatewayManagementApi?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AmazonApiGatewayManagementApi?
Requests go to https://execute-api.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AmazonApiGatewayManagementApi?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AmazonApiGatewayManagementApi have?
3 operations on 1 path (1 GET, 1 POST, 1 DELETE).
Is forking the AmazonApiGatewayManagementApi free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.