Skip to content

Gets summary information about all your rooms in the AWS region where the API request is processed

Description

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.

Usage

ivschat_list_rooms(name, nextToken, maxResults, messageReviewHandlerUri,
  loggingConfigurationIdentifier)

Arguments

  • name

    Filters the list to match the specified room name.

  • nextToken

    The first room to retrieve. This is used for pagination; see the nextToken response field.

  • maxResults

    Maximum number of rooms to return. Default: 50.

  • messageReviewHandlerUri

    Filters the list to match the specified message review handler URI.

  • loggingConfigurationIdentifier

    Logging-configuration identifier.

Value

A list with the following syntax:

list(
  rooms = list(
    list(
      arn = "string",
      id = "string",
      name = "string",
      messageReviewHandler = list(
        uri = "string",
        fallbackResult = "ALLOW"|"DENY"
      ),
      createTime = as.POSIXct(
        "2015-01-01"
      ),
      updateTime = as.POSIXct(
        "2015-01-01"
      ),
      tags = list(
        "string"
      ),
      loggingConfigurationIdentifiers = list(
        "string"
      )
    )
  ),
  nextToken = "string"
)

Request syntax

svc$list_rooms(
  name = "string",
  nextToken = "string",
  maxResults = 123,
  messageReviewHandlerUri = "string",
  loggingConfigurationIdentifier = "string"
)