Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of updateTime.
Parameters:
-
name
(Optional[RoomName], default:
None
)
–
Filters the list to match the specified room name.
-
next_token
(Optional[PaginationToken], default:
None
)
–
The first room to retrieve. This is used for pagination; see the nextToken response field.
-
max_results
(Optional[MaxRoomResults], default:
None
)
–
Maximum number of rooms to return. Default: 50.
-
message_review_handler_uri
(Optional[LambdaArn], default:
None
)
–
Filters the list to match the specified message review handler URI.
-
logging_configuration_identifier
(Optional[LoggingConfigurationIdentifier], default:
None
)
–
Logging-configuration identifier.
Raises:
Source code in docs_src/capo_ivschat/_services/ivschat.py
| def list_rooms(
self,
*,
config_overrides: Optional[ivschatClientConfig] = None,
name: Optional["capo_ivschat.types.room_name.RoomName"] = None,
next_token: Optional[
"capo_ivschat.types.pagination_token.PaginationToken"
] = None,
max_results: Optional[
"capo_ivschat.types.max_room_results.MaxRoomResults"
] = None,
message_review_handler_uri: Optional[
"capo_ivschat.types.lambda_arn.LambdaArn"
] = None,
logging_configuration_identifier: Optional[
"capo_ivschat.types.logging_configuration_identifier.LoggingConfigurationIdentifier"
] = None,
) -> "capo_ivschat.types.list_rooms_response.ListRoomsResponse":
"""<p>Gets summary information about all your rooms in the AWS region where the API request is processed. Results are sorted in descending order of <code>updateTime</code>.</p>
Args:
name: <p>Filters the list to match the specified room name.</p>
next_token: <p>The first room to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
max_results: <p>Maximum number of rooms to return. Default: 50.</p>
message_review_handler_uri: <p>Filters the list to match the specified message review handler URI.</p>
logging_configuration_identifier: <p>Logging-configuration identifier.</p>
Raises:
capo_ivschat.errors.access_denied_exception.AccessDeniedException: <p/>
capo_ivschat.errors.resource_not_found_exception.ResourceNotFoundException: <p/>
capo_ivschat.errors.validation_exception.ValidationException: <p/>
capo_ivschat.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ivschat.types.list_rooms_request.ListRoomsRequest]",
) -> OperationResponse[
"capo_ivschat.types.list_rooms_response.ListRoomsResponse"
]:
import capo_ivschat._operations.amazon_interactive_video_service_chat.list_rooms
output, http_response = (
capo_ivschat._operations.amazon_interactive_video_service_chat.list_rooms.list_rooms(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListRooms")
)
input_: capo_ivschat.types.list_rooms_request.ListRoomsRequest = {}
if name is not None:
input_["name"] = name
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
if message_review_handler_uri is not None:
input_["message_review_handler_uri"] = message_review_handler_uri
if logging_configuration_identifier is not None:
input_["logging_configuration_identifier"] = (
logging_configuration_identifier
)
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|