We are excited to announce our new API Documentation.
Protected
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
Use a bare-bones client and the command you need to make an API call.
import { IvschatClient, DisconnectUserCommand } from "@aws-sdk/client-ivschat"; // ES Modules import// const { IvschatClient, DisconnectUserCommand } = require("@aws-sdk/client-ivschat"); // CommonJS importconst client = new IvschatClient(config);const input = { // DisconnectUserRequest roomIdentifier: "STRING_VALUE", // required userId: "STRING_VALUE", // required reason: "STRING_VALUE",};const command = new DisconnectUserCommand(input);const response = await client.send(command);// {};
DisconnectUserCommandInput
DisconnectUserCommandOutput
input
response
config
AccessDeniedException (client fault)
PendingVerification (client fault)
ResourceNotFoundException (client fault)
ThrottlingException (client fault)
ValidationException (client fault)
IvschatServiceException
Base exception class for all service exceptions from Ivschat service.
Readonly
Static
Disconnects all connections using a specified user ID from a room. This replicates the DisconnectUser WebSocket operation in the Amazon IVS Chat Messaging API.
Example
Use a bare-bones client and the command you need to make an API call.
Param
DisconnectUserCommandInput
Returns
DisconnectUserCommandOutput
See
input
shape.response
shape.config
shape.Throws
AccessDeniedException (client fault)
Throws
PendingVerification (client fault)
Throws
ResourceNotFoundException (client fault)
Throws
ThrottlingException (client fault)
Throws
ValidationException (client fault)
Throws
IvschatServiceException
Base exception class for all service exceptions from Ivschat service.