Class ListRoomsCommandProtected

Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.

Example

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

import { IvschatClient, ListRoomsCommand } from "@aws-sdk/client-ivschat"; // ES Modules import
// const { IvschatClient, ListRoomsCommand } = require("@aws-sdk/client-ivschat"); // CommonJS import
const client = new IvschatClient(config);
const input = { // ListRoomsRequest
  name: "STRING_VALUE",
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
  messageReviewHandlerUri: "STRING_VALUE",
  loggingConfigurationIdentifier: "STRING_VALUE",
};
const command = new ListRoomsCommand(input);
const response = await client.send(command);
// { // ListRoomsResponse
//   rooms: [ // RoomList // required
//     { // RoomSummary
//       arn: "STRING_VALUE",
//       id: "STRING_VALUE",
//       name: "STRING_VALUE",
//       messageReviewHandler: { // MessageReviewHandler
//         uri: "STRING_VALUE",
//         fallbackResult: "STRING_VALUE",
//       },
//       createTime: new Date("TIMESTAMP"),
//       updateTime: new Date("TIMESTAMP"),
//       tags: { // Tags
//         "<keys>": "STRING_VALUE",
//       },
//       loggingConfigurationIdentifiers: [ // LoggingConfigurationIdentifierList
//         "STRING_VALUE",
//       ],
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

Param

ListRoomsCommandInput

Returns

ListRoomsCommandOutput

See

• ListRoomsCommandInput for command's input shape.
• ListRoomsCommandOutput for command's response shape.
• config for IvschatClient's config shape.

Throws

AccessDeniedException (client fault)

Throws

ResourceNotFoundException (client fault)

Throws

ValidationException (client fault)

Throws

IvschatServiceException

Base exception class for all service exceptions from Ivschat service.