Skip to content
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

Open
JustasBelevicius opened this issue Mar 22, 2019 · 2 comments
Labels

Comments

@JustasBelevicius
Copy link

@JustasBelevicius JustasBelevicius commented Mar 22, 2019

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 the post_to_connection function will timeout and do nothing, or cause an internal error.

Example:

# from
client = boto3.client('apigatewaymanagementapi')
# to
client = boto3.client('apigatewaymanagementapi', endpoint_url='https://{api-id}.execute-api.{region}.amazonaws.com/{stage}')

This will save a lot of time and nerve for people developing API gateway web socket integrations

@wulfmann

This comment has been minimized.

Copy link

@wulfmann wulfmann commented Jul 21, 2019

id just like to bump this as it caused me a lot of issues since the documentation is so unclear.

@JustasBelevicius

This comment has been minimized.

Copy link
Author

@JustasBelevicius JustasBelevicius commented Aug 20, 2019

As I can see the documentation hasn't been updated yet. Any reason why?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.