-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ApiGatewayManagementApi Documentation Improvement #1914
Comments
id just like to bump this as it caused me a lot of issues since the documentation is so unclear. |
As I can see the documentation hasn't been updated yet. Any reason why? |
This caused me 2 days of pain. Would be a great idea if we can update this in the docs |
THIS IS NEEDED IN THE DOCS! |
Grrhh! THis has just caused me a lot of pain.. Please Pelase update the docs! |
This still to this date is creating confusion on documentation and led me to this thread |
Now the documentation is updated with the correct information on how to use endpoint.
Let us know if anyone has still any questions. |
@swetashre I think that including the
|
Agreed with @dixler, if it is a must it should be written in the client initiation code. Thanks for making it clear of what is confusing us! Just like the methods that each has a "Parameters" section, the client could have one also, stating which parameters are possible. |
The top level client documentation has a call out that the client request additional configuration for the endpoint. That being said this documentation comes from the service and thus does not include |
Thanks all for the feedback here. As mentioned in this comment the documentation was updated to note the endpoint requirement:
I don’t think the PR linked above can be accepted because it only references that first endpoint format, even though the URL could also correspond to a custom path as mentioned above. (Also those changes in the PR involve a hardcoded condition and would be inconsistent with the other pages.) And to reiterate what was mentioned in the comment above, the client documentation comes from the API Gateway Management API service and can’t contain boto3-specific code because it is used across SDKs. |
|
Documentation should specify that the endpoint argument of client object has to be set manually to
https://{api-id}.execute-api.{region}.amazonaws.com/{stage}
, or otherwise thepost_to_connection
function will timeout and do nothing, or cause an internal error.Example:
This will save a lot of time and nerve for people developing API gateway web socket integrations
The text was updated successfully, but these errors were encountered: