Skip to content

UpdateRoomRequest

Source code in docs_src/capo_ivschat/types/update_room_request.py
class UpdateRoomRequest(TypedDict, closed=True):
    identifier: "capo_ivschat.types.room_identifier.RoomIdentifier"
    """<p>Identifier of the room to be updated. Currently this must be an ARN.</p>"""
    name: NotRequired["capo_ivschat.types.room_name.RoomName"]
    """<p>Room name. The value does not need to be unique.</p>"""
    maximum_message_rate_per_second: NotRequired[
        "capo_ivschat.types.room_max_message_rate_per_second.RoomMaxMessageRatePerSecond"
    ]
    """<p>Maximum number of messages per second that can be sent to the room (by all clients). Default: 10.</p>"""
    maximum_message_length: NotRequired[
        "capo_ivschat.types.room_max_message_length.RoomMaxMessageLength"
    ]
    """<p>The 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.</p>"""
    message_review_handler: NotRequired[
        "capo_ivschat.types.message_review_handler.MessageReviewHandler"
    ]
    """<p>Configuration information for optional review of messages. Specify an empty <code>uri</code> string to disassociate a message review handler from the specified room.</p>"""
    logging_configuration_identifiers: NotRequired[
        "capo_ivschat.types.logging_configuration_identifier_list.LoggingConfigurationIdentifierList"
    ]
    """<p>Array of logging-configuration identifiers attached to the room.</p>"""

identifier instance-attribute

identifier: RoomIdentifier

Identifier of the room to be updated. Currently this must be an ARN.

logging_configuration_identifiers instance-attribute

logging_configuration_identifiers: NotRequired[LoggingConfigurationIdentifierList]

Array of logging-configuration identifiers attached to the room.

maximum_message_length instance-attribute

maximum_message_length: NotRequired[RoomMaxMessageLength]

The 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.

maximum_message_rate_per_second instance-attribute

maximum_message_rate_per_second: NotRequired[RoomMaxMessageRatePerSecond]

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

message_review_handler instance-attribute

message_review_handler: NotRequired[MessageReviewHandler]

Configuration information for optional review of messages. Specify an empty uri string to disassociate a message review handler from the specified room.

name instance-attribute

name: NotRequired[RoomName]

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