GetRoomCommand

Suggest an Edit

Gets the specified room.

Example Syntax

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

import { IvschatClient, GetRoomCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, GetRoomCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const input = { // GetRoomRequest
  identifier: "STRING_VALUE", // required
};
const command = new GetRoomCommand(input);
const response = await client.send(command);
// { // GetRoomResponse
//   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",
//   ],
// };

GetRoomCommand Input

See GetRoomCommandInput for more details

Parameter
Type
Description
identifier
Required
string | undefined

Identifier of the room for which the configuration is to be retrieved. Currently this must be an ARN.

GetRoomCommand Output

See GetRoomCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
string | undefined

Room ARN, from the request (if identifier was an ARN).

createTime
Date | undefined

Time when the room was created. This is an ISO 8601 timestamp; note that this is returned as a string.

id
string | undefined

Room ID, generated by the system. This is a relative identifier, the part of the ARN that uniquely identifies the room.

loggingConfigurationIdentifiers
string[] | undefined

Array of logging configurations attached to the room.

maximumMessageLength
number | undefined

Maximum number of characters in a single message. Messages are expected to be UTF-8 encoded and this limit applies specifically to rune/code-point count, not number of bytes. Default: 500.

maximumMessageRatePerSecond
number | undefined

Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.

messageReviewHandler
MessageReviewHandler | undefined

Configuration information for optional review of messages.

name
string | undefined

Room name. The value does not need to be unique.

tags
Record<string, string> | undefined

Tags attached to the resource. Array of maps, each of the form string:string (key:value).

updateTime
Date | undefined

Time of the room’s last update. This is an ISO 8601 timestamp; note that this is returned as a string.

Throws

Name
Fault
Details
AccessDeniedException
client
<p/>
ResourceNotFoundException
client
<p/>
ValidationException
client
<p/>
IvschatServiceException
Base exception class for all service exceptions from Ivschat service.