Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for apigatewaydisconnectapi, version 0.0.1
Filename, size File type Python version Upload date Hashes
Filename, size apigatewaydisconnectapi-0.0.1-py2.py3-none-any.whl (7.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size apigatewaydisconnectapi-0.0.1.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page