Skip to content

update_room_membership

update_room_membership(
    account_id: NonEmptyString,
    room_id: NonEmptyString,
    member_id: NonEmptyString,
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    role: Optional[RoomMembershipRole] = None,
) -> UpdateRoomMembershipResponse

Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.

Parameters:

Raises:

Source code in docs_src/capo_chime/_services/chime.py
def update_room_membership(
    self,
    account_id: "capo_chime.types.non_empty_string.NonEmptyString",
    room_id: "capo_chime.types.non_empty_string.NonEmptyString",
    member_id: "capo_chime.types.non_empty_string.NonEmptyString",
    *,
    config_overrides: Optional[ChimeClientConfig] = None,
    role: Optional[
        "capo_chime.types.room_membership_role.RoomMembershipRole"
    ] = None,
) -> (
    "capo_chime.types.update_room_membership_response.UpdateRoomMembershipResponse"
):
    """<p>Updates room membership details, such as the member role, for a room in an Amazon Chime Enterprise account. The member role designates whether the member is a chat room administrator or a general chat room member. The member role can be updated only for user IDs.</p>

    Args:
        account_id: <p>The Amazon Chime account ID.</p>
        room_id: <p>The room ID.</p>
        member_id: <p>The member ID.</p>
        role: <p>The role of the member.</p>

    Raises:
        capo_chime.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
        capo_chime.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
        capo_chime.errors.not_found_exception.NotFoundException: <p>One or more of the resources in the request does not exist in the system.</p>
        capo_chime.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
        capo_chime.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_chime.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
        capo_chime.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
        capo_chime.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_chime.types.update_room_membership_request.UpdateRoomMembershipRequest]",
    ) -> OperationResponse[
        "capo_chime.types.update_room_membership_response.UpdateRoomMembershipResponse"
    ]:
        import capo_chime._operations.uc_buzz_console_service.update_room_membership

        output, http_response = (
            capo_chime._operations.uc_buzz_console_service.update_room_membership.update_room_membership(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_chime.types.update_room_membership_response.UpdateRoomMembershipResponse",
    ) -> dict[str, Any]:
        import capo_chime.types.update_room_membership_response

        return capo_chime.types.update_room_membership_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateRoomMembership", redact_output=_redact_output),
    )
    input_: capo_chime.types.update_room_membership_request.UpdateRoomMembershipRequest = {
        "account_id": account_id,
        "room_id": room_id,
        "member_id": member_id,
    }
    if role is not None:
        input_["role"] = role

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output