Provides a boto3 client class by the same name with a disconnect method for disconnecting websocket clients
Project description
Provides a boto3 client class by the same name with a disconnect method for disconnecting websocket clients.
The boto3 client for managing API Gateway connected websockets provides a mechanism for posting data back to a client, but does not provide a mechanism for forcing the disconnect of a client. It is left up to the developer to build a signature version 4 authentication and make the DELETE call themselves.
This package creates a boto3 client class called apigatewaydisconnectapi that supports disconnecting a client. The client object is created in the same way that the apigatewaymanagementapi is created.
class ApiGatewayDisconnectApi.Client
A low-level client representing ApiGatewayDisconnectApi
import apigatewaydisconnectapi import boto3 client = boto3.client('apigatewaydisconnectapi')
- disconnect(**kwargs)
Disconnects the specified connection
Request Syntax
response = client.disconnect( ConnectionId='string' )
Parameters
ConnectionId (string) –
[REQUIRED]
The identifier of the connection that a specific client is using.
Returns
None
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for apigatewaydisconnectapi-0.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b68efa1cdf02d34f011bc4866fcbea402ca1ea631ec1343bbae04e45e3d9148e |
|
MD5 | 9375563e81c10244c686802b1af8fc5d |
|
BLAKE2b-256 | 04d10b39f82e756c7c0efc800357365847c448a73bab9fec3dbcff70572eb492 |
Hashes for apigatewaydisconnectapi-0.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b52480070bef17547346b926f7bb69fdd8be95b2173230dca8f5445674ea727a |
|
MD5 | 475cd6a9c428a70f3d0414cdcbe781ee |
|
BLAKE2b-256 | 0b8197d7436881263dabea24ca382ba7f76d2334870ca4e2e0db49cc77a392bf |