create_room
¶
create_room(
*,
config_overrides: Optional[ivschatClientConfig] = None,
name: Optional[RoomName] = None,
maximum_message_rate_per_second: Optional[RoomMaxMessageRatePerSecond] = None,
maximum_message_length: Optional[RoomMaxMessageLength] = None,
message_review_handler: Optional[MessageReviewHandler] = None,
tags: Optional[Tags] = None,
logging_configuration_identifiers: Optional[
LoggingConfigurationIdentifierList
] = None,
) -> CreateRoomResponse
Creates a room that allows clients to connect and pass messages.
Parameters:
-
name(Optional[RoomName], default:None) –Room name. The value does not need to be unique.
-
maximum_message_rate_per_second(Optional[RoomMaxMessageRatePerSecond], default:None) –Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.
-
maximum_message_length(Optional[RoomMaxMessageLength], default:None) –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.
-
message_review_handler(Optional[MessageReviewHandler], default:None) –Configuration information for optional review of messages.
-
tags(Optional[Tags], default:None) –Tags to attach to the resource. Array of maps, each of the form
string:string (key:value). See Best practices and strategies in Tagging Amazon Web Services Resources and Tag Editor 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. -
logging_configuration_identifiers(Optional[LoggingConfigurationIdentifierList], default:None) –Array of logging-configuration identifiers attached to the room.
Raises:
-
AccessDeniedException– -
ConflictException– -
PendingVerification– -
ResourceNotFoundException– -
ServiceQuotaExceededException– -
ValidationException– -
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_ivschat/_services/ivschat.py
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 | |