Class DisconnectUserCommandProtected

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.

import { IvschatClient, DisconnectUserCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, DisconnectUserCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const command = new DisconnectUserCommand(input);
const response = await client.send(command);

See

• DisconnectUserCommandInput for command's input shape.
• DisconnectUserCommandOutput for command's response shape.
• config for IvschatClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

PendingVerification (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ThrottlingException (client fault)

Throws

ValidationException (client fault)