Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class CreateRoomCommandProtected

Creates a room that allows clients to connect and pass messages.

Example

Use a bare-bones client and the command you need to make an API call.

import { IvschatClient, CreateRoomCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, CreateRoomCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const input = { // CreateRoomRequest
name: "STRING_VALUE",
maximumMessageRatePerSecond: Number("int"),
maximumMessageLength: Number("int"),
messageReviewHandler: { // MessageReviewHandler
uri: "STRING_VALUE",
fallbackResult: "STRING_VALUE",
},
tags: { // Tags
"<keys>": "STRING_VALUE",
},
loggingConfigurationIdentifiers: [ // LoggingConfigurationIdentifierList
"STRING_VALUE",
],
};
const command = new CreateRoomCommand(input);
const response = await client.send(command);
// { // CreateRoomResponse
// arn: "STRING_VALUE",
// id: "STRING_VALUE",
// name: "STRING_VALUE",
// createTime: new Date("TIMESTAMP"),
// updateTime: new Date("TIMESTAMP"),
// maximumMessageRatePerSecond: Number("int"),
// maximumMessageLength: Number("int"),
// messageReviewHandler: { // MessageReviewHandler
// uri: "STRING_VALUE",
// fallbackResult: "STRING_VALUE",
// },
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// loggingConfigurationIdentifiers: [ // LoggingConfigurationIdentifierList
// "STRING_VALUE",
// ],
// };

Param

CreateRoomCommandInput

Returns

CreateRoomCommandOutput

See

Throws

AccessDeniedException (client fault)

Throws

ConflictException (client fault)

Throws

PendingVerification (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ServiceQuotaExceededException (client fault)

Throws

ValidationException (client fault)

Throws

IvschatServiceException

Base exception class for all service exceptions from Ivschat service.

Hierarchy

Constructors

Properties

middlewareStack: MiddlewareStack<CreateRoomCommandInput, CreateRoomCommandOutput>

Methods