Table of Contents
A low-level client representing 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 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.
client = session.create_client('apigatewaymanagementapi')
These are the available methods:
Check if an operation can be paginated.
Delete the connection with the provided id.
See also: AWS API Documentation
Request Syntax
response = client.delete_connection(
ConnectionId='string'
)
Exceptions
Get information about the connection with the provided id.
See also: AWS API Documentation
Request Syntax
response = client.get_connection(
ConnectionId='string'
)
{
'ConnectedAt': datetime(2015, 1, 1),
'Identity': {
'SourceIp': 'string',
'UserAgent': 'string'
},
'LastActiveAt': datetime(2015, 1, 1)
}
Response Structure
The time in ISO 8601 format for when the connection was established.
The source IP address of the TCP connection making the request to API Gateway.
The User Agent of the API caller.
The time in ISO 8601 format for when the connection was last active.
Exceptions
Create a paginator for an operation.
Returns an object that can wait for some condition.
Sends the provided data to the specified connection.
See also: AWS API Documentation
Request Syntax
response = client.post_to_connection(
Data=b'bytes'|file,
ConnectionId='string'
)
[REQUIRED]
The data to be sent to the client specified by its connection id.
[REQUIRED]
The identifier of the connection that a specific client is using.
None
Exceptions
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
The caller is not authorized to invoke this operation.
Example
try:
...
except client.exceptions.ForbiddenException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) --
The caller is not authorized to invoke this operation.
The connection with the provided id no longer exists.
Example
try:
...
except client.exceptions.GoneException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) --
The connection with the provided id no longer exists.
The data has exceeded the maximum size allowed.
Example
try:
...
except client.exceptions.PayloadTooLargeException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{
'Message': 'string',
'Error': {
'Code': 'string',
'Message': 'string'
}
}
Structure
(dict) --
The data has exceeded the maximum size allowed.
The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
Example
try:
...
except client.exceptions.LimitExceededException as e:
print(e.response)
The parsed error response. All exceptions have a top level Error key that provides normalized access to common exception atrributes. All other keys are specific to this service or exception class.
Syntax
{}
Structure
(dict) --
The client is sending more than the allowed number of requests per unit of time or the WebSocket client side buffer is full.
The available paginators are: