Skip to content

ListRoomsRequest

Source code in docs_src/capo_ivschat/types/list_rooms_request.py
class ListRoomsRequest(TypedDict, closed=True):
    name: NotRequired["capo_ivschat.types.room_name.RoomName"]
    """<p>Filters the list to match the specified room name.</p>"""
    next_token: NotRequired["capo_ivschat.types.pagination_token.PaginationToken"]
    """<p>The first room to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>"""
    max_results: NotRequired["capo_ivschat.types.max_room_results.MaxRoomResults"]
    """<p>Maximum number of rooms to return. Default: 50.</p>"""
    message_review_handler_uri: NotRequired["capo_ivschat.types.lambda_arn.LambdaArn"]
    """<p>Filters the list to match the specified message review handler URI.</p>"""
    logging_configuration_identifier: NotRequired[
        "capo_ivschat.types.logging_configuration_identifier.LoggingConfigurationIdentifier"
    ]
    """<p>Logging-configuration identifier.</p>"""

logging_configuration_identifier instance-attribute

logging_configuration_identifier: NotRequired[LoggingConfigurationIdentifier]

Logging-configuration identifier.

max_results instance-attribute

max_results: NotRequired[MaxRoomResults]

Maximum number of rooms to return. Default: 50.

message_review_handler_uri instance-attribute

message_review_handler_uri: NotRequired[LambdaArn]

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

name instance-attribute

name: NotRequired[RoomName]

Filters the list to match the specified room name.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

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