ApiGatewayManagementApi Documentation Improvement

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]

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

[dixler]

@swetashre I think that including the endpoint_url optional parameter to the client constructor in the documentation might be more easily skimmable and more clear given it seems like it’s necessary for a good number of people from the likes and very vibrant comments.

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