Skip to content

Create Room

ivschat_create_room R Documentation

Creates a room that allows clients to connect and pass messages

Description

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

Usage

ivschat_create_room(name, maximumMessageRatePerSecond,
  maximumMessageLength, messageReviewHandler, tags,
  loggingConfigurationIdentifiers)

Arguments

name

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

maximumMessageRatePerSecond

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

maximumMessageLength

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.

messageReviewHandler

Configuration information for optional review of messages.

tags

Tags to attach to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS Chat has no constraints beyond what is documented there.

loggingConfigurationIdentifiers

Array of logging-configuration identifiers attached to the room.

Value

A list with the following syntax: 

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

Request syntax

svc$create_room(
  name = "string",
  maximumMessageRatePerSecond = 123,
  maximumMessageLength = 123,
  messageReviewHandler = list(
    uri = "string",
    fallbackResult = "ALLOW"|"DENY"
  ),
  tags = list(
    "string"
  ),
  loggingConfigurationIdentifiers = list(
    "string"
  )
)