Skip to content

CreateRoomRequest

Source code in docs_src/capo_ivschat/types/create_room_request.py
class CreateRoomRequest(TypedDict, closed=True):
    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>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.</p>"""
    tags: NotRequired["capo_ivschat.types.tags.Tags"]
    """<p>Tags to attach to the resource. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> 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.</p>"""
    logging_configuration_identifiers: NotRequired[
        "capo_ivschat.types.logging_configuration_identifier_list.LoggingConfigurationIdentifierList"
    ]
    """<p>Array of logging-configuration identifiers attached to the room.</p>"""

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]

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.

name instance-attribute

name: NotRequired[RoomName]

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

tags instance-attribute

tags: NotRequired[Tags]

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.