- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteRoomCommand
Deletes the specified room.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IvschatClient, DeleteRoomCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, DeleteRoomCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const input = { // DeleteRoomRequest
identifier: "STRING_VALUE", // required
};
const command = new DeleteRoomCommand(input);
const response = await client.send(command);
// {};
DeleteRoomCommand Input
See DeleteRoomCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
identifier Required | string | undefined | Identifier of the room to be deleted. Currently this must be an ARN. |
DeleteRoomCommand Output
See DeleteRoomCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | <p/> |
PendingVerification | client | <p/> |
ResourceNotFoundException | client | <p/> |
ValidationException | client | <p/> |
IvschatServiceException | Base exception class for all service exceptions from Ivschat service. |